Azure OpenAI 图像生成

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

先决条件

从 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。导出环境变量是设置这些配置属性的一种方法

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 中，每个客户端必须指定一个 部署名称 来连接到 Azure OpenAI 服务。

重要的是要了解 部署名称 与您选择部署的模型不同

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

目前，为了简化操作，您可以使用以下设置创建部署。

部署名称：MyImgAiDeployment 模型名称：Dalle3

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

如果您使用不同的部署名称，请相应地更新配置属性。

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

Azure OpenAI 和 OpenAI 不同的部署结构导致 Azure OpenAI 客户端库中出现一个名为 deploymentOrModelName 的属性。这是因为在 OpenAI 中没有 部署名称，只有 模型名称。

添加存储库和 BOM

Spring AI 工件发布在 Spring 里程碑和快照存储库中。请参考存储库部分，将这些存储库添加到您的构建系统中。

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

自动配置

Spring AI 为 Azure OpenAI Chat 客户端提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 文件中

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

或您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}

请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

图像生成属性

前缀 spring.ai.openai.image 是允许您配置 OpenAI 的 ImageModel 实现的属性前缀。

属性

描述

默认值

spring.ai.azure.openai.image.enabled

启用 OpenAI 图像模型。

true

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()
                .withQuality("hd")
                .withN(4)
                .withHeight(1024)
                .withWidth(1024).build())

);

除了特定于模型的 AzureOpenAiImageOptions 之外，您还可以使用可移植的 ImageOptions 实例，使用 ImageOptionsBuilder#builder() 创建。