Spring AI支持Mistral AI的文本嵌入模型。嵌入是文本的向量表示,通过文本在高维向量空间中的位置来捕捉段落的语义含义。Mistral AI Embeddings API提供尖端、最先进的文本嵌入技术,可用于多种自然语言处理(NLP)任务。
可用模型
Mistral AI提供了两种嵌入模型,每种模型都针对不同的用例进行了优化:
| 模型 | 尺寸 | 用例 | 描述 |
|---|
mistral-embed
| 1024 | 通用文本 | 适用于语义搜索、聚类和文本相似性任务的通用嵌入模型。非常适合自然语言内容。 |
codestral-embed
| 1536 | 代码 | 专门的嵌入模型,针对代码相似性、代码搜索和检索增强生成(RAG)与代码存储库进行了优化。提供专门为理解代码语义而设计的高维嵌入。 |
前提条件
您需要使用Mistral AI创建一个API,以便访问MistralAI嵌入模型。
在MistralAI注册页面创建一个账户,并在API密钥页面生成令牌。
SpringAI项目定义了一个名为spring.ai.mistralai.api-key的配置属性,您应将其设置为从console.mistral.ai获取的API密钥的值。
您可以在application.properties文件中设置此配置属性:
spring.ai.mistralai.api-key=<your-mistralai-api-key>
为了在处理API密钥等敏感信息时增强安全性,您可以使用Spring表达式语言(SpEL)来引用环境变量:
# In application.ymlspring: ai: mistralai: api-key: ${MISTRALAI_API_KEY}
# In your environment or .env fileexport MISTRALAI_API_KEY=<your-mistralai-api-key>
您还可以在应用程序代码中以编程方式设置此配置:
// Retrieve API key from a secure source or environment variableString apiKey = System.getenv("MISTRALAI_API_KEY");
添加仓库和物料清单
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参阅“工件仓库”部分,以将这些仓库添加到您的构建系统中。
为了辅助依赖管理,Spring AI 提供了一个物料清单(BOM),以确保整个项目中使用的是一致版本的 Spring AI。请参阅“依赖管理”部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
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.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”用作属性前缀,用于连接Mistral AI。
| 属性 | 描述 | 默认值 |
|---|
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(已删除,不再有效) | 启用OpenAI嵌入模型。 | true |
spring.ai.model.embedding | 启用OpenAI嵌入模型。 | mistral |
spring.ai.mistralai.embedding.base-url | 可选,重写spring. ai. mistralai. base-url以提供嵌入特定url spring-doc.cn | - |
spring.ai.mistralai.embedding.api-key | 可选,重写spring.ai.mistralai.api-key以提供嵌入特定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实现覆盖commonspring.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属性,则这些设置也将优先于通用属性。如果您想为不同的模型和不同的模型端点使用不同的Mistral AI账户,这将非常有用。
所有以“spring.ai.mistralai.embedding.options”为前缀的属性,都可以在运行时通过向EmbeddingRequest调用添加特定于请求的运行时选项来覆盖。
运行时选项
MistralAiEmbeddingOptions.java提供了MistralAI的配置,如要使用的模型等。
默认选项也可以通过spring.ai.mistralai.embedding.options属性进行配置。
在启动时,使用MistralAiEmbeddingModel构造函数来设置所有嵌入请求所使用的默认选项。在运行时,您可以使用MistralAiEmbeddingOptions实例作为EmbeddingRequest的一部分来覆盖默认选项。
// Using mistral-embed for general textEmbeddingResponse 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 codeEmbeddingResponse 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_KEYspring.ai.mistralai.embedding.options.model=mistral-embed
@RestControllerpublic 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,可以手动配置Open 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'}
接下来,创建一个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() 方法,以便轻松创建选项。