Azure OpenAI 图像生成
Spring AI 支持 Azure OpenAI 的 DALL-E 图像生成模型。
前提条件
从 Azure OpenAI 服务部分获取您的 Azure OpenAI endpoint
和 api-key
。
Spring AI 定义了两个配置属性:
-
spring.ai.azure.openai.api-key
:设置为从 Azure 获取的API Key
值。 -
spring.ai.azure.openai.endpoint
:设置为在 Azure 中配置模型时获取的端点 URL。
您可以在 application.properties
文件中设置这些配置属性:
spring.ai.azure.openai.api-key=<your-azure-openai-api-key>
spring.ai.azure.openai.endpoint=<your-azure-openai-endpoint>
为了在处理 API 密钥等敏感信息时增强安全性,您可以使用 Spring 表达式语言 (SpEL) 引用自定义环境变量:
# 在 application.yml 中
spring:
ai:
azure:
openai:
api-key: ${AZURE_OPENAI_API_KEY}
endpoint: ${AZURE_OPENAI_ENDPOINT}
# 在您的环境或 .env 文件中
export AZURE_OPENAI_API_KEY=<your-azure-openai-api-key>
export AZURE_OPENAI_ENDPOINT=<your-azure-openai-endpoint>
您也可以在应用程序代码中以编程方式设置这些配置:
// 从安全源或环境变量中获取 API 密钥和端点
String apiKey = System.getenv("AZURE_OPENAI_API_KEY");
String endpoint = System.getenv("AZURE_OPENAI_ENDPOINT");
部署名称
要运行 Azure AI 应用程序,请通过 [Azure AI 门户](oai.azure.com/portal) 创建 Azure AI 部署。
在 Azure 中,每个客户端必须指定一个 Deployment Name
来连接到 Azure OpenAI 服务。
重要的是要理解 Deployment Name
与您选择部署的模型不同。
例如,名为 'MyImgAiDeployment' 的部署可以配置为使用 Dalle3
模型或 Dalle2
模型。
目前,为了保持简单,您可以使用以下设置创建部署:
部署名称:MyImgAiDeployment
模型名称:Dalle3
此 Azure 配置将与 Spring Boot Azure AI Starter 及其自动配置功能的默认配置保持一致。
如果您使用不同的部署名称,请相应地更新配置属性:
spring.ai.azure.openai.image.options.deployment-name=<my deployment name>
Azure OpenAI 和 OpenAI 的不同部署结构导致 Azure OpenAI 客户端库中有一个名为 deploymentOrModelName
的属性。
这是因为在 OpenAI 中没有 Deployment Name
,只有 Model Name
。
自动配置
Spring AI 自动配置、starter 模块的构件名称发生了重大变化。 请参考 升级说明 了解更多信息。 |
Spring AI 为 Azure OpenAI 聊天客户端提供 Spring Boot 自动配置。
要启用它,请将以下依赖项添加到项目的 Maven pom.xml
文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-azure-openai</artifactId>
</dependency>
或添加到 Gradle build.gradle
构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-azure-openai'
}
提示:请参考 依赖管理 部分,将 Spring AI BOM 添加到您的构建文件中。
图像生成属性
图像自动配置的启用和禁用现在通过前缀为 要启用,spring.ai.model.image=azure-openai(默认启用) 要禁用,spring.ai.model.image=none(或任何不匹配 azure-openai 的值) 此更改是为了允许多个模型的配置。 |
前缀 spring.ai.openai.image
是允许您配置 OpenAI 的 ImageModel
实现的属性前缀。
属性 |
描述 |
默认值 |
spring.ai.azure.openai.image.enabled(已移除且不再有效) |
启用 OpenAI 图像模型。 |
true |
spring.ai.model.image |
启用 OpenAI 图像模型。 |
azure-openai |
spring.ai.azure.openai.image.options.n |
要生成的图像数量。必须在 1 到 10 之间。对于 dall-e-3,仅支持 n=1。 |
- |
spring.ai.azure.openai.image.options.model |
用于图像生成的模型。 |
AzureOpenAiImageOptions.DEFAULT_IMAGE_MODEL |
spring.ai.azure.openai.image.options.quality |
将生成的图像质量。HD 创建具有更精细细节和更高一致性的图像。此参数仅支持 dall-e-3。 |
- |
spring.ai.azure.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 或 natural 之一。Vivid 使模型倾向于生成超现实和戏剧性的图像。Natural 使模型生成更自然、不那么超现实的图像。此参数仅支持 dall-e-3。 |
- |
|
代表您的最终用户的唯一标识符,可以帮助 Azure OpenAI 监控和检测滥用。 |
- |
运行时选项
OpenAiImageOptions.java 提供模型配置,例如要使用的模型、质量、尺寸等。
在启动时,可以通过 AzureOpenAiImageModel(OpenAiImageApi openAiImageApi)
构造函数和 withDefaultOptions(OpenAiImageOptions defaultOptions)
方法配置默认选项。或者,使用前面描述的 spring.ai.azure.openai.image.options.*
属性。
在运行时,您可以通过向 ImagePrompt
调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要覆盖 OpenAI 特定选项,如质量和要创建的图像数量,请使用以下代码示例:
ImageResponse response = azureOpenaiImageModel.call(
new ImagePrompt("A light cream colored mini golden doodle",
OpenAiImageOptions.builder()
.quality("hd")
.N(4)
.height(1024)
.width(1024).build())
);
提示:除了模型特定的 AzureOpenAiImageOptions 之外,您还可以使用可移植的 ImageOptions 实例,该实例使用 ImageOptionsBuilder#builder() 创建。