此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

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");

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。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 build.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

<property> </property>spring-doc.cadn.net.cn

<description> </description>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

<property> </property> <description> </description> 默认

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 min.spring-doc.cadn.net.cn

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

如果为假，则抛出一个NonTransientAiException，并且不尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

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

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

<p>空内容</p>spring-doc.cadn.net.cn

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

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

<p>空内容</p>spring-doc.cadn.net.cn

配置属性

图像自动配置的启用和禁用现在通过前缀为 spring.ai.model.image 的顶层属性进行配置。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

<property> </property>spring-doc.cadn.net.cn

<description> </description>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

OpenAIspring-doc.cadn.net.cn

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

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

-spring-doc.cadn.net.cn

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

Optional 允许覆盖 spring.ai.openai.api-key 提供聊天相关的 api-keyspring-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 之外，您还可以使用通过 ImageOptionsBuilder#builder() 创建的可移植 ImageOptions 实例。