Azure OpenAI 图像生成

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

先决条件

从 Azure 门户的 Azure OpenAI 服务部分获取您的 Azure OpenAI endpoint 和 api-key。Spring AI 定义了一个名为 spring.ai.azure.openai.api-key 的配置属性，您应将其设置为从 Azure 获取的 API Key 值。还有一个名为 spring.ai.azure.openai.endpoint 的配置属性，您应将其设置为在 Azure 中配置模型时获得的 endpoint URL。导出环境变量是设置这些配置属性的一种方法

export SPRING_AI_AZURE_OPENAI_API_KEY=<INSERT KEY HERE>
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<INSERT ENDPOINT URL HERE>

部署名称

要运行 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。

添加仓库和 BOM

Spring AI 构建产物发布在 Maven Central 和 Spring Snapshot 仓库中。请参阅仓库部分，了解如何将这些仓库添加到您的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了一个 BOM（物料清单），以确保整个项目中使用一致的 Spring AI 版本。请参阅依赖管理部分，了解如何将 Spring AI BOM 添加到您的构建系统中。

自动配置

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

要启用，设置 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 模型，必须是 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 密钥

运行时选项

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