Azure OpenAI Embeddings

Azure 的 OpenAI 扩展了 OpenAI 的功能，为多种任务提供安全的文本生成及嵌入计算模型：

• 相似性嵌入擅长捕捉两段或多段文本之间的语义相似性。
• 文本搜索嵌入有助于衡量长篇文档是否与简短查询相关。
• 代码搜索嵌入适用于将代码片段和自然语言搜索查询进行嵌入。

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

嵌入属性（Embedding Properties）

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

spring.ai.azure.openai.embedding 是用于配置 Azure OpenAI 的 EmbeddingModel 实现的属性前缀。

运行时选项（Runtime Options ）

AzureOpenAiEmbeddingOptions 提供了嵌入请求的配置信息，并提供了一个构建器来创建这些选项。

启动时，默认选项可以通过 AzureOpenAiEmbeddingModel 构造函数来设置所有嵌入请求默认使用的选项。

在运行时，你可以通过向 EmbeddingRequest 请求传递一个 AzureOpenAiEmbeddingOptions 实例来覆盖这些默认选项。

例如，要为特定请求覆盖默认模型名称：

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        AzureOpenAiEmbeddingOptions.builder()
        .model("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器（Sample Controller）

创建一个新的 Spring Boot 项目，并将 spring-ai-starter-model-azure-openai 添加到 pom (或 gradle) 依赖项中。

在 src/main/resources 目录下添加 application.properties 文件，以启用和配置 Titan Embedding 模型：

spring.ai.azure.openai.api-key=YOUR_API_KEY
spring.ai.azure.openai.endpoint=YOUR_ENDPOINT
spring.ai.azure.openai.embedding.options.model=text-embedding-ada-002

这将创建一个 AzureOpenAiEmbeddingModel 的实现，你可以将其注入到你的类中。下面是一个简单的 @Controller 类的示例，它使用聊天模型进行文本生成。

@RestController
public class EmbeddingController {

    private final AzureOpenAiEmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(AzureOpenAiEmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

    @GetMapping("/v1/embedding")
    public Map embedding(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("embeddings", embeddingModel.embed(message));
    }

}

手动配置（Manual Configuration）

AzureOpenAiEmbeddingModel 实现了 EmbeddingModel , 并使用轻量级 AzureOpenAi 客户端连接到 Azure OpenAI 服务。

要启用它，添加 spring-ai-azure-openai 依赖到你的项目 Maven pom.xml 文件:

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

或者，在你的 Gradle 构建文件 build.gradle 中添加：

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

接下来，创建一个 AzureOpenAiEmbeddingModel 并将其用于文本嵌入：

 var openAIClient = OpenAIClientBuilder()
        .credential(new AzureKeyCredential(System.getenv("AZURE_OPENAI_API_KEY")))
        .endpoint(System.getenv("AZURE_OPENAI_ENDPOINT"))
        .buildClient();

var embeddingModel = new AzureOpenAiEmbeddingModel(this.openAIClient)
    .withDefaultOptions(AzureOpenAiEmbeddingOptions.builder()
        .model("text-embedding-ada-002")
        .user("user-6")
        .build());

EmbeddingResponse embeddingResponse = this.embeddingModel
    .embedForResponse(List.of("Hello World", "World is big and salvation is near"));