OpenAI 图像生成

本站(springdoc.cn)中的内容来源于 spring.io ，原始版权归属于 spring.io。由 springdoc.cn 进行翻译，整理。可供个人学习、研究，未经许可，不得进行任何转载、商用或与之相关的行为。商标声明：Spring 是 Pivotal Software, Inc. 在美国以及其他国家的商标。

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

先决条件

你需要创建一个 OpenAI 的 API key 才能访问 ChatGPT model 。

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

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

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

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

为提升处理敏感信息（如 API key ）时的安全性，可使用 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");

自动配置

Spring AI 的自动配置及 Starter 模块的 artifact 名称已发生重大变更。更多信息请参阅升级说明文档。

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

请参考 “依赖管理” 部分将 Spring AI BOM 添加到你的构建文件中。

图像生成配置

连接配置

spring.ai.openai 是用于连接 OpenAI 的属性前缀。

属性

说明

默认

spring.ai.openai.base-url

要连接到的 URL

api.openai.com

spring.ai.openai.api-key

API Key

spring.ai.openai.organization-id

可选，指定用于 API 请求的 organization 。

spring.ai.openai.project-id

可选，指定用于 API 请求的 project 。

对于属于多个组织（或通过旧版用户 API key 访问其项目）的用户，可选择性地指定 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	不应触发重试（例如抛出 `NonTransientAiException` ）的 HTTP 状态码列表。	empty
spring.ai.retry.on-http-codes	应触发重试（例如抛出 `TransientAiException` ）的 HTTP 状态码列表。	empty

spring.ai.retry.max-attempts

最大重试尝试次数。

spring.ai.retry.backoff.initial-interval

指数退避策略的初始休眠时长。

2 sec.

spring.ai.retry.backoff.multiplier

退避间隔乘数。

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

不应触发重试（例如抛出 NonTransientAiException ）的 HTTP 状态码列表。

empty

spring.ai.retry.on-http-codes

应触发重试（例如抛出 TransientAiException ）的 HTTP 状态码列表。

empty

配置属性

图像自动配置的启用和禁用现在通过前缀为 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 密钥

spring.ai.openai.image.organization-id

可选，指定用于 API 请求的组织机构。

spring.ai.openai.image.project-id

可选，指定用于 API 请求的项目。

spring.ai.openai.image.options.n

生成图像数量。必须介于 1 到 10 之间（dall-e-3 仅支持 n=1）。

spring.ai.openai.image.options.model

图像生成使用的模型。

OpenAiImageApi.DEFAULT_IMAGE_MODEL

spring.ai.openai.image.options.quality

生成图像质量。HD 模式可生成细节更精细、整体一致性更强的图像（仅 dall-e-3 支持此参数）。

spring.ai.openai.image.options.response_format

生成图像的返回格式。可选 URL 或 b64_json。.

spring.ai.openai.image.options.size

生成图像的尺寸。对于 dall-e-2 ，必须是 256x256 、 512x512 或 1024x1024 之一。对于 dall-e-3 模型，必须是 1024x1024 、 1792x1024 或 1024x1792 之一。

spring.ai.openai.image.options.size_width

生成图像的宽度。对于 dall-e-2 ，必须是 256 、 512 或 1024 之一。

spring.ai.openai.image.options.size_height

生成图像的高度。对于 dall-e-2 ，必须是 256 、 512 或 1024 之一。

spring.ai.openai.image.options.style

生成图像的风格。必须是 vivid 或 natural 之一。vivid 会使模型倾向于生成超现实且富有戏剧性的图像。natural 会使模型生成更自然、不那么超现实效果的图像。该参数仅支持 dall-e-3 。

spring.ai.openai.image.options.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 账户时，此配置非常有用。

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

运行时选项

OpenAiImageOptions.java 提供了模型配置选项，例如要使用的模型、图像质量、图像大小等。

启动时，可使用 OpenAiImageModel(OpenAiImageApi openAiImageApi) 构造函数和 withDefaultOptions(OpenAiImageOptions defaultOptions) 方法配置默认选项。或者，使用前面介绍的 spring.ai.openai.image.options.* 属性。

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

);

除了模型专用的 OpenAiImageOptions 之外，你还可以使用通过 ImageOptionsBuilder#builder() 创建的便携式 ImageOptions 实例。