Mistral AI Embeddings

Spring AI 支持 Mistral AI 的文本嵌入模型。嵌入是文本的向量表示，通过其在高维向量空间中的位置来捕获段落的语义含义。Mistral AI Embeddings API 为文本提供了最先进的嵌入，可用于许多 NLP 任务。

先决条件

你需要使用 MistralAI 创建一个 API，才能访问 MistralAI 嵌入模型。

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

export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>

添加存储库和 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.retry.on-http-codes

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

空

连接属性

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

属性 说明 默认值

spring.ai.mistralai.base-url

要连接到的 URL

api.mistral.ai

spring.ai.mistralai.api-key

API 密钥

-

配置属性

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

属性 说明 默认值

spring.ai.mistralai.embedding.enabled

启用 OpenAI 嵌入模型。

true

spring.ai.mistralai.embedding.base-url

可选，覆盖 spring.ai.mistralai.base-url 以提供特定于嵌入的 URL

-

spring.ai.mistralai.embedding.api-key

可选，覆盖 spring.ai.mistralai.api-key 以提供特定于嵌入的 API 密钥

-

spring.ai.mistralai.embedding.metadata-mode

文档内容提取模式。

EMBED

spring.ai.mistralai.embedding.options.model

要使用的模型

mistral-embed

spring.ai.mistralai.embedding.options.encodingFormat

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

-
你可以覆盖 ChatModel 和 EmbeddingModel 实现的通用 spring.ai.mistralai.base-url 和 spring.ai.mistralai.api-key。如果设置了 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 属性进行配置。

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

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

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

示例控制器

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

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

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

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

手动配置

如果你不使用 Spring Boot，则可以手动配置 OpenAI 嵌入客户端。为此，将 spring-ai-mistral-ai 依赖项添加到项目的 Maven pom.xml 文件中

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

或添加到 Gradle build.gradle 构建文件。

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

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

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

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

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

MistralAiEmbeddingOptions 提供嵌入请求的配置信息。选项类提供一个 builder()，便于创建选项。