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() 创建。