Mistral AI 嵌入

Spring AI 支援 Mistral AI 的文字嵌入模型。嵌入是文字的向量表示，它們透過文字在高維向量空間中的位置來捕捉段落的語義。Mistral AI 嵌入 API 提供前沿、最先進的文字嵌入，可用於許多 NLP 任務。

先決條件

您需要在 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 的構件釋出在 Maven Central 和 Spring Snapshot 倉庫中。請參閱倉庫部分，瞭解如何將這些倉庫新增到您的構建系統。

為了幫助管理依賴，Spring AI 提供了一個 BOM（物料清單），以確保在整個專案中使用的 Spring AI 版本一致。請參閱依賴管理部分，瞭解如何將 Spring AI BOM 新增到您的構建系統。

自動配置

Spring AI 自動配置、starter 模組的構件名稱發生了重大變化。請參閱升級注意事項瞭解更多資訊。

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 嵌入模型的重試機制。

屬性 描述 預設值

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，則丟擲 NonTransientAiException，並且不對 4xx 客戶端錯誤程式碼進行重試。

false

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

不應觸發重試的 HTTP 狀態碼列表（例如，丟擲 NonTransientAiException）。

空

spring.ai.retry.on-http-codes

應觸發重試的 HTTP 狀態碼列表（例如，丟擲 TransientAiException）。

空

連線屬性

字首 spring.ai.mistralai 用作屬性字首，允許您連線到 MistralAI。

屬性 描述 預設值

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 (已移除且不再有效)

啟用 MistralAI 嵌入模型。

true

spring.ai.model.embedding

啟用 MistralAI 嵌入模型。

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 金鑰

-

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 實現覆蓋通用的 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 建構函式設定所有嵌入請求使用的預設選項。在執行時，您可以使用 MistralAiEmbeddingOptions 例項作為 EmbeddingRequest 的一部分來覆蓋預設選項。

例如，為特定請求覆蓋預設模型名稱

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

示例 Controller

這將建立一個 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，可以手動配置 Mistral 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'
}
請參閱依賴管理部分，瞭解如何將 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() 方法，方便建立選項。