|
此版本仍在开发中,尚未被视为稳定版。如需最新的快照版本,请使用 Spring AI 1.1.3! |
Mistral AI 嵌入
Spring AI 支持 Mistral AI 的文本嵌入模型。 嵌入是文本的向量表示,通过其在高维向量空间中的位置来捕捉段落的语义含义。Mistral AI 嵌入 API 提供前沿、最先进的文本嵌入,可用于许多自然语言处理(NLP)任务。
可用模型
Mistral AI 提供两种嵌入模型,每种都针对不同的使用场景进行了优化:
| 模型 | 维度 | 用例 | <description> </description> |
|---|---|---|---|
|
1024 |
通用文本 |
适用于语义搜索、聚类和文本相似性任务的通用嵌入模型。非常适合自然语言内容。 |
|
1536 |
代码 |
专为代码相似度、代码搜索以及结合代码仓库的检索增强生成(RAG)优化的嵌入式模型。提供更高维度的嵌入表示,专门用于理解代码语义。 |
选择模型时:
-
对于文档、文章或用户查询等通用文本内容,请使用
mistral-embed -
在使用代码、技术文档或构建感知代码的 RAG 系统时,请使用
codestral-embed
前置条件
您需要创建一个 MistralAI API 以访问 MistralAI 嵌入模型。
在Mistral AI 注册页面创建账号,并在API密钥页面生成Tokens。
The 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");
Auto-configuration
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
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 Embedding 模型的重试机制。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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 min. |
spring.ai.retry.on-client-errors |
如果为假,则抛出一个NonTransientAiException,并且不尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应当触发重试的HTTP状态码列表(例如,抛出NonTransientAiException)。 |
<p>空内容</p> |
spring.ai.retry.on-http-codes |
应触发重试的HTTP状态码列表(例如,抛出TransientAiException)。 |
<p>空内容</p> |
连接属性
前缀 spring.ai.mistralai 用作属性前缀,让您能够连接到 MistralAI。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
spring.ai.mistralai.base-url |
连接的URL |
|
spring.ai.mistralai.api-key |
API密钥 |
- |
配置属性
|
嵌入自动配置的启用和禁用现在通过前缀为 要启用,请设置 spring.ai.model.embedding=mistral(默认已启用) 要禁用,请设置 spring.ai.model.embedding=none(或任何不与 mistral 匹配的值) 此更改是为了允许配置多个模型。 |
前缀 spring.ai.mistralai.embedding 是用于配置 MistralAI 的 EmbeddingModel 实现的属性前缀。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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 密钥 |
- |
spring.ai.mistralai.embedding.metadata-mode |
文档内容提取模式。 |
嵌入 |
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 实例来覆盖默认选项。
例如,要为特定请求覆盖默认模型名称:
// 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.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(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() 以便轻松创建选项。