OpenAI 影像生成

Spring AI 支援 OpenAI 的影像生成模型 DALL-E。

先決條件

您需要建立 OpenAI API 金鑰才能訪問 ChatGPT 模型。請在 OpenAI 註冊頁面建立賬戶並在 API 金鑰頁面生成 token。Spring AI 專案定義了一個名為 `spring.ai.openai.api-key` 的配置屬性，您應將其設定為從 openai.com 獲取的 API 金鑰值。匯出環境變數是設定此配置屬性的一種方法

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

自動配置

Spring AI 自動配置、Starter 模組的 artifact 名稱發生了重大變化。請參閱升級說明獲取更多資訊。

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

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.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.retry.max-attempts

最大重試次數。

spring.ai.retry.backoff.initial-interval

指數退避策略的初始等待時間。

2 秒。

spring.ai.retry.backoff.multiplier

退避間隔乘數。

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.model.image` 的頂級屬性來配置。

要啟用，設定 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 金鑰

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 中的一種。

spring.ai.openai.image.options.size

生成影像的尺寸。對於 dall-e-2，必須是 256x256、512x512 或 1024x1024 之一。對於 dall-e-3 模型，必須是 1024x1024、1792x1024 或 1024x1792 之一。

spring.ai.openai.image.options.size_width

生成影像的寬度。對於 dall-e-2，必須是 256、512 或 1024 之一。

spring.ai.openai.image.options.size_height

生成影像的高度。對於 dall-e-2，必須是 256、512 或 1024 之一。

spring.ai.openai.image.options.style

生成影像的風格。必須是 vivid（生動）或 natural（自然）之一。Vivid 使模型傾向於生成超現實和戲劇性的影像。Natural 使模型生成更自然、 less hyper-real 的影像。此引數僅支援 dall-e-3。

spring.ai.openai.image.options.user

代表您的終端使用者的唯一識別符號，可以幫助 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 外，您還可以使用可移植的 ImageOptions 例項，該例項透過 ImageOptionsBuilder#builder() 建立。