OpenAI 图像生成
Spring AI 支持 OpenAI 的图像生成模型 DALL-E。
先决条件
你需要创建一个 OpenAI 的 API 密钥来访问 ChatGPT 模型。请在 OpenAI 注册页面 创建一个账户，并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，你应该将其设置为从 openai.com 获取的 API Key 的值。导出环境变量是设置该配置属性的一种方式：
export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
自动配置
Spring AI 为 OpenAI 图像生成客户端提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>
或者到你的 Gradle build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参考 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。
图像生成属性
连接属性
前缀 spring.ai.openai 用作属性前缀，允许你连接到 OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.openai.base-url | 连接的 URL | api.openai.com |
| spring.ai.openai.api-key | API 密钥 | - |
| spring.ai.openai.organization-id | 可选，您可以指定用于 API 请求的组织。 | - |
| spring.ai.openai.project-id | 可选，您可以指定用于 API 请求的项目。 | - |
:::提示
对于属于多个组织的用户（或通过其遗留用户 API 密钥访问其项目的用户），您可以选择性地指定哪个组织和项目用于 API 请求。这些 API 请求的使用将计入指定组织和项目的使用量。
:::
重试属性
前缀 spring.ai.retry 用作属性前缀，允许您为 OpenAI Image 客户端配置重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.retry.max-attempts | 最大重试次数。 | 10 |
| spring.ai.retry.backoff.initial-interval | 指数退避策略的初始休眠时间。 | 2 秒 |
| spring.ai.retry.backoff.multiplier | 退避间隔乘数。 | 5 |
| spring.ai.retry.backoff.max-interval | 最大退避时间。 | 3 分钟 |
| spring.ai.retry.on-client-errors | 如果为 false，抛出 NonTransientAiException，并且不会为 4xx 客户端错误代码尝试重试。 | false |
| spring.ai.retry.exclude-on-http-codes | 不应触发重试的 HTTP 状态代码列表（例如抛出 NonTransientAiException）。 | 空 |
| spring.ai.retry.on-http-codes | 应触发重试的 HTTP 状态代码列表（例如抛出 TransientAiException）。 | 空 |
配置属性
spring.ai.openai.image 前缀是一个属性前缀，允许你为 OpenAI 的 ImageModel 实现进行配置。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.openai.image.enabled | 启用 OpenAI 图像模型。 | true |
| 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 监控和检测滥用行为。 | - |
你可以覆盖常见的 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，你还可以使用一个可移植的 ImageOptions 实例，该实例通过 ImageOptionsBuilder#builder() 创建。