Mistral AI 嵌入

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

先决条件

您需要在 MistralAI 创建一个 API 以访问 MistralAI 嵌入模型。

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

export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>

添加仓库和 BOM

Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。请参阅仓库部分，了解如何将这些仓库添加到您的构建系统。

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

自动配置

Spring AI 自动配置、starter 模块的构件名称发生了重大变化。请参阅升级注意事项了解更多信息。

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-mistral-ai'
}
请参阅依赖管理部分，了解如何将 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.model.embedding 的顶级属性进行配置。

要启用，请设置 spring.ai.model.embedding=mistral（默认已启用）

要禁用，请设置 spring.ai.model.embedding=none（或任何不匹配 mistral 的值）

进行此更改是为了支持配置多个模型。

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

属性 描述 默认值

spring.ai.mistralai.embedding.enabled (已移除且不再有效)

启用 MistralAI 嵌入模型。

true

spring.ai.model.embedding

启用 MistralAI 嵌入模型。

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

返回嵌入的格式。可以是 float 或 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.chat.base-url 和 spring.ai.mistralai.chat.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()));

示例 Controller

这将创建一个 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，可以手动配置 Mistral AI 嵌入模型。为此，请将 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(this.mistralAiApi,
        MistralAiEmbeddingOptions.builder()
                .withModel("mistral-embed")
                .withEncodingFormat("float")
                .build());

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

MistralAiEmbeddingOptions 提供了嵌入请求的配置信息。该选项类提供了 builder() 方法，方便创建选项。