OpenAI Embeddings
Spring AI 支援 OpenAI 的文字嵌入模型。OpenAI 的文字嵌入衡量文字字串的相關性。嵌入是浮點數向量(列表)。兩個向量之間的距離衡量它們的關聯性。小距離表示高度相關,大距離表示低相關。
先決條件
您需要透過 OpenAI 建立一個 API 才能訪問 OpenAI 嵌入模型。
在 OpenAI 註冊頁面 建立一個帳戶,並在 API 金鑰頁面 生成令牌。
Spring AI 專案定義了一個名為 spring.ai.openai.api-key 的配置屬性,您應該將其設定為從 openai.com 獲取的 API 金鑰 的值。
您可以在 application.properties 檔案中設定此配置屬性
spring.ai.openai.api-key=<your-openai-api-key>
為了在處理 API 金鑰等敏感資訊時增強安全性,您可以使用 Spring 表示式語言 (SpEL) 引用環境變數。
# In application.yml
spring:
ai:
openai:
api-key: ${OPENAI_API_KEY}
# In your environment or .env file
export OPENAI_API_KEY=<your-openai-api-key>
您還可以在應用程式程式碼中以程式設計方式設定此配置
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("OPENAI_API_KEY");
自動配置
|
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,並且不嘗試重試 |
假 |
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=openai(預設已啟用) 要停用,請設定 spring.ai.model.embedding=none(或任何與 openai 不匹配的值) 此更改是為了允許配置多個模型。 |
字首 `spring.ai.openai.embedding` 是配置 OpenAI `EmbeddingModel` 實現的屬性字首。
| 財產 | 描述 | 預設值 |
|---|---|---|
spring.ai.openai.embedding.enabled(必需且不再有效) |
啟用 OpenAI 嵌入模型。 |
true |
spring.ai.model.embedding |
啟用 OpenAI 嵌入模型。 |
openai |
spring.ai.openai.embedding.base-url |
可選,覆蓋 spring.ai.openai.base-url 以提供特定於嵌入的 URL |
- |
spring.ai.openai.embedding.embeddings-path |
要附加到基本 URL 的路徑 |
|
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` 及更高版本模型中支援。 |
- |
| 您可以為 `ChatModel` 和 `EmbeddingModel` 實現覆蓋通用的 `spring.ai.openai.base-url` 和 `spring.ai.openai.api-key`。如果設定了 `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()
.model("Different-Embedding-Model-Deployment-Name")
.build()));
示例控制器
這將建立一個 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()` 以方便選項建立。