Spring AI支持Mistral AI的文本嵌入模型。嵌入是文本的向量化表示，通过它们在高维向量空间中的位置捕捉段落的语义含义。Mistral AI嵌入API提供了尖端的、最先进的文本嵌入，这些嵌入可用于许多自然语言处理任务。

先决条件

您需要与MistralAI创建一个API来访问MistralAI的嵌入模型。

在 MistralAI 注册页面 创建一个帐户并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.mistralai.api-key 的配置属性，您应该将其设置为从 console.mistral.ai 获得的 API Key 的值。导出环境变量是设置该配置属性的一种方式：

export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>

添加仓库和BOM

Spring AI构件发布在Spring Milestone和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-mistral-ai-spring-boot-starter</artifactId>
</dependency>

或添加到你的Gradle build.gradle 构建文件中。

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

嵌入属性

重试属性

前缀`spring.ai.retry`被用作属性前缀，允许你为Mistral AI嵌入客户端配置重试机制。

属性 描述 默认值

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分钟。

spring.ai.retry.on-client-errors

如果为false，在`4xx`客户端错误代码下抛出NonTransientAiException，并且不尝试重试

false

spring.ai.retry.exclude-on-http-codes

应该不触发重试的HTTP状态码列表（例如抛出NonTransientAiException）。

空

连接属性

前缀 spring.ai.mistralai 被用作属性前缀，它让你能够连接到MistralAI。

属性 描述 默认值

spring.ai.mistralai.base-url

连接的URL地址

https://api.mistral.ai

spring.ai.mistralai.api-key

API密钥

-

配置属性

前缀 spring.ai.mistralai.embedding 是配置 MistralAI 的 EmbeddingClient 实现的属性前缀。

属性 描述 默认值

spring.ai.mistralai.embedding.enabled

启用OpenAI嵌入式客户端。

true

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.options.model

使用的模型

mistral-embed

spring.ai.mistralai.embedding.options.encodingFormat

返回嵌入数据的格式。可以是float或base64。

-
Note
 你可以重写`ChatClient`和`EmbeddingClient`实现中的通用`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.embedding.base-url`和`spring.ai.mistralai.embedding.api-key`属性，它们将优先于通用属性。如果你想为不同模型和不同的模型端点使用不同的MistralAI账户，这将非常有用。
Tip
 所有以`spring.ai.mistralai.embedding.options`为前缀的属性可以在运行时被覆盖，通过在`EmbeddingRequest`调用中添加特定请求的[embedding-options]来实现。

运行时选项

'''The MistralAiEmbeddingOptions.java 文件提供了MistralAI的配置，例如要使用的模型等。'''

默认选项也可以使用`spring.ai.mistralai.embedding.options`属性进行配置。

在启动时使用 MistralAiEmbeddingClient 构造函数来设置所有嵌入请求使用的默认选项。在运行时，你可以使用 MistralAiEmbeddingOptions 实例作为你的 EmbeddingRequest 的一部分来覆盖默认选项。

例如，要覆盖特定请求的默认模型名称：

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        MistralAiEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

样本控制器

这将创建一个你可以注入到你的类中的`EmbeddingClient`实现。以下是一个使用`EmbeddingClient`实现的简单`@Controller`类的示例。

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.embedding.options.model=mistral-embed
@RestController
public class EmbeddingController {

private final EmbeddingClient embeddingClient;

@Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

@GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        var embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果您没有使用Spring Boot，您可以手动配置OpenAI嵌入式客户端。为此，请将`spring-ai-mistralai`依赖项添加到您项目的Maven `pom.xml`文件中：

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

或添加到你的Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistralai'
}
Tip
 参考依赖管理部分，以将Spring AI BOM添加到您的构建文件中。
Note
 spring-ai-mistralai` 依赖同样提供了对 MistralAiChatClient 的访问。有关 MistralAiChatClient 的更多信息，请参考链接:../chat/mistralai-chat.html[MistralAI Chat Client] 部分。

接下来，创建一个`MistralAiEmbeddingClient`实例并使用它来计算两个输入文本之间的相似度：

var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

var embeddingClient = new MistralAiEmbeddingClient(mistralAiApi,
        MistralAiEmbeddingOptions.builder()
                .withModel("mistral-embed")
                .withEncodingFormat("float")
                .build());

EmbeddingResponse embeddingResponse = embeddingClient
        .embedForResponse(List.of("Hello World", "World is big and salvation is near"));

MistralAiEmbeddingOptions` 为嵌入请求提供配置信息。该选项类提供了一个`builder()`方法，用于便捷地创建选项。