OpenAI 图像生成

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

先决条件

您需要使用 OpenAI 创建一个 API 密钥才能访问 ChatGPT 模型。在 OpenAI 注册页面 创建一个帐户，并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，您应该将其设置为从 openai.com 获取的 API 密钥 的值。导出环境变量是设置该配置属性的一种方法。

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.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-key

-

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 用作属性前缀，允许您连接到 OpenAI。

属性

描述

默认值

spring.ai.openai.base-url

要连接的 URL

api.openai.com

spring.ai.openai.api-key

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）。

empty

spring.ai.retry.on-http-codes

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

empty

运行时选项

该 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()
                .withQuality("hd")
                .withN(4)
                .withHeight(1024)
                .withWidth(1024).build())

);
除了特定于模型的 OpenAiImageOptions 之外，您还可以使用可移植的 ImageOptions 实例，该实例使用 ImageOptionsBuilder#builder() 创建。