OpenAI Image Generation
Spring AI 支持 DALL-E，这是 OpenAI 的图像生成模型。
Prerequisites
您需要使用 OpenAI 创建 API 密钥来访问 ChatGPT 模型。在 OpenAI signup page上创建一个帐户并在 API Keys page上生成令牌。Spring AI 项目定义了一个配置属性，名为 spring.ai.openai.api-key，您应将其设置为从 openai.com 获得的 `API Key`的值。导出环境变量是设置该配置属性的一种方法：
export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>Auto-configuration
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'
}
|
Image Generation Properties
前缀 spring.ai.openai.image 是允许你配置适用于 OpenAI 的 ImageClient 实现的属性前缀。
Property |
Description |
Default |
spring.ai.openai.image.enabled |
Enable OpenAI image client. |
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.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。 |
- |
|
生成图像的大小。对于 dall-e-2，必须为 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 模型，必须为 1024x1024、1792x1024 或 1024x1792 之一。 |
- |
|
生成图像的宽度。对于 dall-e-2，必须为 256、512 或 1024 之一。 |
- |
|
生成图像的高度。对于 dall-e-2，必须为 256、512 或 1024 之一。 |
- |
|
生成图像的样式。必须为 vivid 或 natural 之一。Vivid 使模型倾向于生成超真实且戏剧性的图像。Natural 使模型生成更自然、看起来不太超真实的图像。仅 dall-e-3 支持此参数。 |
- |
|
一个表示最终用户的独特标识符，可帮助 OpenAI 监控和检测滥用。 |
- |
Connection Properties
spring.ai.openai 前缀用作可让你连接到 Open AI 的属性前缀。
Property |
Description |
Default |
spring.ai.openai.base-url |
连接到的 URL |
[role="bare"]https://api.openai.com |
spring.ai.openai.api-key |
The API Key |
- |
Retry Properties
spring.ai.retry 前缀用作可让你配置 OpenAI Image 客户端的重试机制的属性前缀。
| Property | Description | Default |
|---|---|---|
spring.ai.retry.max-attempts |
最大重试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数退避策略的初始休眠持续时间。 |
2 sec. |
spring.ai.retry.backoff.multiplier |
Backoff interval multiplier. |
5 |
spring.ai.retry.backoff.max-interval |
Maximum backoff duration. |
3 min. |
spring.ai.retry.on-client-errors |
如果为 false，则抛出 NonTransientAiException，并且不尝试针对 |
false |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表（例如，抛出 NonTransientAiException）。 |
empty |
Runtime Options
OpenAiImageOptions.java提供模型配置，例如使用的模型、质量、大小等。
启动时，可以使用 OpenAiImageClient(OpenAiImageApi openAiImageApi) 构造函数和 withDefaultOptions(OpenAiImageOptions defaultOptions) 方法配置默认选项。或者，使用前面介绍的 spring.ai.openai.image.options.* 属性。
在运行时，你可以通过将新的请求特定选项添加到 ImagePrompt 调用来覆盖默认选项。例如，要覆盖 OpenAI 特定的选项（例如质量和创建的图像数量），请使用以下代码示例：
ImageResponse response = openaiImageClient.call(
new ImagePrompt("A light cream colored mini golden doodle",
OpenAiImageOptions.builder()
.withQuality("hd")
.withN(4)
.withHeight(1024)
.withWidth(1024).build())
);
|