此版本仍在开发中，尚不被认为是稳定的。对于最新的快照版本，请使用 Spring AI 1.0.1！spring-doc.cadn.net.cn

OpenAI 图像生成

Spring AI 支持 DALL-E，这是 OpenAI 的图像生成模型。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您应该将API Key获得于 openai.com。spring-doc.cadn.net.cn

您可以在application.properties文件：spring-doc.cadn.net.cn

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

为了在处理 API 密钥等敏感信息时增强安全性，您可以使用 Spring Expression Language （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");

自动配置

Spring AI 自动配置、入门模块的工件名称发生了重大变化。有关更多信息，请参阅升级说明。spring-doc.cadn.net.cn

Spring AI 为 OpenAI Image Generation Client 提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

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

或 Gradlebuild.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.组织 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 Image 客户端的重试机制。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.retry.max次尝试spring-doc.cadn.net.cn

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

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.初始间隔spring-doc.cadn.net.cn

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

2 秒。spring-doc.cadn.net.cn

spring.ai.retry.backoff.乘数spring-doc.cadn.net.cn

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

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max间隔spring-doc.cadn.net.cn

最大回退持续时间。spring-doc.cadn.net.cn

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

spring.ai.retry.on-client-错误spring-doc.cadn.net.cn

如果为 false，则引发 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

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-代码spring-doc.cadn.net.cn

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

emptyspring-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是属性前缀，用于配置ImageModelOpenAI 的实施。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

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

可选覆盖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

将生成的图像的质量。高清创建的图像具有更精细的细节和更大的图像一致性。此参数仅支持 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

生成图像的样式。必须是生动或自然的。生动使模型倾向于生成超真实和戏剧性的图像。自然使模型生成更自然、更不那么超真实的图像。此参数仅支持 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 实例。