最新快照版本请使用Spring AI 1.1.0！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（春.ai.openai.api-key）你应该设置为API 密钥资料来源 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 表达式语言（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");

自动配置

春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。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>

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

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

图像生成属性

连接性质

前缀春.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

连接的URL（链接）spring-doc.cadn.net.cn

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

spring.ai.openai.api-key（春.ai.openai.api-key）spring-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尝试spring-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

两秒钟。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区间spring-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

如果为假，抛出非瞬态AiException，且不要尝试重试4xx客户端错误代码spring-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.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的实现。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-key。spring-doc.cadn.net.cn

可选覆盖 spring.ai.openai.api-key，提供针对聊天的 api-key。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

生成图像的质量。高清能创造出细节更细腻、图像更一致的图像。该参数仅支持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之一。必须是1024x1024、1792x1024或1024x1792中的一种，适用于Dall-E-3型号。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

生成图像的宽度。必须是256、512或1024中的一个，才能达到达尔-e-2。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

生成图像的高度。必须是256、512或1024中的一个，才能达到达尔-e-2。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

生成图像的风格。必须是生动或自然的。Vivid使模型倾向于生成超真实且戏剧性的图像。自然会让模型产生更自然、不那么超现实的图像。该参数仅支持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（春.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

运行时，你可以通过添加新的、针对请求的选项来覆盖默认选项图片提示叫。 例如，要覆盖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（）创建的。