Mistral AI 嵌入
Spring AI 支持 Mistral AI 的文本嵌入模型。嵌入是对文本的向量化表示,通过在高维向量空间中的位置来捕捉段落的语义含义。Mistral AI Embeddings 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 Expression Language (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");
添加 Repositories 和 BOM
Spring AI 制品已发布在 Maven Central 和 Spring Snapshot 仓库中。请参考制品仓库部分,将这些仓库添加到你的构建系统中。
为了协助依赖管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致版本的 Spring AI。请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 的自动配置及 starter 模块的 artifact 名称发生了重大变更。更多信息请参阅升级说明。
Spring AI 为 MistralAI Embedding Model 提供了 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 Embedding 模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| 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)。 | 空 |
| spring.ai.retry.on-http-codes | 应触发重试的 HTTP 状态码列表(例如,用于抛出 TransientAiException)。 | 空 |
连接属性
前缀 spring.ai.mistralai 用作属性前缀,用于连接 MistralAI。
| Property | Description | Default |
|---|---|---|
| spring.ai.mistralai.base-url | 连接的目标 URL | api.mistral.ai |
| spring.ai.mistralai.api-key | API Key | - |
配置属性
嵌入自动配置的启用和禁用现在通过前缀为 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。 | - |
你可以覆盖 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 为前缀的属性,都可以在运行时通过向 EmbeddingRequest 调用添加请求特定的 Runtime Options 来覆盖。
运行时选项
MistralAiEmbeddingOptions.java 提供了 MistralAI 配置项,例如要使用的模型等。
使用 spring.ai.mistralai.embedding 属性也可以配置默认选项。
在启动时,使用 MistralAiEmbeddingModel 构造函数来设置所有嵌入请求使用的默认选项。在运行时,你可以使用 MistralAiEmbeddingOptions 实例作为 EmbeddingRequest 的一部分来覆盖默认选项。
例如,要为特定请求覆盖默认的模型名称:
// 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 Embedding Model。为此,请将 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 添加到您的构建文件中。
sprint-ai-mistral-ai 依赖还提供了对 MistralAiChatModel 的访问。有关 MistralAiChatModel 的更多信息,请参阅 MistralAI Chat Client 章节。
接下来,创建一个 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(),以便于创建选项。