Mistral AI 嵌入

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

可用模型

Mistral AI 提供两个嵌入模型，各自针对不同用例做了优化：

模型	维度	用例	描述
mistral-embed	1024	通用文本	通用的嵌入模型，适用于语义搜索、聚类和文本相似度任务。适合自然语言内容。
codestral-embed	1536	代码	专为代码相似度、代码搜索以及结合代码仓库的检索增强生成（RAG）优化的嵌入模型。提供专门为理解代码语义而设计的更高维嵌入。

选择模型时：

• 对文档、文章或用户查询等通用文本内容，使用 mistral-embed
• 在处理代码、技术文档或构建代码感知的 RAG 系统时，使用 codestral-embed

前置条件

你需要在 MistralAI 创建一个 API 才能使用 MistralAI 的嵌入模型。

在 MistralAI 注册页 创建账户，并在 API Keys 页 生成令牌。

Spring AI 项目定义了一个名为 spring.ai.mistralai.api-key 的配置属性，你应把它设为从 console.mistral.ai 获取的 API Key 的值。

你可以在 application.properties 文件中设置此配置属性：

spring.ai.mistralai.api-key=<your-mistralai-api-key>

为在处理诸如 API 密钥这类敏感信息时获得更强的安全性，你可以使用 Spring 表达式语言（SpEL）引用一个环境变量：

# In application.yml
spring:
  ai:
    mistralai:
      api-key: ${MISTRALAI_API_KEY}

# In your environment or .env file
export MISTRALAI_API_KEY=<your-mistralai-api-key>

你也可以在应用代码中以编程方式设置此配置属性：

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("MISTRALAI_API_KEY");

添加仓库与 BOM

Spring AI 的制品发布在 Maven Central 和 Spring Snapshot 仓库中。 参见 制品仓库 一节，把这些仓库添加到你的构建系统。

为便于依赖管理，Spring AI 提供了一个 BOM（物料清单），以确保整个项目中使用一致版本的 Spring AI。参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建系统。

自动配置

NOTE

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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

嵌入属性

重试属性

前缀 spring.ai.retry 用作配置 Mistral AI 嵌入模型重试机制的属性前缀。

属性	描述	默认值
spring.ai.retry.max-attempts	最大重试尝试次数。	10
spring.ai.retry.backoff.initial-interval	指数退避策略的初始等待时长。	2 sec.
spring.ai.retry.backoff.multiplier	退避间隔乘数。	5
spring.ai.retry.backoff.max-interval	最大退避时长。	3 min.
spring.ai.retry.on-client-errors	若为 false，则抛出 NonTransientAiException，不对 4xx 客户端错误码尝试重试	false
spring.ai.retry.exclude-on-http-codes	不应触发重试的 HTTP 状态码列表（例如抛出 NonTransientAiException）。	empty
spring.ai.retry.on-http-codes	应触发重试的 HTTP 状态码列表（例如抛出 TransientAiException）。	empty

连接属性

前缀 spring.ai.mistralai 用作连接 MistralAI 的属性前缀。

属性	描述	默认值
spring.ai.mistralai.base-url	要连接到的 URL	https://api.mistral.ai
spring.ai.mistralai.api-key	API 密钥	-

配置属性

NOTE

嵌入自动配置的启用与禁用，现已通过以 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（已移除，不再生效）	启用 OpenAI 嵌入模型。	true
spring.ai.model.embedding	启用 OpenAI 嵌入模型。	mistral
spring.ai.mistralai.embedding.base-url	可选，覆盖 spring.ai.mistralai.base-url 以提供嵌入专用的 url	-
spring.ai.mistralai.embedding.api-key	可选，覆盖 spring.ai.mistralai.api-key 以提供嵌入专用的 api-key	-
spring.ai.mistralai.embedding.metadata-mode	文档内容提取模式。	EMBED
spring.ai.mistralai.embedding.model	要使用的模型	mistral-embed
spring.ai.mistralai.embedding.encoding-format	返回嵌入所用的格式。可为 float 或 base64。	-

NOTE

你可以为 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 账户时，这很有用。

TIP

所有以 spring.ai.mistralai.embedding 为前缀的属性，都可通过在 EmbeddingRequest 调用中添加一个请求专用的 embedding-options 在运行时被覆盖。

运行时选项

MistralAiEmbeddingOptions.java 提供 MistralAI 的各项配置，例如要使用的模型等。

默认选项也可通过 spring.ai.mistralai.embedding 属性来配置。

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

例如，为某个特定请求覆盖默认模型名：

// Using mistral-embed for general text
EmbeddingResponse textEmbeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        MistralAiEmbeddingOptions.builder()
            .withModel("mistral-embed")
        .build()));

// Using codestral-embed for code
EmbeddingResponse codeEmbeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("public class HelloWorld {}", "def hello_world():"),
        MistralAiEmbeddingOptions.builder()
            .withModel("codestral-embed")
        .build()));

示例控制器

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

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.embedding.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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

NOTE

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 为嵌入请求提供配置信息。 options 类提供了一个 builder() 以便轻松创建选项。