此版本仍在开发中,尚未被视为稳定版。如需最新的快照版本,请使用 Spring AI 1.1.3spring-doc.cadn.net.cn

Mistral AI 嵌入

Spring AI 支持 Mistral AI 的文本嵌入模型。 嵌入是文本的向量表示,通过其在高维向量空间中的位置来捕捉段落的语义含义。Mistral AI 嵌入 API 提供前沿、最先进的文本嵌入,可用于许多自然语言处理(NLP)任务。spring-doc.cadn.net.cn

可用模型

Mistral AI 提供两种嵌入模型,每种都针对不同的使用场景进行了优化:spring-doc.cadn.net.cn

模型 维度 用例 <description> </description>

mistral-embedspring-doc.cadn.net.cn

1024spring-doc.cadn.net.cn

通用文本spring-doc.cadn.net.cn

适用于语义搜索、聚类和文本相似性任务的通用嵌入模型。非常适合自然语言内容。spring-doc.cadn.net.cn

codestral-embedspring-doc.cadn.net.cn

1536spring-doc.cadn.net.cn

代码spring-doc.cadn.net.cn

专为代码相似度、代码搜索以及结合代码仓库的检索增强生成(RAG)优化的嵌入式模型。提供更高维度的嵌入表示,专门用于理解代码语义。spring-doc.cadn.net.cn

选择模型时:spring-doc.cadn.net.cn

  • 对于文档、文章或用户查询等通用文本内容,请使用 mistral-embedspring-doc.cadn.net.cn

  • 在使用代码、技术文档或构建感知代码的 RAG 系统时,请使用 codestral-embedspring-doc.cadn.net.cn

前置条件

您需要创建一个 MistralAI API 以访问 MistralAI 嵌入模型。spring-doc.cadn.net.cn

Mistral AI 注册页面创建账号,并在API密钥页面生成Tokens。spring-doc.cadn.net.cn

The Spring AI项目定义了一个配置属性名为spring.ai.mistralai.api-key,你应该将其设置为从console.mistral.ai获得的API Key的值。spring-doc.cadn.net.cn

您可以在您的application.properties文件中设置此配置属性:spring-doc.cadn.net.cn

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

在处理API密钥等敏感信息时,为了增强安全性,您可以使用Spring表达式语言(SpEL)引用环境变量:spring-doc.cadn.net.cn

# 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>

您也可以在应用程序代码中通过编程方式设置此配置:spring-doc.cadn.net.cn

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

添加仓库和BOM

Spring AI 构件发布在 Maven 中央仓库和 Spring Snapshot 仓库中。 请参阅 构件仓库 部分,将这些仓库添加到您的构建系统中。spring-doc.cadn.net.cn

为了帮助进行依赖管理,Spring AI 提供了一个 BOM(物料清单),以确保整个项目中使用的是相同的 Spring AI 版本。请参阅 依赖管理 部分,将 Spring AI BOM 添加到您的构建系统中。spring-doc.cadn.net.cn

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 MistralAI 嵌入模型提供 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到项目的 Maven pom.xml 文件中:spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-mistral-ai</artifactId>
</dependency>

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-mistral-ai'
}
请参阅依赖管理部分,将Spring AI BOM添加到您的构建文件中。

嵌入属性

重试属性

前缀 spring.ai.retry 用作属性前缀,让您能够配置 Mistral AI Embedding 模型的重试机制。spring-doc.cadn.net.cn

<property> </property> <description> </description> 默认

spring.ai.retry.max-attemptsspring-doc.cadn.net.cn

最大重试尝试次数。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数退避策略的初始睡眠时长。spring-doc.cadn.net.cn

2 秒。spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

重试间隔倍数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max-intervalspring-doc.cadn.net.cn

最大退避持续时间。spring-doc.cadn.net.cn

3 min.spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为假,则抛出一个NonTransientAiException,并且不尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应当触发重试的HTTP状态码列表(例如,抛出NonTransientAiException)。spring-doc.cadn.net.cn

<p>空内容</p>spring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表(例如,抛出TransientAiException)。spring-doc.cadn.net.cn

<p>空内容</p>spring-doc.cadn.net.cn

连接属性

前缀 spring.ai.mistralai 用作属性前缀,让您能够连接到 MistralAI。spring-doc.cadn.net.cn

<property> </property> <description> </description> 默认

spring.ai.mistralai.base-urlspring-doc.cadn.net.cn

连接的URLspring-doc.cadn.net.cn

api.mistral.aispring-doc.cadn.net.cn

spring.ai.mistralai.api-keyspring-doc.cadn.net.cn

API密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

嵌入自动配置的启用和禁用现在通过前缀为 spring.ai.model.embedding 的顶层属性进行配置。spring-doc.cadn.net.cn

要启用,请设置 spring.ai.model.embedding=mistral(默认已启用)spring-doc.cadn.net.cn

要禁用,请设置 spring.ai.model.embedding=none(或任何不与 mistral 匹配的值)spring-doc.cadn.net.cn

此更改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.mistralai.embedding 是用于配置 MistralAI 的 EmbeddingModel 实现的属性前缀。spring-doc.cadn.net.cn

<property> </property> <description> </description> 默认

spring.ai.mistralai.embedding.enabled(已移除且不再生效)spring-doc.cadn.net.cn

启用 OpenAI 嵌入模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.embeddingspring-doc.cadn.net.cn

启用 OpenAI 嵌入模型。spring-doc.cadn.net.cn

mistralspring-doc.cadn.net.cn

spring.ai.mistralai.embedding.base-urlspring-doc.cadn.net.cn

可选地覆盖 spring.ai.mistralai.base-url 以提供特定于嵌入的 URLspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.api-keyspring-doc.cadn.net.cn

可选地覆盖 spring.ai.mistralai.api-key,以提供专用于嵌入的 API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.metadata-modespring-doc.cadn.net.cn

文档内容提取模式。spring-doc.cadn.net.cn

嵌入spring-doc.cadn.net.cn

spring.ai.mistralai.embedding.options.modelspring-doc.cadn.net.cn

要使用的模型spring-doc.cadn.net.cn

mistral-embedspring-doc.cadn.net.cn

spring.ai.mistralai.embedding.options.encodingFormatspring-doc.cadn.net.cn

返回嵌入的格式。可以是 float 或 base64。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

您可以为 ChatModelEmbeddingModel 实现覆盖通用的 spring.ai.mistralai.base-urlspring.ai.mistralai.api-key。 如果设置了 spring.ai.mistralai.embedding.base-urlspring.ai.mistralai.embedding.api-key 属性,它们的优先级将高于通用属性。 同样,如果设置了 spring.ai.mistralai.chat.base-urlspring.ai.mistralai.chat.api-key 属性,它们的优先级也将高于通用属性。 如果您希望为不同的模型和不同的模型端点使用不同的 MistralAI 账户,这将非常有用。
所有以spring.ai.mistralai.embedding.options开头的属性可以在运行时通过向EmbeddingRequest调用添加请求特定的运行时选项来覆盖。

运行时选项

MistralAiEmbeddingOptions.java 提供了 MistralAI 的配置,例如要使用的模型等。spring-doc.cadn.net.cn

默认选项也可以使用 spring.ai.mistralai.embedding.options 属性进行配置。spring-doc.cadn.net.cn

在启动时,使用 MistralAiEmbeddingModel 构造函数来设置所有嵌入请求的默认选项。 在运行时,您可以使用作为 EmbeddingRequest 一部分的 MistralAiEmbeddingOptions 实例来覆盖默认选项。spring-doc.cadn.net.cn

例如,要为特定请求覆盖默认模型名称:spring-doc.cadn.net.cn

// 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-doc.cadn.net.cn

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 文件中:spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai</artifactId>
</dependency>

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai'
}
请参阅依赖管理部分,将Spring AI BOM添加到您的构建文件中。
spring-ai-mistral-ai 依赖项还提供了对 MistralAiChatModel 的访问权限。 有关 MistralAiChatModel 的更多信息,请参阅 MistralAI 聊天客户端 部分。

接下来,创建一个 MistralAiEmbeddingModel 实例,并使用它来计算两个输入文本之间的相似度:spring-doc.cadn.net.cn

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() 以便轻松创建选项。spring-doc.cadn.net.cn