【Spring AI】03. 图像生成 API-OpenAI

OpenAI 图像生成

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

先决条件

---

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

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

自动装配

---

Spring AI 为 OpenAI Image Generation Client 提供了 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	可选，会覆盖 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 之一。	-
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	生成图像的风格。必须是生动或自然之一。生动会使模型倾向于生成超现实和戏剧性的图像。自然会使模型生成更自然、不那么超现实的图像。此参数仅支持 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	The API Key	-

配置属性参数

重试属性参数

参数前缀spring.ai.retry，让您为 OpenAI Image 客户端配置重试机制。

参数	描述	默认值
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
spring.ai.retry.exclude-on-http-codes	不应触发重试的 HTTP 状态代码列表（例如，抛出 NonTransientAiException）。	empty

运行时选项参数

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() 创建。