6.2 Spring AI OpenAI 图像生成

吴祖贤
34 阅读5分钟

Spring AI OpenAI 图像生成

前言

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

前提条件

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

在 OpenAI 注册页面 创建账户，并在 API Keys 页面 生成令牌。

Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，您应该将其设置为从 openai.com 获取的 API Key 的值。

您可以在 application.properties 文件中设置此配置属性：

spring.ai.openai.api-key=<your-openai-api-key>

为了在处理 API 密钥等敏感信息时增强安全性，您可以使用 Spring Expression Language (SpEL) 来引用自定义环境变量：

# In application.yml
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}

# In your environment or .env file
export OPENAI_API_KEY=<your-openai-api-key>

您也可以在应用程序代码中以编程方式设置此配置：

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("OPENAI_API_KEY");

自动配置

注意 Spring AI 自动配置、启动器模块的构件名称发生了重大变化。请参考升级说明了解更多信息。

Spring AI 为 OpenAI 图像生成客户端提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}

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

图像生成属性

连接属性

前缀 spring.ai.openai 用作连接到 OpenAI 的属性前缀。

属性描述默认值
spring.ai.openai.base-url要连接的 URLapi.openai.com
spring.ai.openai.api-keyAPI 密钥-
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 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
spring.ai.retry.on-http-codes应该触发重试的 HTTP 状态代码列表（例如，抛出 TransientAiException）。empty
配置属性

注意 图像自动配置的启用和禁用现在通过前缀为 spring.ai.model.image 的顶级属性配置。

要启用，设置 spring.ai.model.image=openai（默认启用）

要禁用，设置 spring.ai.model.image=none（或任何不匹配 openai 的值）

进行此更改是为了允许配置多个模型。

前缀 spring.ai.openai.image 是配置 OpenAI 的 ImageModel 实现的属性前缀。

属性描述默认值
spring.ai.openai.image.enabled (已移除，不再有效)启用 OpenAI 图像模型。true
spring.ai.model.image启用 OpenAI 图像模型。openai
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.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()
                .quality("hd")
                .N(4)
                .height(1024)
                .width(1024).build())
);

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

avatar
文章
阅读
粉丝