|
此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！ |
OpenAI 图像生成
Spring AI 支持 OpenAI 的图像生成模型 DALL-E。
先决条件
您需要使用 OpenAI 创建 API 密钥才能访问 ChatGPT 模型。
在 OpenAI 注册页面创建一个帐户，并在 API 密钥页面上生成令牌。
Spring AI 项目定义了一个名为spring.ai.openai.api-key，您应该设置为API Key从 openai.com 获得。
导出环境变量是设置该配置属性的一种方法：
export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>自动配置
Spring AI 为 OpenAI Image Generation Client 提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的 Maven 中pom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
图像生成属性
连接属性
前缀spring.ai.openai用作允许您连接到 OpenAI 的属性前缀。
财产 |
描述 |
违约 |
spring.ai.openai.base-url |
要连接到的 URL |
|
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 Image 客户端配置重试机制。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.retry.max 次尝试 |
最大重试尝试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数回退策略的初始休眠持续时间。 |
2 秒 |
spring.ai.retry.backoff.multiplier |
Backoff interval 乘数。 |
5 |
spring.ai.retry.backoff.max 间隔 |
最大回退持续时间。 |
3 分钟 |
spring.ai.retry.on-client-errors |
如果为 false，则抛出 NonTransientAiException，并且不要尝试重试 |
假 |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。 |
空 |
spring.ai.retry.on-http-codes |
应触发重试的 HTTP 状态代码列表（例如，引发 TransientAiException）。 |
空 |
配置属性
前缀spring.ai.openai.image是允许您配置ImageModelOpenAI 的实现。
财产 |
描述 |
违约 |
spring.ai.openai.image.enabled |
启用 OpenAI 图像模型。 |
真 |
spring.ai.openai.image.base-url |
可选覆盖spring.ai.openai.base-url以提供特定于聊天的 url |
- |
spring.ai.openai.image.api-key |
Optional 覆盖 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 之一。 |
- |
|
生成的图像的大小。对于 dall-e-2，必须是 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 型号，必须是 1024x1024、1792x1024 或 1024x1792 之一。 |
- |
|
生成的图像的宽度。必须是 dall-e-2 的 256、512 或 1024 之一。 |
- |
|
生成图像的高度。必须是 dall-e-2 的 256、512 或 1024 之一。 |
- |
|
生成的图像的样式。必须是生动或自然的。Vivid 使模型倾向于生成超真实和戏剧性的图像。自然 使模型生成更自然、外观更不真实的图像。此参数仅支持 dall-e-3。 |
- |
|
代表您的最终用户的唯一标识符，可以帮助 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如果设置了 properties，则优先于 common properties。
如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。 |
所有前缀为spring.ai.openai.image.options可以在运行时覆盖。 |
运行时选项
OpenAiImageOptions.java 提供模型配置，例如要使用的模型、质量、大小等。
启动时，可以使用OpenAiImageModel(OpenAiImageApi openAiImageApi)constructor 和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 实例。 |