Spring AI学习笔记四十六:图像模型之Azure OpenAI

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

前提条件

从Azure门户的Azure OpenAI服务部分获取您的Azure OpenAI端点和API密钥。

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

1. spring.ai.azure.openai.api-key：请将此项设置为从Azure获取的API密钥的值。

2. 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密钥等敏感信息时增强安全性，您可以使用Spring表达式语言（SpEL）来引用自定义环境变量：

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

# In your environment or .env fileexport 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 variablesString apiKey = System.getenv("AZURE_OPENAI_API_KEY");String endpoint = System.getenv("AZURE_OPENAI_ENDPOINT");

部署名称

要使用Azure AI应用程序，请通过[Azure AI门户](oai.azure.com/portal)创建一个Azure AI部署。

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

必须明白，部署名称与你选择部署的模型是不同的

例如，可以将名为“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中，没有部署名称，只有模型名称。

添加仓库和物料清单

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

为了辅助依赖管理，Spring AI 提供了一个物料清单 (BOM)，以确保整个项目中使用的是一致版本的 Spring AI。请参阅“依赖管理”部分，将 Spring AI BOM 添加到您的构建系统中。

自动配置

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

要启用，请设置 spring.ai.model.image=azure-openai（默认情况下已启用）

要禁用，请将 spring.ai.model.image 设置为 none（或任何与 azure-openai 不匹配的值）

前缀“spring.ai.openai.image”是属性前缀，用于配置OpenAI的ImageModel实现。

连接属性

前缀“spring.ai.openai”用作属性前缀，以便您连接到Azure OpenAI。

运行时选项

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()));