OpenAI 图像生成

Spring AI 支持 DALL-E，即来自 OpenAI 的图像生成模型。

NOTE

从 2.0.0-M5 版本起，Spring AI 在所有 OpenAI 模型底层使用官方的 openai-java SDK。此次迁移预期是无缝的，OpenAI API 属性与构建器的现有用户不会遇到破坏性变更。如发现任何问题，请在 Spring AI GitHub Issues 向我们报告。

前置条件

你需要在 OpenAI 创建一个 API 密钥才能访问 ChatGPT 模型。

在 OpenAI 注册页 创建账户，并在 API Keys 页 生成令牌。

Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，你应把它设为从 openai.com 获取的 API Key 的值。

你可以在 application.properties 文件中设置此配置属性：

spring.ai.openai.api-key=<your-openai-api-key>

为在 handling 诸如 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");

自动配置

NOTE

Spring AI 的自动配置、starter 模块的制品名称发生了重大变更。 更多信息请参阅 升级说明。

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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

图像生成属性

连接属性

前缀 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 请求。	-
spring.ai.openai.timeout	OpenAI 客户端的请求超时。	60 sec.
spring.ai.openai.max-retries	OpenAI 客户端的最大重试次数。	3
spring.ai.openai.proxy	OpenAI 客户端的代理设置。	-
spring.ai.openai.custom-headers	要添加到 OpenAI 客户端请求的自定义 HTTP 头。	empty
spring.ai.openai.connection-pool-metrics-enabled	是否为底层 OkHttp 客户端启用连接池指标。	false

TIP

对于属于多个组织（或通过旧版用户 API 密钥访问其项目）的用户，可选地，你可以指定哪个组织和项目用于 API 请求。

这些 API 请求的用量将计入所指定组织和项目的用量。

重试属性

前缀 spring.ai.retry 用作配置 OpenAI 图像客户端重试机制的属性前缀。

属性	描述	默认值
spring.ai.retry.max-attempts	最大重试尝试次数。	10
spring.ai.retry.backoff.initial-interval	指数退避策略的初始等待时长。	2 sec.
spring.ai.retry.backoff.multiplier	退避间隔乘数。	5
spring.ai.retry.backoff.max-interval	最大退避时长。	3 min.
spring.ai.retry.on-client-errors	若为 false，则抛出 NonTransientAiException，不对 4xx 客户端错误码尝试重试	false
spring.ai.retry.exclude-on-http-codes	不应触发重试的 HTTP 状态码列表（例如抛出 NonTransientAiException）。	empty
spring.ai.retry.on-http-codes	应触发重试的 HTTP 状态码列表（例如抛出 TransientAiException）。	empty

配置属性

NOTE

图像自动配置的启用与禁用，现通过以 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-key	-
spring.ai.openai.image.organization-id	可选地，你可以指定某组织用于 API 请求。	-
spring.ai.openai.image.project-id	可选地，你可以指定某项目用于 API 请求。	-
spring.ai.openai.image.n	要生成的图像数。必须在 1 到 10 之间。对于 dall-e-3，仅支持 n=1。	-
spring.ai.openai.image.model	用于图像生成的模型。	ImageModel.GPTIMAGE1_MINI.toString()
spring.ai.openai.image.quality	所生成图像的质量。HD 会生成细节更精细、整体一致性更高的图像。此参数仅 dall-e-3 支持。	-
spring.ai.openai.image.response_format	返回生成图像的格式。必须为 URL 或 b64_json 之一。	-
spring.ai.openai.image.size	所生成图像的尺寸。对于 dall-e-2 必须为 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 模型必须为 1024x1024、1792x1024 或 1024x1792 之一。	-
spring.ai.openai.image.size_width	所生成图像的宽度。对于 dall-e-2 必须为 256、512 或 1024 之一。	-
spring.ai.openai.image.size_height	所生成图像的高度。对于 dall-e-2 必须为 256、512 或 1024 之一。	-
spring.ai.openai.image.style	所生成图像的风格。必须为 vivid 或 natural 之一。Vivid 使模型倾向于生成超写实且富有戏剧性的图像。Natural 使模型生成更自然、较少超写实的图像。此参数仅 dall-e-3 支持。	-
spring.ai.openai.image.user	表示你最终用户的唯一标识符，可帮助 OpenAI 监控和检测滥用。	-

NOTE

你可以覆盖通用的 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 账户时，这很有用。

TIP

所有以 spring.ai.openai.image.options 为前缀的属性都可在运行时被覆盖。

运行时选项

OpenAiImageOptions.java 提供模型配置，例如要使用的模型、质量、尺寸等。

在启动时，可通过把 OpenAiImageOptions 传给 OpenAiImageModel 构造器来配置默认选项。或者使用先前所述的 spring.ai.openai.image.* 属性。

在运行时，你可以通过向 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())

);

TIP

除模型特定的 OpenAiImageOptions 外，你还可以使用一个可移植的 ImageOptions 实例，通过 ImageOptionsBuilder#builder() 创建。

定制 HTTP 客户端

Spring AI 在底层使用官方的 openai-java SDK，并通过由 SpringAiOpenAiHttpClient.Builder 构建的自定义 OkHttp 客户端来配置其 HTTP 传输。 你可以通过暴露一个或多个 OpenAiHttpClientBuilderCustomizer bean，在底层 OkHttpClient 创建之前拦截那个构建器。 每个定制器接收的都是每个 OpenAI 模型（聊天、嵌入、图像、音频、审核）所使用的同一个构建器，因此该定制会统一生效。

@FunctionalInterface
public interface OpenAiHttpClientBuilderCustomizer {
    void customize(SpringAiOpenAiHttpClient.Builder builder);
}

典型用例包括：

• 注册 OkHttp 的 Interceptor 实例（身份认证、传播头、自定义日志）；
• 更换调度器的 ExecutorService（例如，把异步 I/O 路由到虚拟线程）；
• 配置代理、SSL、主机名验证，或构建器暴露的连接池大小。

当存在多个定制器时，它们会按 @Order / Ordered 顺序、在 Spring AI 自身默认值之后应用，因此用户代码胜出。

当通过 OpenAi*Model.Builder 手动装配模型时，同样的钩子也可用：

var chatModel = OpenAiChatModel.builder()
    .options(OpenAiChatOptions.builder().model("gpt-4o").build())
    .httpClientBuilderCustomizer(myCustomizer)
    .build();