跳到主要内容

Azure OpenAI 嵌入技术

Deepseek 3.2 中英对照 Azure OpenAI Azure OpenAI Embeddings

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

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

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

  • 代码搜索嵌入对于嵌入代码片段以及嵌入自然语言搜索查询非常有用。

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

前置条件​

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 Key 的值。

  2. spring.ai.azure.openai.endpoint：将此设置为在 Azure 中配置模型时获得的端点 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-endpoint-url>

OpenAI Key​

如需通过 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: ${OPENAI_MODEL_NAME}
# In your environment or .env file
export AZURE_OPENAI_API_KEY=<your-openai-key>
export OPENAI_MODEL_NAME=<openai-model-name>

Microsoft Entra ID​

对于使用 Microsoft Entra ID（原 Azure Active Directory）进行无密钥身份验证，请仅设置 spring.ai.azure.openai.endpoint 配置属性，而不要设置上述提到的 api-key 属性。

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

备注

无需再创建 TokenCredential Bean；它会自动为您配置。

添加仓库和物料清单（BOM）​

Spring AI 工件已发布至 Maven Central 与 Spring Snapshot 仓库。请参考工件仓库章节，将这些仓库添加至您的构建系统。

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

自动配置​

备注

Spring AI 的自动配置和 starter 模块的构件名称发生了重大变化。更多信息请参阅 升级说明。

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

请参考 依赖管理 部分，将 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.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 嵌入模型。true
spring.ai.model.embedding启用 Azure OpenAI 嵌入模型。azure-openai
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()));

示例代码​

这将创建一个 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 嵌入 章节。

接下来，创建一个 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 门户中显示的部署名称。