OpenAI图像生成

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

先决条件

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

export SPRING_AI_OPENAI_API_KEY=<在此处插入密钥>

自动配置

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的ImageClient实现的属性前缀。

属性

描述

默认值

spring.ai.openai.image.enabled

启用OpenAI图像客户端。

true

spring.ai.openai.image.base-url

可选，用于提供特定于聊天的URL的spring.ai.openai.base-url的覆盖

-

spring.ai.openai.image.api-key

可选，用于提供特定于聊天的API密钥的spring.ai.openai.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图像客户端的重试机制的属性前缀。

属性 描述 默认值

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

运行时选项

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())

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