Azure OpenAI 嵌入

Azure 的 OpenAI 扩展了 OpenAI 的能力，为各种任务提供了安全的文本生成和嵌入计算模型。

  • 相似度嵌入擅长捕获两段或多段文本之间的语义相似性。

  • 文本搜索嵌入有助于衡量长文档与短查询的相关性。

  • 代码搜索嵌入可用于嵌入代码片段和自然语言搜索查询。

Azure OpenAI 嵌入依赖于 余弦相似度 来计算文档与查询之间的相似性。

先决条件

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

Azure API 密钥和端点

从 Azure Portal 上的 Azure OpenAI Service 部分获取你的 Azure OpenAI endpoint（端点）和 api-key（API 密钥）。

Spring AI 定义了两个配置属性

  1. spring.ai.azure.openai.api-key：将其设置为从 Azure 获取的 API Key 的值。

  2. spring.ai.azure.openai.endpoint：将其设置为在 Azure 中预配模型时获得的端点 URL。

你可以通过导出环境变量来设置这些配置属性

export SPRING_AI_AZURE_OPENAI_API_KEY=<INSERT AZURE KEY HERE>
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<INSERT ENDPOINT URL HERE>

OpenAI 密钥

要使用 OpenAI 服务（非 Azure）进行身份验证，请提供 OpenAI API 密钥。这将自动把端点设置为 api.openai.com/v1。

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

export SPRING_AI_AZURE_OPENAI_OPENAI_API_KEY=<INSERT OPENAI KEY HERE>

Microsoft Entra ID

要使用 Microsoft Entra ID（以前称为 Azure Active Directory）进行身份验证，请在你的配置中创建一个 TokenCredential bean。如果此 bean 可用，则将使用令牌凭据创建一个 OpenAIClient 实例。

添加仓库和 BOM

Spring AI 的构建产物发布在 Maven Central 和 Spring Snapshot 仓库中。请参阅仓库部分，了解如何将这些仓库添加到你的构建系统中。

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

自动配置

Spring AI 自动配置、Starter 模块的构建产物名称发生了重大变化。更多信息请参阅升级说明。

Spring AI 为 Azure OpenAI Embedding 模型提供了 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 BOM 添加到你的构建文件中。

Embedding 属性

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

属性 描述 默认值

spring.ai.azure.openai.api-key

来自 Azure AI OpenAI 资源管理下 密钥和端点 部分的密钥

-

spring.ai.azure.openai.endpoint

来自 Azure AI OpenAI 资源管理下 密钥和端点 部分的端点

-

spring.ai.azure.openai.openai-api-key

(非 Azure) OpenAI API 密钥。用于与 OpenAI 服务进行身份验证，而不是 Azure OpenAI。这会自动将端点设置为 api.openai.com/v1。请使用 api-key 或 openai-api-key 属性中的一个。在此配置下，spring.ai.azure.openai.embedding.options.deployment-name 被视为 OpenAI 模型 名称。

-

Embedding 自动配置的启用和禁用现在通过以 spring.ai.model.embedding 为前缀的顶层属性进行配置。

要启用，设置 spring.ai.model.embedding=azure-openai（默认已启用）

要禁用，设置 spring.ai.model.embedding=none（或任何不匹配 azure-openai 的值）

进行此更改是为了允许配置多个模型。

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

属性 描述 默认值

spring.ai.azure.openai.embedding.enabled (已移除，不再有效)

启用 Azure OpenAI embedding 模型。

true

spring.ai.model.embedding

启用 Azure OpenAI embedding 模型。

azure-openai

spring.ai.azure.openai.embedding.metadata-mode

文档内容提取模式

EMBED

spring.ai.azure.openai.embedding.options.deployment-name

这是 Azure AI Portal 中显示的“部署名称”的值。

text-embedding-ada-002

spring.ai.azure.openai.embedding.options.user

操作调用方或最终用户的标识符。可用于跟踪或速率限制目的。

-
所有以 spring.ai.azure.openai.embedding.options 为前缀的属性都可以在运行时通过向 EmbeddingRequest 调用添加特定于请求的运行时选项来覆盖。

运行时选项

AzureOpenAiEmbeddingOptions 提供 embedding 请求的配置信息。AzureOpenAiEmbeddingOptions 提供一个构建器来创建选项。

启动时使用 AzureOpenAiEmbeddingModel 构造函数设置所有 embedding 请求使用的默认选项。运行时，你可以通过将包含你的 AzureOpenAiEmbeddingOptions 实例传递给 EmbeddingRequest 请求来覆盖默认选项。

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

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

示例代码

这将创建一个 EmbeddingModel 实现，你可以将其注入到你的类中。这是一个使用 EmbeddingModel 实现的简单 @Controller 类的示例。

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
@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

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

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果你不想使用 Spring Boot 自动配置，可以在你的应用程序中手动配置 AzureOpenAiEmbeddingModel。为此，请将 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'
}
请参阅依赖管理部分，了解如何将 Spring AI BOM 添加到你的构建文件中。
spring-ai-azure-openai 依赖项还提供了访问 AzureOpenAiEmbeddingModel 的能力。有关 AzureOpenAiChatModel 的更多信息，请参阅Azure OpenAI Embeddings 部分。

接下来，创建一个 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"));
text-embedding-ada-002 实际上是 Azure AI Portal 中显示的 部署名称。