OpenAI 嵌入

Spring AI 支援 OpenAI 的文字嵌入模型。OpenAI 的文字嵌入衡量文字字串的相關性。嵌入是一個浮點數向量(列表)。兩個向量之間的距離衡量它們的關聯性。小距離表示高度相關,大距離表示低相關。

前提條件

您需要在 OpenAI 建立一個 API 以訪問 OpenAI 嵌入模型。

OpenAI 註冊頁面 建立一個賬戶,並在 API 金鑰頁面 上生成令牌。Spring AI 專案定義了一個名為 spring.ai.openai.api-key 的配置屬性,您應該將其設定為從 openai.com 獲取的 API Key 的值。匯出環境變數是設定該配置屬性的一種方法

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

新增倉庫和 BOM

Spring AI 工件釋出在 Maven Central 和 Spring Snapshot 倉庫中。請參閱 倉庫 部分,將這些倉庫新增到您的構建系統中。

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

自動配置

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

Spring AI 為 OpenAI 嵌入模型提供了 Spring Boot 自動配置。要啟用它,請將以下依賴項新增到您的專案 Maven pom.xml 檔案中

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
請參閱 依賴管理 部分,將 Spring AI BOM 新增到您的構建檔案中。

嵌入屬性

重試屬性

字首 spring.ai.retry 用作屬性字首,允許您配置 OpenAI 嵌入模型的重試機制。

屬性 描述 預設值

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.openai 用作屬性字首,允許您連線到 OpenAI。

屬性 描述 預設值

spring.ai.openai.base-url

要連線的 URL

https://api.openai.com

spring.ai.openai.api-key

API 金鑰

-

spring.ai.openai.organization-id

您可以選擇指定用於 API 請求的組織。

-

spring.ai.openai.project-id

您可以選擇指定用於 API 請求的專案。

-

對於屬於多個組織(或透過其遺留使用者 API 金鑰訪問專案)的使用者,您可以選擇指定用於 API 請求的組織和專案。這些 API 請求的用量將計入指定組織和專案的用量。

配置屬性

嵌入自動配置的啟用和停用現在透過帶有字首 spring.ai.model.embedding 的頂級屬性進行配置。

要啟用,設定 spring.ai.model.embedding=openai(預設啟用)

要停用,設定 spring.ai.model.embedding=none(或任何不匹配 openai 的值)

進行此更改是為了允許配置多個模型。

字首 spring.ai.openai.embedding 是屬性字首,用於配置 OpenAI 的 EmbeddingModel 實現。

屬性 描述 預設值

spring.ai.openai.embedding.enabled (Required and no longer valid)

啟用 OpenAI 嵌入模型。

true

spring.ai.model.embedding

啟用 OpenAI 嵌入模型。

openai

spring.ai.openai.embedding.base-url

可選,覆蓋 spring.ai.openai.base-url 以提供嵌入特定的 URL

-

spring.ai.openai.chat.embeddings-path

要附加到 base-url 的路徑

/v1/embeddings

spring.ai.openai.embedding.api-key

可選,覆蓋 spring.ai.openai.api-key 以提供嵌入特定的 api-key

-

spring.ai.openai.embedding.organization-id

您可以選擇指定用於 API 請求的組織。

-

spring.ai.openai.embedding.project-id

您可以選擇指定用於 API 請求的專案。

-

spring.ai.openai.embedding.metadata-mode

文件內容提取模式。

EMBED

spring.ai.openai.embedding.options.model

要使用的模型

text-embedding-ada-002(其他選項:text-embedding-3-large, text-embedding-3-small)

spring.ai.openai.embedding.options.encodingFormat

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

-

spring.ai.openai.embedding.options.user

表示您的終端使用者的唯一識別符號,這可以幫助 OpenAI 監控和檢測濫用行為。

-

spring.ai.openai.embedding.options.dimensions

生成的輸出嵌入應具有的維數。僅在 text-embedding-3 及更高版本模型中支援。

-

您可以為 ChatModelEmbeddingModel 實現覆蓋通用的 spring.ai.openai.base-urlspring.ai.openai.api-key。如果設定了 spring.ai.openai.embedding.base-urlspring.ai.openai.embedding.api-key 屬性,它們將優先於通用屬性。同樣,如果設定了 spring.ai.openai.chat.base-urlspring.ai.openai.chat.api-key 屬性,它們將優先於通用屬性。如果您想為不同的模型和不同的模型端點使用不同的 OpenAI 賬戶,這將非常有用。
所有帶有字首 spring.ai.openai.embedding.options 的屬性都可以在執行時透過向 EmbeddingRequest 呼叫新增請求特定的 執行時選項 來覆蓋。

執行時選項

OpenAiEmbeddingOptions.java 提供了 OpenAI 配置,例如要使用的模型等。

預設選項也可以使用 spring.ai.openai.embedding.options 屬性進行配置。

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

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

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

示例 Controller

這將建立一個 EmbeddingModel 實現,您可以將其注入到您的類中。這是一個使用 EmbeddingModel 實現的簡單 @Controller 類的示例。

spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.embedding.options.model=text-embedding-ada-002
@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,可以手動配置 OpenAI 嵌入模型。為此,請將 spring-ai-openai 依賴項新增到您的專案 Maven pom.xml 檔案中

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
請參閱 依賴管理 部分,將 Spring AI BOM 新增到您的構建檔案中。
spring-ai-openai 依賴項還提供對 OpenAiChatModel 的訪問。有關 OpenAiChatModel 的更多資訊,請參閱 OpenAI 聊天客戶端 部分。

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

var openAiApi = OpenAiApi.builder()
                .apiKey(System.getenv("OPENAI_API_KEY"))
                .build();

var embeddingModel = new OpenAiEmbeddingModel(
		this.openAiApi,
        MetadataMode.EMBED,
        OpenAiEmbeddingOptions.builder()
                .model("text-embedding-ada-002")
                .user("user-6")
                .build(),
        RetryUtils.DEFAULT_RETRY_TEMPLATE);

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

OpenAiEmbeddingOptions 提供了嵌入請求的配置資訊。api 和選項類提供了一個 builder() 以方便建立選項。