Azure OpenAI 图像生成

Spring AI 支持 Azure OpenAI 的图像生成模型 DALL-E。spring-doc.cadn.net.cn

前提条件

获取你的Azure OpenAI端点API密钥来自Azure Portal的Azure OpenAI服务部分。spring-doc.cadn.net.cn

Spring AI 定义了两个配置属性:spring-doc.cadn.net.cn

  1. Spring.ai.Azure.Openai.API-Key:将此设为API 密钥摘自Azure。spring-doc.cadn.net.cn

  2. Spring.ai.azure.openai.endpoint:将此设置为在Azure中配置模型时获得的端点URL。spring-doc.cadn.net.cn

你可以在你的application.properties文件:spring-doc.cadn.net.cn

spring.ai.azure.openai.api-key=<your-azure-openai-api-key>
spring.ai.azure.openai.endpoint=<your-azure-openai-endpoint>

为了在处理敏感信息如 API 密钥时增强安全性,可以使用 Spring 表达式语言(SpEL)来引用自定义环境变量:spring-doc.cadn.net.cn

# 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>

你也可以在应用代码中编程设置这些配置:spring-doc.cadn.net.cn

// 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 门户](oai.azure.com/portal)创建一个 Azure AI 部署。spring-doc.cadn.net.cn

在Azure中,每个客户端必须指定一个部署名称连接 Azure OpenAI 服务。spring-doc.cadn.net.cn

必须明白部署名称与你选择部署的模式不同spring-doc.cadn.net.cn

例如,名为“MyImgAiDeployment”的部署可以配置为使用达勒3模型或达勒2型。spring-doc.cadn.net.cn

目前为了简化作,您可以使用以下设置创建部署:spring-doc.cadn.net.cn

部署名称:MyImgAi部署型号名称:达勒3spring-doc.cadn.net.cn

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

如果你使用了不同的部署名称,请相应地更新配置属性:spring-doc.cadn.net.cn

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

Azure OpenAI 和 OpenAI 的不同部署结构导致 Azure OpenAI 客户端库中有一个属性,名为deploymentOrModelName. 这是因为在OpenAI中没有部署名称,仅为a型号名称.spring-doc.cadn.net.cn

添加仓库和物料清单

Spring AI 产物发布于 Maven Central 和 Spring Snapshot 仓库中。 请参阅神器仓库部分,将这些仓库添加到你的构建系统中。spring-doc.cadn.net.cn

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

自动配置

春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明spring-doc.cadn.net.cn

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

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

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-azure-openai'
}
请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。

图像生成属性

启用和禁用图像自动配置现在通过顶层属性配置,前缀为spring.ai.model.image.spring-doc.cadn.net.cn

启用时,spring.ai.model.image=azure-openai(默认启用)spring-doc.cadn.net.cn

要禁用,可以选择 spring.ai.model.image=none(或任何不匹配 azure-openai 的值)spring-doc.cadn.net.cn

此改动旨在允许配置多个模型。spring-doc.cadn.net.cn

前缀spring.ai.openai.image是允许您配置图像模型OpenAI的实现。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

spring.ai.azure.openai.image.enabled(已移除且不再有效)spring-doc.cadn.net.cn

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

truespring-doc.cadn.net.cn

spring.ai.model.imagespring-doc.cadn.net.cn

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

azure-openaispring-doc.cadn.net.cn

Spring.ai.azure.openai.image.options.nspring-doc.cadn.net.cn

需要生成的图片数量。必须在1到10之间。对于 dall-e-3,仅支持 n=1。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

Spring.ai.azure.openai.image.options.modelspring-doc.cadn.net.cn

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

AzureOpenAiImageOptions.DEFAULT_IMAGE_MODELspring-doc.cadn.net.cn

Spring.ai.azure.openai.image.options.qualityspring-doc.cadn.net.cn

生成图像的质量。高清能创造出细节更细腻、图像更一致的图像。该参数仅支持DALL-E-3。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

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

-spring-doc.cadn.net.cn

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

生成图像的大小。DALL-E-2必须是256x256、512x512或1024x1024之一。必须是1024x1024、1792x1024或1024x1792中的一种,适用于Dall-E-3型号。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

生成图像的宽度。必须是256、512或1024中的一个,才能达到达尔-e-2。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

生成图像的高度。必须是256、512或1024中的一个,才能达到达尔-e-2。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

生成图像的风格。必须是生动或自然的。Vivid使模型倾向于生成超真实且戏剧性的图像。自然会让模型产生更自然、不那么超现实的图像。该参数仅支持DALL-E-3。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

一个代表终端用户的唯一标识符,可以帮助Azure OpenAI监控和检测滥用行为。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

连接性质

前缀春.ai.openai作为属性前缀,允许你连接到Azure OpenAI。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

Spring.ai.azure.openai.endpointspring-doc.cadn.net.cn

连接的URL(链接)spring-doc.cadn.net.cn

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

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

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

运行时选项

OpenAiImageOptions.java提供模型配置,如使用模型、质量、尺寸等。spring-doc.cadn.net.cn

启动时,默认选项可以配置为AzureOpenAiImageModel(OpenAiImageApi openAiImageApi)构造者和withDefaultOptions(OpenAiImageOptions defaultOptions)方法。或者,可以使用Spring.ai.azure.openai.image.options.*上述性质。spring-doc.cadn.net.cn

运行时,你可以通过添加新的、针对请求的选项来覆盖默认选项图片提示叫。 例如,要覆盖OpenAI特有的选项,如质量和需创建的图片数量,请使用以下代码示例:spring-doc.cadn.net.cn

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