Mistral AI 嵌入

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

可用模型

Mistral AI 提供兩種嵌入模型,每種都針對不同的用例進行了最佳化

模型 維度 用例 描述

mistral-embed

1024

通用文字

通用的嵌入模型,適用於語義搜尋、聚類和文字相似性任務。適用於自然語言內容。

codestral-embed

1536

程式碼

專門最佳化的嵌入模型,用於程式碼相似性、程式碼搜尋以及與程式碼倉庫進行檢索增強生成 (RAG)。提供專為理解程式碼語義而設計的高維嵌入。

選擇模型時

  • mistral-embed 用於文件、文章或使用者查詢等通用文字內容

  • 在處理程式碼、技術文件或構建程式碼感知 RAG 系統時使用 codestral-embed

先決條件

您需要使用 MistralAI 建立一個 API 才能訪問 MistralAI 嵌入模型。

MistralAI 註冊頁面 建立一個帳戶,並在 API 金鑰頁面 生成令牌。

Spring AI 專案定義了一個名為 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.yml
spring:
  ai:
    mistralai:
      api-key: ${MISTRALAI_API_KEY}
# In your environment or .env file
export MISTRALAI_API_KEY=<your-mistralai-api-key>

您還可以在應用程式程式碼中以程式設計方式設定此配置

// 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 AI 提供了一個 BOM(物料清單),以確保在整個專案中使用的 Spring AI 版本一致。請參閱 依賴項管理 部分,將 Spring AI BOM 新增到您的構建系統。

自動配置

Spring AI 自動配置、啟動模組的工件名稱發生了重大變化。請參閱 升級說明 以獲取更多資訊。

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 客戶端錯誤程式碼

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

啟用 OpenAI 嵌入模型。

true

spring.ai.model.embedding

啟用 OpenAI 嵌入模型。

mistral

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。

-

您可以為 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.ai.mistralai.embedding.options 屬性進行配置。

在啟動時,使用 MistralAiEmbeddingModel 建構函式設定所有嵌入請求的預設選項。在執行時,您可以使用 MistralAiEmbeddingOptions 例項作為 EmbeddingRequest 的一部分來覆蓋預設選項。

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

// 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.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 檔案中

<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() 以方便選項建立。

© . This site is unofficial and not affiliated with VMware.