OpenAI 影像生成
Spring AI 支援 OpenAI 的影像生成模型 DALL-E。
先決條件
您需要建立 OpenAI API 金鑰才能訪問 ChatGPT 模型。
在 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.openai 用作屬性字首,允許您連線到 OpenAI。
財產 |
描述 |
預設值 |
spring.ai.openai.base-url |
要連線的 URL |
|
spring.ai.openai.api-key |
API 金鑰 |
- |
spring.ai.openai.organization-id |
您可以選擇指定用於 API 請求的組織。 |
- |
spring.ai.openai.project-id |
您可以選擇指定用於 API 請求的專案。 |
- |
| 對於屬於多個組織(或透過其舊版使用者 API 金鑰訪問其專案)的使用者,您可以選擇指定用於 API 請求的組織和專案。這些 API 請求的使用量將計入指定組織和專案的使用量。 |
重試屬性
字首 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.model.image=openai(預設啟用) 要停用,請設定 spring.ai.model.image=none(或任何不匹配 openai 的值) 此更改是為了允許配置多個模型。 |
字首 spring.ai.openai.image 是屬性字首,可用於配置 OpenAI 的 ImageModel 實現。
財產 |
描述 |
預設值 |
spring.ai.openai.image.enabled(已移除且不再有效) |
啟用 OpenAI 影像模型。 |
true |
spring.ai.model.image |
啟用 OpenAI 影像模型。 |
openai |
spring.ai.openai.image.base-url |
可選地覆蓋 spring.ai.openai.base-url 以提供特定於聊天的 URL |
- |
spring.ai.openai.image.api-key |
可選覆蓋 spring.ai.openai.api-key 以提供特定於聊天的 api-key |
- |
spring.ai.openai.image.organization-id |
您可以選擇指定用於 API 請求的組織。 |
- |
spring.ai.openai.image.project-id |
您可以選擇指定用於 API 請求的專案。 |
- |
spring.ai.openai.image.options.n |
要生成的影像數量。必須介於 1 到 10 之間。對於 dall-e-3,僅支援 n=1。 |
- |
spring.ai.openai.image.options.model |
用於影像生成的模型。 |
OpenAiImageApi.DEFAULT_IMAGE_MODEL |
spring.ai.openai.image.options.quality |
將要生成的影像質量。HD 影像具有更精細的細節和更高的一致性。此引數僅支援 dall-e-3。 |
- |
spring.ai.openai.image.options.response_format |
生成的影像返回的格式。必須是 URL 或 b64_json 之一。 |
- |
|
生成的影像尺寸。對於 dall-e-2,必須是 256x256、512x512 或 1024x1024 之一。對於 dall-e-3 模型,必須是 1024x1024、1792x1024 或 1024x1792 之一。 |
- |
|
生成的影像寬度。對於 dall-e-2,必須是 256、512 或 1024 之一。 |
- |
|
生成的影像高度。對於 dall-e-2,必須是 256、512 或 1024 之一。 |
- |
|
生成的影像風格。必須是 vivid 或 natural 之一。Vivid 會使模型傾向於生成超現實和戲劇性的影像。Natural 會使模型生成更自然、更不超現實的影像。此引數僅支援 dall-e-3。 |
- |
|
代表您的終端使用者的唯一識別符號,可以幫助 OpenAI 監控和檢測濫用。 |
- |
您可以覆蓋通用的 spring.ai.openai.base-url、spring.ai.openai.api-key、spring.ai.openai.organization-id 和 spring.ai.openai.project-id 屬性。如果設定了 spring.ai.openai.image.base-url、spring.ai.openai.image.api-key、spring.ai.openai.image.organization-id 和 spring.ai.openai.image.project-id 屬性,它們將優先於通用屬性。如果您希望為不同的模型和不同的模型端點使用不同的 OpenAI 帳戶,這將非常有用。 |
所有帶有 spring.ai.openai.image.options 字首的屬性都可以在執行時被覆蓋。 |
執行時選項
OpenAiImageOptions.java 提供了模型配置,例如要使用的模型、質量、大小等。
在啟動時,可以使用 OpenAiImageModel(OpenAiImageApi openAiImageApi) 建構函式和 withDefaultOptions(OpenAiImageOptions defaultOptions) 方法配置預設選項。或者,使用前面描述的 spring.ai.openai.image.options.* 屬性。
在執行時,您可以透過向 ImagePrompt 呼叫新增新的、特定於請求的選項來覆蓋預設選項。例如,要覆蓋 OpenAI 特定選項,如質量和要建立的影像數量,請使用以下程式碼示例
ImageResponse response = openaiImageModel.call(
new ImagePrompt("A light cream colored mini golden doodle",
OpenAiImageOptions.builder()
.quality("hd")
.N(4)
.height(1024)
.width(1024).build())
);
| 除了特定於模型的 OpenAiImageOptions 之外,您還可以使用透過 ImageOptionsBuilder#builder() 建立的可移植 ImageOptions 例項。 |