OpenAI图像生成

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

先决条件

您需要创建一个与OpenAI的API密钥才能访问ChatGPT模型。在[OpenAI注册页面]https://platform.openai.com/signup 创建一个账户并在[API Keys页面]https://platform.openai.com/account/api-keys 生成令牌。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'
}

Tip	请参考依赖管理部分，以将Spring AI BOM添加到您的构建文件中。

图像生成属性

前缀 spring.ai.openai.image 是一个属性前缀，用于配置 OpenAI 的 ImageClient 实现。

属性

描述

默认值

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地址

https://api.openai.com

spring.ai.openai.api-key

API密钥

配置属性

重试属性

前缀 spring.ai.retry 被用作属性前缀，允许您为 OpenAI 图像客户端配置重试机制。

属性

描述

默认值

-----------------------------

----------------------------------------

----------------

spring.ai.retry.max-attempts

最大重试次数。

spring.ai.retry.backoff.initial-interval

指数退避策略的初始休眠持续时间。

2秒

spring.ai.retry.backoff.multiplier

退避间隔乘数。

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

空

运行时选项

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

''');'''

Tip	In addition to the model specific OpenAiImageOptions you can use a portable ImageOptions instance, created with the ImageOptionsBuilder#builder().