ZhiPuAI 嵌入

Spring AI 支援 ZhiPuAI 的文字嵌入模型。ZhiPuAI 的文字嵌入用於衡量文字字串的相關性。嵌入是一個浮點數的向量（列表）。兩個向量之間的距離衡量它們的相關性。小距離表示高度相關，大距離表示低度相關。

先決條件

您需要使用 ZhiPuAI 建立 API，才能存取 ZhiPu AI 語言模型。

在 ZhiPu AI 註冊頁面 建立帳戶，並在 API 金鑰頁面 產生權杖。Spring AI 專案定義了一個名為 spring.ai.zhipu.api-key 的組態屬性，您應該將其設定為從 API 金鑰頁面 取得的 API 金鑰 值。匯出環境變數是設定該組態屬性的一種方式

export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>

新增儲存庫和 BOM

Spring AI 的 artifacts 發佈在 Spring Milestone 和 Snapshot 儲存庫中。請參閱 儲存庫 章節，將這些儲存庫新增到您的建置系統。

為了協助相依性管理，Spring AI 提供了 BOM（物料清單），以確保在整個專案中使用一致版本的 Spring AI。請參閱 相依性管理 章節，將 Spring AI BOM 新增到您的建置系統。

自動組態

Spring AI 為 Azure ZhiPuAI 嵌入模型提供 Spring Boot 自動組態。若要啟用它，請將以下相依性新增到您專案的 Maven pom.xml 檔案中

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-zhipuai-spring-boot-starter</artifactId>
</dependency>

或新增到您的 Gradle build.gradle 建置檔案中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai-spring-boot-starter'
}
請參閱 相依性管理 章節，將 Spring AI BOM 新增到您的建置檔案中。

嵌入屬性

重試屬性

前綴 spring.ai.retry 用作屬性前綴，讓您可以設定 ZhiPuAI 嵌入模型的重試機制。

屬性 描述 預設值

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.zhipuai 用作屬性前綴，讓您可以連線到 ZhiPuAI。

屬性 描述 預設值

spring.ai.zhipuai.base-url

要連線的 URL

open.bigmodel.cn/api/paas

spring.ai.zhipuai.api-key

API 金鑰

-

組態屬性

前綴 spring.ai.zhipuai.embedding 是組態 EmbeddingModel 實作的屬性前綴，用於 ZhiPuAI。

屬性 描述 預設值

spring.ai.zhipuai.embedding.enabled

啟用 ZhiPuAI 嵌入模型。

true

spring.ai.zhipuai.embedding.base-url

可選覆寫 spring.ai.zhipuai.base-url 以提供嵌入特定 URL

-

spring.ai.zhipuai.embedding.api-key

可選覆寫 spring.ai.zhipuai.api-key 以提供嵌入特定 API 金鑰

-

spring.ai.zhipuai.embedding.options.model

要使用的模型

embedding-2
您可以針對 ChatModel 和 EmbeddingModel 實作覆寫通用的 spring.ai.zhipuai.base-url 和 spring.ai.zhipuai.api-key。如果設定了 spring.ai.zhipuai.embedding.base-url 和 spring.ai.zhipuai.embedding.api-key 屬性，則優先於通用屬性。同樣地，如果設定了 spring.ai.zhipuai.chat.base-url 和 spring.ai.zhipuai.chat.api-key 屬性，則優先於通用屬性。如果您想要針對不同的模型和不同的模型端點使用不同的 ZhiPuAI 帳戶，這會很有用。
所有以 spring.ai.zhipuai.embedding.options 為前綴的屬性都可以在執行時透過將請求特定的 執行時選項 新增到 EmbeddingRequest 呼叫中來覆寫。

執行時選項

ZhiPuAiEmbeddingOptions.java 提供了 ZhiPuAI 組態，例如要使用的模型等等。

預設選項可以使用 spring.ai.zhipuai.embedding.options 屬性進行組態。

在啟動時，使用 ZhiPuAiEmbeddingModel 建構子設定用於所有嵌入請求的預設選項。在執行時，您可以覆寫預設選項，方法是使用 ZhiPuAiEmbeddingOptions 實例作為 EmbeddingRequest 的一部分。

例如，若要覆寫特定請求的預設模型名稱

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

範例控制器

這將建立一個 EmbeddingModel 實作，您可以將其注入到您的類別中。以下是一個簡單的 @Controller 類別範例，它使用了 EmbeddingModel 實作。

spring.ai.zhipuai.api-key=YOUR_API_KEY
spring.ai.zhipuai.embedding.options.model=embedding-2
@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) {
        EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手動組態

如果您未使用 Spring Boot，您可以手動組態 ZhiPuAI 嵌入模型。為此，請將 spring-ai-zhipuai 相依性新增到您專案的 Maven pom.xml 檔案中

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

或新增到您的 Gradle build.gradle 建置檔案中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai'
}
請參閱 相依性管理 章節，將 Spring AI BOM 新增到您的建置檔案中。
spring-ai-zhipuai 相依性也提供對 ZhiPuAiChatModel 的存取權。如需有關 ZhiPuAiChatModel 的更多資訊，請參閱 ZhiPuAI 聊天用戶端 章節。

接下來，建立一個 ZhiPuAiEmbeddingModel 實例，並使用它來計算兩個輸入文字之間的相似度

var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));

var embeddingModel = new ZhiPuAiEmbeddingModel(this.zhiPuAiApi)
    .withDefaultOptions(ZhiPuAiChatOptions.build()
        .withModel("embedding-2")
        .build());

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

ZhiPuAiEmbeddingOptions 提供嵌入請求的組態資訊。選項類別提供 builder() 以方便建立選項。