OpenAI 图像生成
Spring AI 支持来自 OpenAI 的图像生成模型 DALL-E。
前提条件
你需要创建一个OpenAI的API密钥才能访问ChatGPT模型。
在 OpenAI 注册页面 创建账户，并在 API Keys 页面 生成令牌。
Spring AI项目定义了一个名为spring.ai.openai.api-key的配置属性，您应将其设置为从openai.com获取的API Key的值。
您可以在 application.properties 文件中设置此配置属性：
spring.ai.openai.api-key=<your-openai-api-key>
为增强处理敏感信息（如 API 密钥）时的安全性，您可以使用 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 模块的构件名称发生了重大变化。更多信息，请参阅升级说明。
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 密钥 | - |
| spring.ai.openai.organization-id | 可选，可以指定用于 API 请求的组织。 | - |
| spring.ai.openai.project-id | 可选，可以指定用于 API 请求的项目。 | - |
对于属于多个组织（或通过其遗留用户API密钥访问其项目）的用户，您可以选择性地指定API请求使用哪个组织和项目。这些API请求的使用将计入指定组织和项目的使用量。
重试属性
前缀 spring.ai.retry 用作属性前缀，允许您为 OpenAI 图像客户端配置重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| 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，则针对 4xx 客户端错误码会抛出 NonTransientAiException，且不进行重试。 | false |
| spring.ai.retry.exclude-on-http-codes | 不应触发重试（例如，会抛出 NonTransientAiException）的 HTTP 状态码列表。 | 空 |
| spring.ai.retry.on-http-codes | 应触发重试（例如，会抛出 TransientAiException）的 HTTP 状态码列表。 | 空 |
配置属性
图像自动配置的启用与禁用现在通过前缀为 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 监控和检测滥用行为。 | - |
您可以覆盖通用的 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() 创建。