OpenAI Image Generation

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

先决条件

您需要使用 OpenAI 创建 API密钥 来访问 ChatGPT 模型。

OpenAI 注册页面 创建帐户 并在API 密钥页面生成令牌。 Spring AI 项目定义了一个名为的配置属性,您应该将其设置为从 openai.com 获取的spring.ai.openai.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'
}

配置属性

图像生成属性

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 将生成的图像的质量。高清创建的图像具有更精细的细节和更高的图像一致性。仅 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 https://api.openai.com
spring.ai.openai.api-key API 密钥 -
重试属性

spring.ai.retry 前缀的属性,可让您配置OpenAI Image Client 的重试机制。

属性 描述 默认值
spring.ai.retry.max-attempts 最大重试次数。 10
spring.ai.retry.backoff.initial-interval Backoff 策略的初始睡眠持续时间。 2 秒.
spring.ai.retry.backoff.multiplier Backoff 间隔乘数。 5
spring.ai.retry.backoff.max-interval 最大 Backoff 持续时间。 3 分钟.
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 之外,您还可以使用 ImageOptionsBuilder#builder() 创建的可移植ImageOptions 实例。

作者:Jeebiz  创建时间:2024-04-05 23:51
最后编辑:Jeebiz  更新时间:2024-07-06 19:00