OpenAI 嵌入

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

先決條件

您需要使用 OpenAI 建立 API 才能存取 OpenAI 嵌入模型。

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

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

新增儲存庫和 BOM

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

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

自動組態

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
請參閱 相依性管理 章節，將 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.openai.embedding 是屬性前綴，用於組態 OpenAI 的 EmbeddingModel 實作。

屬性 描述 預設值

spring.ai.openai.embedding.enabled

啟用 OpenAI 嵌入模型。

true

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

-

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 及更新的模型中支援。

-
您可以覆寫通用的 spring.ai.openai.base-url 和 spring.ai.openai.api-key，以用於 ChatModel 和 EmbeddingModel 實作。spring.ai.openai.embedding.base-url 和 spring.ai.openai.embedding.api-key 屬性 (如果設定) 優先於通用屬性。同樣地，spring.ai.openai.chat.base-url 和 spring.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()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

範例控制器

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

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 = new OpenAiApi(System.getenv("OPENAI_API_KEY"));

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

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

OpenAiEmbeddingOptions 提供嵌入請求的組態資訊。選項類別提供 builder() 以輕鬆建立選項。