跳到主要内容

Azure OpenAI 嵌入

DeepSeek V3 中英对照 Azure OpenAI Azure OpenAI Embeddings

Azure 的 OpenAI 扩展了 OpenAI 的能力，提供了安全的文本生成和 Embeddings 计算模型，适用于各种任务：

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

  • 文本搜索嵌入（Text search embeddings）有助于衡量长文档是否与短查询相关。

  • 代码搜索嵌入（Code search embeddings）对于嵌入代码片段和嵌入自然语言搜索查询非常有用。

Azure OpenAI 嵌入依赖 cosine similarity（余弦相似度）来计算文档与查询之间的相似度。

先决条件​

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

Azure API 密钥与终结点​

从 Azure Portal 的 Azure OpenAI 服务部分获取你的 Azure OpenAI endpoint 和 api-key。

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>
shell

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>
shell

Microsoft Entra ID​

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

添加仓库和 BOM​

Spring AI 构件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 Repositories 部分将这些仓库添加到你的构建系统中。

为了帮助进行依赖管理，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>
xml

或添加到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}
groovy
提示

请参考 依赖管理 部分，将 Spring AI BOM 添加到你的构建文件中。

嵌入属性​

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

属性描述默认值
spring.ai.azure.openai.api-keyAzure AI OpenAI 的密钥，位于 资源管理 下的 密钥和终结点 部分-
spring.ai.azure.openai.endpointAzure 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 构造函数来设置用于所有嵌入请求的默认选项。在运行时，你可以通过在 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()));
java

示例代码​

这将创建一个 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
application.properties
@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);
    }
}
java

手动配置​

如果你不希望使用 Spring Boot 的自动配置，你可以在应用程序中手动配置 AzureOpenAiEmbeddingModel。为此，请将 spring-ai-azure-openai 依赖添加到你的项目的 Maven pom.xml 文件中：

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

或者到你的 Gradle build.gradle 构建文件中。

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

:::提示
请参考依赖管理部分，将 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"));
java
备注

text-embedding-ada-002 实际上是 Azure AI 门户中显示的 Deployment Name。