Mistral AI文本嵌入

Spring AI支持Mistral AI的文本嵌入模型。嵌入是文本的矢量表示，通过它们在高维向量空间中的位置捕获段落的语义含义。Mistral AI嵌入API提供了先进的、最新颖的文本嵌入，可用于许多自然语言处理任务。

先决条件

您将需要创建一个API以访问Mistral AI的嵌入模型。

在MistralAI注册页面创建一个账户，并在API密钥页面上生成令牌。Spring AI项目定义了一个名为spring.ai.mistralai.api-key的配置属性，您应该将其设置为从console.mistral.ai获取的API密钥的值。导出一个环境变量是设置该配置属性的一种方法：

export SPRING_AI_MISTRALAI_API_KEY=<在此处插入密钥>

添加存储库和BOM

Spring AI的工件发布在Spring Milestone和Snapshot存储库中。请参考存储库部分，将这些存储库添加到您的构建系统中。

为了帮助处理依赖关系，Spring AI提供了一个BOM（材料清单），以确保在整个项目中使用一致的Spring AI版本。请参考依赖管理部分，将Spring AI BOM添加到您的构建系统中。

自动配置

Spring AI提供了MistralAI嵌入客户端的Spring Boot自动配置。要启用它，请将以下依赖项添加到您项目的Maven pom.xml文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai-spring-boot-starter</artifactId>
</dependency>

或者添加到您的Gradle build.gradle构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai-spring-boot-starter'
}
请参阅依赖管理部分，将Spring AI BOM添加到您的构建文件中。

嵌入属性

重试属性

前缀 spring.ai.retry 用作属性前缀，可让您配置 Mistral AI 嵌入客户端的重试机制。

属性 描述 默认

spring.ai.retry.max-attempts

最大重试次数。

10

spring.ai.retry.backoff.initial-interval

指数退避策略的初始休眠持续时间。

2 秒

spring.ai.retry.backoff.multiplier

退避间隔乘数。

5

spring.ai.retry.backoff.max-interval

最大退避持续时间。

3 分钟

spring.ai.retry.on-client-errors

如果为 false，则抛出 NonTransientAiException，并且不对 4xx 客户端错误代码尝试重试

false

spring.ai.retry.exclude-on-http-codes

不应触发重试的 HTTP 状态代码列表（例如，抛出 NonTransientAiException）。

空

连接属性

前缀 spring.ai.mistralai 用作属性前缀，可让您连接到 MistralAI。

属性 描述 默认

spring.ai.mistralai.base-url

连接的 URL

api.mistral.ai

spring.ai.mistralai.api-key

API 密钥

-

配置属性

前缀 spring.ai.mistralai.embedding 是配置 EmbeddingClient 用于 MistralAI 的实现的属性前缀。

属性 描述 默认值

spring.ai.mistralai.embedding.enabled

启用 OpenAI 嵌入客户端。

true

spring.ai.mistralai.embedding.base-url

可选，用于提供嵌入特定 URL 的重写 spring.ai.mistralai.base-url

-

spring.ai.mistralai.embedding.api-key

可选，用于提供嵌入特定 API 密钥的重写 spring.ai.mistralai.api-key

-

spring.ai.mistralai.embedding.metadata-mode

文档内容提取模式。

EMBED

spring.ai.mistralai.embedding.options.model

要使用的模型

mistral-embed

spring.ai.mistralai.embedding.options.encodingFormat

返回嵌入的格式。可以是浮点型或 base64。

-
您可以覆盖公共的 spring.ai.mistralai.base-url 和 spring.ai.mistralai.api-key 以供 ChatClient 和 EmbeddingClient 实现使用。如果设置了 spring.ai.mistralai.embedding.base-url 和 spring.ai.mistralai.embedding.api-key 属性，则这些属性将优先于公共属性。类似地，如果设置了 spring.ai.mistralai.embedding.base-url 和 spring.ai.mistralai.embedding.api-key 属性，则这些属性将优先于公共属性。如果您希望为不同的模型和不同的模型端点使用不同的 MistralAI 账户，则这是很有用的。
所有以 spring.ai.mistralai.embedding.options 为前缀的属性都可以通过向 EmbeddingRequest 调用中添加一个请求特定的 嵌入选项 来在运行时进行覆盖。

嵌入选项

MistralAiEmbeddingOptions.java 提供了MistralAI的配置，比如要使用的模型等内容。

默认选项也可以通过 spring.ai.mistralai.embedding.options 属性进行配置。

在启动时使用 MistralAiEmbeddingClient 构造函数来设置所有嵌入请求所使用的默认选项。在运行时，您可以使用 MistralAiEmbeddingOptions 实例作为您的 EmbeddingRequest 的一部分来覆盖默认选项。

例如，要覆盖特定请求的默认模型名称：

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        MistralAiEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器（自动配置）

这将创建一个 EmbeddingClient 实现，您可以将其注入到您的类中。以下是一个简单的 @Controller 类的示例，使用 EmbeddingClient 实现。

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.embedding.options.model=mistral-embed
@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        var embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果您没有使用Spring Boot，您可以手动配置OpenAI嵌入式客户端。为此，请将spring-ai-mistralai依赖项添加到您项目的Maven pom.xml文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistralai</artifactId>
</dependency>

或者添加到您的Gradle build.gradle构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistralai'
}
请参阅依赖管理部分，将Spring AI BOM添加到您的构建文件中。
spring-ai-mistralai依赖项还提供对MistralAiChatClient的访问。有关MistralAiChatClient的更多信息，请参阅MistralAI Chat Client部分。

接下来，创建一个MistralAiEmbeddingClient实例，并使用它计算两个输入文本之间的相似性：

var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

var embeddingClient = new MistralAiEmbeddingClient(mistralAiApi,
        MistralAiEmbeddingOptions.builder()
                .withModel("mistral-embed")
                .withEncodingFormat("float")
                .build());

EmbeddingResponse embeddingResponse = embeddingClient
        .embedForResponse(List.of("Hello World", "World is big and salvation is near"));

MistralAiEmbeddingOptions提供了嵌入请求的配置信息。该选项类提供了一个builder()方法，用于轻松创建选项。