此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！spring-doc.cn

OpenAI 图像生成

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

先决条件

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

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

自动配置

Spring AI 为 OpenAI Image Generation Client 提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 文件中：pom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

图像生成属性

连接属性

前缀用作允许您连接到 OpenAI 的属性前缀。spring.ai.openaispring-doc.cn

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.openai.base-urlspring-doc.cn

要连接到的 URLspring-doc.cn

api.openai.comspring-doc.cn

spring.ai.openai.api-keyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

spring.ai.openai.organization-idspring-doc.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cn

-spring-doc.cn

spring.ai.openai.project-idspring-doc.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cn

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

重试属性

前缀用作属性前缀，允许您为 OpenAI Image 客户端配置重试机制。spring.ai.retryspring-doc.cn

财产 描述 违约

spring.ai.retry.max 次尝试spring-doc.cn

最大重试尝试次数。spring-doc.cn

10spring-doc.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cn

指数回退策略的初始休眠持续时间。spring-doc.cn

2 秒spring-doc.cn

spring.ai.retry.backoff.multiplierspring-doc.cn

Backoff interval 乘数。spring-doc.cn

5spring-doc.cn

spring.ai.retry.backoff.max 间隔spring-doc.cn

最大回退持续时间。spring-doc.cn

3 分钟spring-doc.cn

spring.ai.retry.on-client-errorsspring-doc.cn

如果为 false，则引发 NonTransientAiException，并且不要尝试重试客户端错误代码4xxspring-doc.cn

假spring-doc.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cn

不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。spring-doc.cn

空spring-doc.cn

spring.ai.retry.on-http-codesspring-doc.cn

应触发重试的 HTTP 状态代码列表（例如，引发 TransientAiException）。spring-doc.cn

空spring-doc.cn

配置属性

前缀是允许您为 OpenAI 配置实施的属性前缀。spring.ai.openai.imageImageModelspring-doc.cn

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.openai.image.enabledspring-doc.cn

启用 OpenAI 图像模型。spring-doc.cn

真spring-doc.cn

spring.ai.openai.image.base-urlspring-doc.cn

可选覆盖spring.ai.openai.base-url以提供特定于聊天的 urlspring-doc.cn

-spring-doc.cn

spring.ai.openai.image.api-keyspring-doc.cn

Optional 覆盖 spring.ai.openai.api-key 以提供特定于聊天的 api-keyspring-doc.cn

-spring-doc.cn

spring.ai.openai.image.organization-idspring-doc.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.project-idspring-doc.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.nspring-doc.cn

要生成的图像数。必须介于 1 和 10 之间。对于 dall-e-3，仅支持 n=1。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.modelspring-doc.cn

用于图像生成的模型。spring-doc.cn

OpenAiImageApi.DEFAULT_IMAGE_MODELspring-doc.cn

spring.ai.openai.image.options.qualityspring-doc.cn

将生成的图像质量。HD 创建的图像具有更精细的细节和更高的图像一致性。此参数仅支持 dall-e-3。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.response_formatspring-doc.cn

返回生成图像的格式。必须是 URL 或 b64_json 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.sizespring-doc.cn

生成的图像的大小。对于 dall-e-2，必须是 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 型号，必须是 1024x1024、1792x1024 或 1024x1792 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.size_widthspring-doc.cn

生成的图像的宽度。必须是 dall-e-2 的 256、512 或 1024 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.size_heightspring-doc.cn

生成图像的高度。必须是 dall-e-2 的 256、512 或 1024 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.stylespring-doc.cn

生成的图像的样式。必须是生动或自然的。Vivid 使模型倾向于生成超真实和戏剧性的图像。自然 使模型生成更自然、外观更不真实的图像。此参数仅支持 dall-e-3。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.userspring-doc.cn

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

-spring-doc.cn
您可以覆盖通用的 、 和 属性。 如果设置了 ， 和 属性，则优先于公共属性。 如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。spring.ai.openai.base-urlspring.ai.openai.api-keyspring.ai.openai.organization-idspring.ai.openai.project-idspring.ai.openai.image.base-urlspring.ai.openai.image.api-keyspring.ai.openai.image.organization-idspring.ai.openai.image.project-id
所有前缀为 的属性都可以在运行时覆盖。spring.ai.openai.image.options

运行时选项

OpenAiImageOptions.java 提供模型配置，例如要使用的模型、质量、大小等。spring-doc.cn

启动时，可以使用 constructor 和 method 配置默认选项。或者，使用前面描述的属性。OpenAiImageModel(OpenAiImageApi openAiImageApi)withDefaultOptions(OpenAiImageOptions defaultOptions)spring.ai.openai.image.options.*spring-doc.cn

在运行时，您可以通过向调用添加新的、特定于请求的选项来覆盖默认选项。 例如，要覆盖 OpenAI 特定选项（例如质量和要创建的图像数量），请使用以下代码示例：ImagePromptspring-doc.cn

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 之外，您还可以使用通过 ImageOptionsBuilder#builder（） 创建的可移植 ImageOptions 实例。