Azure OpenAI

Azure OpenAI 图像生成

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

前提条件（Prerequisites）

Azure OpenAI 客户端提供三种连接选项：使用 Azure API 密钥、使用 OpenAI API 密钥 或 使用 Microsoft Entra ID 。

Azure API Key & EndpointAzure API

若要使用 API 密钥访问模型，请从 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。

可以在 application.properties 或 application.yml 文件中设置这些配置属性：

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

为了提高处理 API 密钥等敏感信息时的安全性，可以使用 Spring 表达式语言 (SpEL) 来引用自定义环境变量：

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

OpenAI 密钥

要使用 OpenAI 服务 (而不是 Azure) 进行身份验证，请提供一个 OpenAI API 密钥。这将自动将端点设置为 api.openai.com/v1 。

使用这种方法时，将spring.ai.azure.openai.chat.options.deployment-name 属性设置为要使用的 OpenAI 模型的名称。

spring.ai.azure.openai.openai-api-key=<your-azure-openai-key>
spring.ai.azure.openai.chat.options.deployment-name=<openai-model-name>

在 SpEL 中使用环境变量：

# In application.yml
spring:
  ai:
    azure:
      openai:
        openai-api-key: ${AZURE_OPENAI_API_KEY}
        chat:
          options:
            deployment-name: ${AZURE_OPENAI_MODEL_NAME}

# In your environment or .env file
export AZURE_OPENAI_API_KEY=<your-openai-key>
export AZURE_OPENAI_MODEL_NAME=<openai-model-name>

Microsoft Entra ID

对于使用 Microsoft Entra ID (以前称为 Azure Active Directory) 的无密钥身份验证，请仅设置 spring.ai.azure.openai.endpoint 配置属性，而不要设置上述 api-key 属性。

只找到 endpoint 属性，应用程序将评估几个不同的凭据检索选项，并使用令牌凭据创建 OpenAIClient 实例。

添加存储库和 BOM

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

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

自动配置（Auto-configuration）

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'
}

图像生成属性（Image Generation Properties）

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

连接属性（Connection Properties）

前缀是 spring.ai.azure.openai 的属性，用于配置 Azure OpenAI 的 链接。

运行时选项（Runtime Options ）

OpenAiImageOptions.java 提供了模型配置，例如使用的 model 、quality 、size 等。。

在启动时，默认选项可以通过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())

);