Azure OpenAI 图像生成

本站(springdoc.cn)中的内容来源于 spring.io ，原始版权归属于 spring.io。由 springdoc.cn 进行翻译，整理。可供个人学习、研究，未经许可，不得进行任何转载、商用或与之相关的行为。商标声明：Spring 是 Pivotal Software, Inc. 在美国以及其他国家的商标。

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

先决条件

从 Azure 门户上的 Azure OpenAI 服务部分获取 Azure OpenAI endpoint 和 api-key。

Spring AI 定义了两个配置属性：

spring.ai.azure.openai.api-key：将其设置为从 Azure 获取的 API 密钥的值。
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 Key 等敏感信息时，为了增强安全性，可以使用 Spring 表达式语言（SpEL）引用自定义环境变量：

# In application.yml
spring:
  ai:
    azure:
      openai:
        api-key: ${AZURE_OPENAI_API_KEY}
        endpoint: ${AZURE_OPENAI_ENDPOINT}

# In your environment or .env file
export AZURE_OPENAI_API_KEY=<your-azure-openai-api-key>
export AZURE_OPENAI_ENDPOINT=<your-azure-openai-endpoint>

你也可以在应用代码中以编程方式设置这些配置：

// Retrieve API key and endpoint from secure sources or environment variables
String apiKey = System.getenv("AZURE_OPENAI_API_KEY");
String endpoint = System.getenv("AZURE_OPENAI_ENDPOINT");

部署名称

要运行 Azure AI 应用程序，需通过 Azure AI 门户创建一个 Azure AI 部署（Deployment）。

在 Azure 中，每个客户端必须指定一个 Deployment Name（部署名称）才能连接到 Azure OpenAI 服务。

需要明确的是，Deployment Name 与你选择部署的模型是不同的概念。

例如，一个名为 'MyImgAiDeployment' 的部署可以配置为使用 Dalle3 模型或 Dalle2 模型。

目前，为了保持简单明了，你可以使用以下设置创建一个部署：

Deployment Name: MyImgAiDeployment
Model Name: Dalle3

此 Azure 配置将与 Spring Boot Azure AI Starter 及其自动配置功能的默认配置保持一致。

如果你使用了不同的部署名称（Deployment Name），请相应地更新配置属性：

spring.ai.azure.openai.image.options.deployment-name=<my deployment name>

Azure OpenAI 和 OpenAI 的部署结构不同，因此 Azure OpenAI 客户端库中有一个名为 deploymentOrModelName 的属性。这是因为在 OpenAI 中没有部署名称（Deployment Name），只有模型名称（Model Name）。

添加仓库和 BOM

Spring AI 构件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 “Artifact 仓库” 部分将这些仓库添加到你的构建系统中。

为帮助管理依赖项，Spring AI 提供了 BOM（物料清单）以确保整个项目中使用统一版本的 Spring AI。请参考 “依赖管理” 部分将 Spring AI BOM 添加到你的构建系统中。

自动配置

Spring AI 自动配置及 starter 模块的 artifact 名称已发生重大变更。更多信息请参阅升级说明。

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 的顶级属性进行配置。

启用：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 之一。

spring.ai.openai.image.options.size

生成的图像尺寸。对于 dall-e-2 ，必须是 256x256 、 512x512 或 1024x1024 之一。对于 dall-e-3 model ，必须是 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

一个代表最终用户的唯一标识符，可帮助 Azure OpenAI 监控和检测滥用行为。

连接配置

spring.ai.openai 是用于连接 Azure OpenAI 的属性前缀。

属性

说明

默认值

spring.ai.azure.openai.endpoint

要连接到的 URL

my-dalle3.openai.azure.com/

spring.ai.azure.openai.apiKey

API Key

运行时配置

OpenAiImageOptions.java 提供模型配置参数，包括要使用的模型、质量（quality）、尺寸（size）等。

在启动时，可通过以下两种方式配置默认选项：

使用 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() 创建。