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

密斯特拉AI嵌入

Spring AI 支持 Mistral AI 的文本嵌入模型。 嵌入是文本的向量表示,通过在高维向量空间中的位置捕捉段落的语义意义。Mistral AI 嵌入 API 提供了尖端的、最先进的文本嵌入技术,可用于多种自然语言处理任务。spring-doc.cadn.net.cn

可用模型

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

模型 维度 使用案例 描述

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

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 Central 和 Spring Snapshot 仓库中。 请参阅 工件仓库 部分,以将这些仓库添加到您的构建系统。spring-doc.cadn.net.cn

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

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。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 构建脚本文件中。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

属性 描述 默认

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 分钟。spring-doc.cadn.net.cn

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

如果为false,则抛出NonTransientAiException,且不重试客户端错误代码4xxspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

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

不应触发重试的HTTP状态代码列表(例如,用于抛出非暂时性AI异常)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

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

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

emptyspring-doc.cadn.net.cn

连接属性

前缀 spring.ai.mistralai 用于作为属性前缀,以便您连接到MistralAI。spring-doc.cadn.net.cn

属性 描述 默认

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

属性 描述 默认

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

密史脱拉风spring-doc.cadn.net.cn

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

可选地,覆盖 `spring.ai.mistralai.base-url` 以提供嵌入特定的URL。spring-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-key。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

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

您可以覆盖通用的 spring.ai.mistralai.base-urlspring.ai.mistralai.api-key,以便为 ChatModelEmbeddingModel 实现自定义设置。 如果设置了 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构造函数设置所有嵌入请求使用的默认选项。在运行时,您可以使用MistralAiEmbeddingOptions实例作为EmbeddingRequest的一部分来覆盖默认选项。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依赖项添加到项目Mavenpom.xml文件中:spring-doc.cadn.net.cn

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

或者添加到您的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