Spring AI 支持 Mistral AI 的文本嵌入向量模型。嵌入向量是文本的向量表示形式,通过其在高维向量空间中的位置来捕捉段落的语义含义。Mistral AI 嵌入向量 API 提供前沿、顶尖的文本嵌入向量,可用于多种自然语言处理任务。
可用模型
Mistral AI 提供两种嵌入向量模型,每种模型针对不同使用场景进行了优化:
| 模型 | 维度 | 使用场景 | 说明 |
|---|---|---|---|
| mistral-embed | 1024 | 通用文本 | 通用嵌入向量模型,适用于语义搜索、聚类和文本相似度任务,是处理自然语言内容的理想选择 |
| codestral-embed | 1536 | 代码 | 专用嵌入向量模型,针对代码相似度、代码搜索以及基于代码仓库的检索增强生成(RAG)优化,提供专为理解代码语义设计的高维嵌入向量 |
模型选择指南:
处理文档、文章或用户查询等通用文本内容时,使用 mistral-embed
处理代码、技术文档或构建代码感知的检索增强生成系统时,使用 codestral-embed
前提条件
你需要创建 MistralAI API 密钥才能访问 MistralAI 嵌入向量模型。
在 MistralAI 注册页面创建账号,并在 API 密钥页面生成令牌。
Spring AI 项目定义了配置属性 spring.ai.mistralai.api-key,你需要将其设置为从 console.mistral.ai 获取的 API 密钥值。
你可以在 application.properties 文件中设置该配置属性:
spring.ai.mistralai.api-key=
为了在处理 API 密钥等敏感信息时提升安全性,你可以使用 Spring 表达式语言(SpEL)引用环境变量:
# application.yml 文件中
spring:
ai:
mistralai:
api-key: ${MISTRALAI_API_KEY}
# 环境变量或 .env 文件中
export MISTRALAI_API_KEY=你也可以在应用代码中以编程方式设置该配置:
// 从安全源或环境变量获取 API 密钥
String apiKey = System.getenv("MISTRALAI_API_KEY");添加仓库和物料清单
Spring AI 构件已发布至 Maven 中央仓库和 Spring 快照仓库。参考「构件仓库」章节,将这些仓库添加到你的构建系统中。
为简化依赖管理,Spring AI 提供了物料清单(BOM),确保整个项目使用一致版本的 Spring AI。参考「依赖管理」章节,将 Spring AI 物料清单添加到你的构建系统中。
自动配置
Spring AI 自动配置、启动器模块的构件名称发生了重大变更。更多信息请参考升级说明。
Spring AI 为 MistralAI 嵌入向量模型提供了 Spring Boot 自动配置。启用该功能需在项目的 Maven pom.xml 文件中添加以下依赖:
org.springframework.aispring-ai-starter-model-mistral-ai
或添加到 Gradle build.gradle 构建文件中:
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-mistral-ai'
}参考「依赖管理」章节,将 Spring AI 物料清单添加到你的构建文件中。
嵌入向量配置属性
重试属性
配置前缀 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 | 连接地址 | 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(已移除,不再生效) | 启用 OpenAI 嵌入向量模型 | true |
| spring.ai.model.embedding | 启用 OpenAI 嵌入向量模型 | mistral |
| spring.ai.mistralai.embedding.base-url | 可选配置,覆盖 spring.ai.mistralai.base-url,提供嵌入向量专用地址 | - |
| spring.ai.mistralai.embedding.api-key | 可选配置,覆盖 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 | 嵌入向量的返回格式,可选 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 构造函数设置所有嵌入向量请求的默认选项。运行时,你可以通过在 EmbeddingRequest 中使用 MistralAiEmbeddingOptions 实例来覆盖默认选项。
例如,为特定请求覆盖默认模型名称:
// 使用 mistral-embed 处理通用文本
EmbeddingResponse textEmbeddingResponse = embeddingModel.call(
new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
MistralAiEmbeddingOptions.builder()
.withModel("mistral-embed")
.build()));
// 使用 codestral-embed 处理代码
EmbeddingResponse codeEmbeddingResponse = embeddingModel.call(
new EmbeddingRequest(List.of("public class HelloWorld {}", "def hello_world():"),
MistralAiEmbeddingOptions.builder()
.withModel("codestral-embed")
.build()));示例控制器
配置完成后会自动创建 EmbeddingModel 实例,可直接注入到类中使用。以下是一个简单的 @Controller 示例,使用 EmbeddingModel 实现生成嵌入向量:
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 嵌入向量模型。为此,需在项目的 Maven pom.xml 文件中添加 spring-ai-mistral-ai 依赖:
org.springframework.aispring-ai-mistral-ai
或添加到 Gradle build.gradle 构建文件中:
dependencies {
implementation 'org.springframework.ai:spring-ai-mistral-ai'
}参考「依赖管理」章节,将 Spring AI 物料清单添加到你的构建文件中。
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() 方法,方便快速创建选项。