收藏本站,收获最前沿的人工智能与编程资讯!!

Spring AI 使用 OpenAI 图像生成

技术文档 13℃ 0

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

前提条件

你需要创建 OpenAI API 密钥才能访问 ChatGPT 模型。

在 OpenAI 注册页面创建账号,并在 API 密钥页面生成令牌。

Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性,你需要将其设置为从 openai.com 获取的 API 密钥值。

你可以在 application.properties 文件中设置该配置属性:

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

为了在处理 API 密钥等敏感信息时提高安全性,你可以使用 Spring 表达式语言(SpEL)引用自定义环境变量:

# 在 application.yml 中
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}
# 在你的环境变量或 .env 文件中
export OPENAI_API_KEY=<your-openai-api-key>

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

// 从安全来源或环境变量中获取 API 密钥
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 秒
spring.ai.retry.backoff.multiplier退避间隔乘数5
spring.ai.retry.backoff.max-interval最大退避时长3 分钟
spring.ai.retry.on-client-errors如果为 false,对于 4xx 客户端错误码,抛出 NonTransientAiException 且不重试false
spring.ai.retry.exclude-on-http-codes不应触发重试的 HTTP 状态码列表
spring.ai.retry.on-http-codes应触发重试的 HTTP 状态码列表

配置属性

图像自动配置的启用和禁用现在通过前缀为 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 之一。仅 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 下的对应属性如果设置,优先级高于通用属性。如果你想为不同模型和模型端点使用不同的 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 实例。

相关推荐