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

属性

描述

默认值

spring.ai.openai.base-url

要连接到的 URL

api.openai.com

spring.ai.openai.api-key

API 密钥

spring.ai.openai.organization-id

可以选择指定用于 API 请求的组织。

spring.ai.openai.project-id

可以选择指定用于 API 请求的项目。

对于属于多个组织的用户（或通过其旧版用户 API 密钥访问其项目的用户），可以选择指定用于 API 请求的组织和项目。来自这些 API 请求的用量将计为指定组织和项目的用量。

重试属性

前缀 spring.ai.retry 用作属性前缀，可让您配置 OpenAI 图像客户端的重试机制。

属性描述默认值

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

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

空

spring.ai.retry.on-http-codes

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

空

配置属性

前缀 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.organization-id

可以选择指定用于 API 请求的组织。

spring.ai.openai.image.project-id

可以选择指定用于 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

生成的图像风格。必须是 vivid 或 natural 之一。Vivid 会导致模型倾向于生成超现实和戏剧性的图像。Natural 会导致模型生成更自然、不太超现实的图像。此参数仅适用于 dall-e-3。

spring.ai.openai.image.options.user

代表您的最终用户的唯一标识符，这可以帮助 OpenAI 监控和检测滥用行为。

您可以覆盖常见的 spring.ai.openai.base-url、spring.ai.openai.api-key、spring.ai.openai.organization-id 和 spring.ai.openai.project-id 属性。如果设置了 spring.ai.openai.image.base-url、spring.ai.openai.image.api-key、spring.ai.openai.image.organization-id 和 spring.ai.openai.image.project-id 属性，则它们优先于通用属性。如果您想对不同的模型和不同的模型端点使用不同的 OpenAI 帐户，这将非常有用。

以 spring.ai.openai.image.options 为前缀的所有属性都可以在运行时覆盖。

运行时选项

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