OpenAI 图像生成

Spring AI 支持 OpenAI 的图像生成模型 DALL-E。spring-doc.cadn.net.cn

前提条件

您需要创建一个OpenAI的API密钥以访问ChatGPT模型。spring-doc.cadn.net.cn

在OpenAI注册页面创建一个帐户，并在API密钥页面生成Tokens。spring-doc.cadn.net.cn

Spring AI项目定义了一个名为spring.ai.openai.api-key的配置属性，您应将其设置为从openai.com获取的API Key值。spring-doc.cadn.net.cn

您可以在application.properties文件中设置此配置属性：spring-doc.cadn.net.cn

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

为了在处理API密钥等敏感信息时增强安全性，您可以使用Spring表达式语言（SpEL）引用自定义环境变量：spring-doc.cadn.net.cn

# 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>

您也可以在应用程序代码中以编程方式设置此配置：spring-doc.cadn.net.cn

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("OPENAI_API_KEY");

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 OpenAI 图像生成客户端提供了 Spring Boot 自动配置功能。要启用此功能，请在项目的 Maven pom.xml 文件中添加以下依赖项：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>

或者添加到您的Gradle 构建脚本文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。

图像生成属性

连接属性

前缀 spring.ai.openai 用于作为属性前缀，以便您连接到OpenAI。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

spring.ai.openai.base-urlspring-doc.cadn.net.cn

要连接的URLspring-doc.cadn.net.cn

api.openai.comspring-doc.cadn.net.cn

spring.ai.openai.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.organization-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.project-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的项目。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn
对于属于多个组织（或通过其旧版用户API密钥访问项目）的用户，可选地，您可以指定用于API请求的组织和项目。 来自这些API请求的使用将计为指定组织和项目的使用量。

重试属性

前缀 spring.ai.retry 用于作为属性前缀，允许您配置OpenAI图像客户端的重试机制。spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.retry.max-attemptsspring-doc.cadn.net.cn

最大重试次数。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数退避策略的初始睡眠时长。spring-doc.cadn.net.cn

2 秒spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

退避间隔乘数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max-intervalspring-doc.cadn.net.cn

最大退避时长。spring-doc.cadn.net.cn

3 分钟。spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为false，则抛出NonTransientAiException，且不重试客户端错误代码4xxspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应触发重试的HTTP状态代码列表（例如，用于抛出非暂时性AI异常）。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表（例如，用于抛出TransientAiException）。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

配置属性

图片自动配置的启用和禁用现在通过带有前缀spring.mvc.static-path-pattern的顶级属性进行配置。spring-doc.cadn.net.cn

要启用，请设置 spring.ai.model.image=openai （默认情况下已启用）spring-doc.cadn.net.cn

要禁用，请设置 spring.ai.model.image=none（或任何不匹配 openai 的值）。spring-doc.cadn.net.cn

这种修改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.openai.image 是属性前缀，允许您为OpenAI配置 ImageModel 实现。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

spring.ai.openai.image.enabled（已移除，不再有效）spring-doc.cadn.net.cn

启用OpenAI图像模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.imagespring-doc.cadn.net.cn

启用OpenAI图像模型。spring-doc.cadn.net.cn

开源人工智能spring-doc.cadn.net.cn

spring.ai.openai.image.base-urlspring-doc.cadn.net.cn

可选地，覆盖 `spring.ai.openai.base-url` 以提供特定于聊天的URL。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.api-keyspring-doc.cadn.net.cn

可选地，覆盖 `spring.ai.openai.api-key` 以提供聊天特定的 API 密钥。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.organization-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.project-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的项目。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.nspring-doc.cadn.net.cn

要生成的图像数量。必须在1到10之间。对于dall-e-3，只支持n=1。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.modelspring-doc.cadn.net.cn

用于图像生成的模型。spring-doc.cadn.net.cn

OpenAiImageApi.DEFAULT_IMAGE_MODELspring-doc.cadn.net.cn

spring.ai.openai.image.options.qualityspring-doc.cadn.net.cn

将要生成的图像质量。高清（HD）创建的图像具有更精细的细节和整个图像中更高的一致性。此参数仅支持dall-e-3。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.response_formatspring-doc.cadn.net.cn

生成的图片以何种格式返回。必须是 URL 或 b64_json 之一。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.sizespring-doc.cadn.net.cn

生成图像的大小。对于dall-e-2，必须是256x256、512x512或1024x1024之一。对于dall-e-3模型，必须是1024x1024、1792x1024或1024x1792之一。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.size_widthspring-doc.cadn.net.cn

生成图像的宽度。对于dall-e-2，此值必须为256、512或1024之一。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.size_heightspring-doc.cadn.net.cn

生成图像的高度。对于dall-e-2，此值必须为256、512或1024之一。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.stylespring-doc.cadn.net.cn

生成图像的风格。必须是 vivid 或 natural 中的一种。vivid 使模型倾向于生成超现实和戏剧性的图像，而 natural 则使模型产生更自然、不太超现实的图像。此参数仅支持 dall-e-3。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.image.options.userspring-doc.cadn.net.cn

代表您终端用户的唯一标识符，有助于OpenAI监控和检测滥用行为。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn
您可以覆盖常用的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 文件提供了模型配置选项，如使用的模型、质量、尺寸等。spring-doc.cadn.net.cn

在启动时，默认选项可以通过 OpenAiImageModel(OpenAiImageApi openAiImageApi) 构造器和 withDefaultOptions(OpenAiImageOptions defaultOptions) 方法进行配置。或者，使用之前描述的 spring.ai.openai.image.options.* 属性。spring-doc.cadn.net.cn

在运行时，您可以通过向ImagePrompt调用添加新的、特定于请求的选项来覆盖默认选项。 例如，要覆盖诸如质量及创建图像的数量等OpenAI特定选项，请使用以下代码示例:spring-doc.cadn.net.cn

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