Azure OpenAI 嵌入

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

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

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

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

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

先决条件

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

Azure API 密钥和端点

从 Azure 门户 的 Azure OpenAI 服务部分获取您的 Azure OpenAI `endpoint` 和 `api-key`。

Spring AI 定义了两个配置属性

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

  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 工件发布在 Spring Milestone 和 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-azure-openai-spring-boot-starter</artifactId>
</dependency>

或您的 Gradle `build.gradle` 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}
请参考 依赖项管理 部分，将 Spring AI BOM 添加到您的构建文件中。

嵌入属性

前缀 `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 模型 名称。

-

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

属性 描述 默认值

spring.ai.azure.openai.embedding.enabled

启用 Azure OpenAI 嵌入模型。

true

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

文档内容提取模式

EMBED

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

这是 Azure AI 门户中显示的“部署名称”的值

text-embedding-ada-002

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

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

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

运行时选项

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

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

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

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        AzureOpenAiEmbeddingOptions.builder()
        .withModel("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()
        .withModel("text-embedding-ada-002")
        .withUser("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 门户中显示的部署名称。