Azure OpenAI 映像生成

Spring AI 支持 DALL-E,这是 Azure OpenAI 中的图像生成模型。spring-doc.cn

先决条件

获取 Azure OpenAI 并从 Azure 门户上的 Azure OpenAI 服务部分获取。 Spring AI 定义了一个名为 的配置属性,您应该将其设置为从 Azure 获取的值。 还有一个名为 的配置属性,您应该将其设置为在 Azure 中预置模型时获取的终端节点 URL。 导出环境变量是设置这些配置属性的一种方法:endpointapi-keyspring.ai.azure.openai.api-keyAPI Keyspring.ai.azure.openai.endpointspring-doc.cn

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 部署。spring-doc.cn

在 Azure 中,每个客户端都必须指定 a 才能连接到 Azure OpenAI 服务。Deployment Namespring-doc.cn

必须了解 与您选择部署的模型不同Deployment Namespring-doc.cn

例如,可以将名为“MyImgAiDeployment”的部署配置为使用模型或模型。Dalle3Dalle2spring-doc.cn

现在,为了简单起见,您可以使用以下设置创建部署:spring-doc.cn

部署名称:模型名称:MyImgAiDeploymentDalle3spring-doc.cn

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

如果你使用不同的 Deployment Name,请相应地更新 configuration 属性:spring-doc.cn

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

Azure OpenAI 和 OpenAI 的不同部署结构会导致 Azure OpenAI 客户端库中有一个名为 的属性。 这是因为在 OpenAI 中没有 ,只有一个 .deploymentOrModelNameDeployment NameModel Namespring-doc.cn

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅 Repositories 部分,将这些存储库添加到您的构建系统中。spring-doc.cn

为了帮助进行依赖项管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。spring-doc.cn

自动配置

Spring AI 为 Azure OpenAI 聊天客户端提供 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到项目的 Maven 文件中:pom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。

图像生成属性

前缀是允许您为 OpenAI 配置实施的属性前缀。spring.ai.openai.imageImageModelspring-doc.cn

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.azure.openai.image.enabledspring-doc.cn

启用 OpenAI 图像模型。spring-doc.cn

spring-doc.cn

spring.ai.azure.openai.image.options.nspring-doc.cn

要生成的图像数。必须介于 1 和 10 之间。对于 dall-e-3,仅支持 n=1。spring-doc.cn

-spring-doc.cn

spring.ai.azure.openai.image.options.modelspring-doc.cn

用于图像生成的模型。spring-doc.cn

AzureOpenAiImageOptions.DEFAULT_IMAGE_MODELspring-doc.cn

spring.ai.azure.openai.image.options.qualityspring-doc.cn

将生成的图像质量。HD 创建的图像具有更精细的细节和更高的图像一致性。此参数仅支持 dall-e-3。spring-doc.cn

-spring-doc.cn

spring.ai.azure.openai.image.options.response_formatspring-doc.cn

返回生成图像的格式。必须是 URL 或 b64_json 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.sizespring-doc.cn

生成的图像的大小。对于 dall-e-2,必须是 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 型号,必须是 1024x1024、1792x1024 或 1024x1792 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.size_widthspring-doc.cn

生成的图像的宽度。必须是 dall-e-2 的 256、512 或 1024 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.size_heightspring-doc.cn

生成图像的高度。必须是 dall-e-2 的 256、512 或 1024 之一。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.stylespring-doc.cn

生成的图像的样式。必须是生动或自然的。Vivid 使模型倾向于生成超真实和戏剧性的图像。自然 使模型生成更自然、外观更不真实的图像。此参数仅支持 dall-e-3。spring-doc.cn

-spring-doc.cn

spring.ai.openai.image.options.userspring-doc.cn

代表最终用户的唯一标识符,可帮助 Azure OpenAI 监视和检测滥用情况。spring-doc.cn

-spring-doc.cn

连接属性

该前缀用作用于连接到 Azure OpenAI 的属性前缀。spring.ai.openaispring-doc.cn

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.azure.openai.endpointspring-doc.cn

要连接到的 URLspring-doc.cn

my-dalle3.openai.azure.com/spring-doc.cn

spring.ai.azure.openai.apiKeyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

运行时选项

OpenAiImageOptions.java 提供模型配置,例如要使用的模型、质量、大小等。spring-doc.cn

启动时,可以使用 constructor 和 method 配置默认选项。或者,使用前面描述的属性。AzureOpenAiImageModel(OpenAiImageApi openAiImageApi)withDefaultOptions(OpenAiImageOptions defaultOptions)spring.ai.azure.openai.image.options.*spring-doc.cn

在运行时,您可以通过向调用添加新的、特定于请求的选项来覆盖默认选项。 例如,要覆盖 OpenAI 特定选项(例如质量和要创建的图像数量),请使用以下代码示例:ImagePromptspring-doc.cn

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