Azure OpenAI 嵌入

Azure的OpenAI扩展了OpenAI的功能，为多种任务提供了安全的文本生成和嵌入计算模型：spring-doc.cadn.net.cn

Azure OpenAI嵌入依赖于cosine similarity来计算文档与查询之间的相似度。spring-doc.cadn.net.cn

前提条件

Azure OpenAI 客户端提供了三种连接选项：使用 Azure API 密钥、使用 OpenAI API 密钥，或使用 Microsoft Entra ID。spring-doc.cadn.net.cn

Azure API 密钥和终结点

在Azure门户的“Azure OpenAI服务”部分获取您的Azure OpenAI endpoint 和 api-key 。spring-doc.cadn.net.cn

Spring AI 定义了两个配置属性：spring-doc.cadn.net.cn

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

  2. spring.ai.azure.openai.endpoint：将其设置为您在 Azure 中配置模型时获取的终结点 URL。spring-doc.cadn.net.cn

您可以在您的 application.properties 或 application.yml 文件中设置这些配置属性：spring-doc.cadn.net.cn

spring.ai.azure.openai.api-key=<your-azure-api-key>
spring.ai.azure.openai.endpoint=<your-azure-endpoint-url>

如果倾向于使用环境变量来存储API密钥等敏感信息，您可以在配置中使用Spring表达式语言（SpEL）：spring-doc.cadn.net.cn

# 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 密钥

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

使用此方法时，将 spring.ai.azure.openai.chat.options.deployment-name 属性设置为您要使用的 OpenAI 模型 的名称。spring-doc.cadn.net.cn

在您的应用程序配置中：spring-doc.cadn.net.cn

spring.ai.azure.openai.openai-api-key=<your-azure-openai-key>
spring.ai.azure.openai.chat.options.deployment-name=<openai-model-name>

使用环境变量与 SpEL：spring-doc.cadn.net.cn

# 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 属性。spring-doc.cadn.net.cn

仅找到端点属性时，您的应用程序将评估多种不同的选项来检索凭据，并将使用Tokens凭据创建一个 OpenAIClient 实例。spring-doc.cadn.net.cn

不再需要创建 TokenCredential bean；它会自动为您配置。

添加仓库和BOM

Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参阅 工件仓库 部分，以将这些仓库添加到您的构建系统。spring-doc.cadn.net.cn

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

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 Azure OpenAI 嵌入模型提供了 Spring Boot 自动配置。 要启用它，请在项目的 Maven pom.xml 文件中添加以下依赖项:spring-doc.cadn.net.cn

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

或者添加到您的Gradle 构建脚本文件中。spring-doc.cadn.net.cn

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

嵌入属性

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

属性 描述 默认

spring.ai.azure.openai.api-keyspring-doc.cadn.net.cn

Azure AI OpenAI 的密钥位于 Keys and Endpoint 部分下的 Resource Managementspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.azure.openai.endpointspring-doc.cadn.net.cn

Azure AI OpenAI 的端点位于 Keys and Endpoint 部分下，该部分属于 Resource Managementspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.azure.openai.openai-api-keyspring-doc.cadn.net.cn

（非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-doc.cadn.net.cn

-spring-doc.cadn.net.cn

启用和禁用嵌入式自动配置现在通过带有前缀 spring.ai.model.embedding 的顶级属性进行配置。spring-doc.cadn.net.cn

要启用，请设置 spring.ai.model.embedding=azure-openai （默认情况下已启用）spring-doc.cadn.net.cn

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

这种修改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.azure.openai.embedding 是配置Azure OpenAI EmbeddingModel 实现的属性前缀spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.azure.openai.embedding.enabled（已移除，不再有效）spring-doc.cadn.net.cn

启用Azure OpenAI嵌入模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.embeddingspring-doc.cadn.net.cn

启用Azure OpenAI嵌入模型。spring-doc.cadn.net.cn

azure-openaispring-doc.cadn.net.cn

spring.ai.azure.openai.embedding.metadata-modespring-doc.cadn.net.cn

文档内容提取模式spring-doc.cadn.net.cn

EMBEDspring-doc.cadn.net.cn

spring.ai.azure.openai.embedding.options.deployment-namespring-doc.cadn.net.cn

这是在Azure AI门户中显示的“部署名称”的值。spring-doc.cadn.net.cn

text-embedding-ada-002spring-doc.cadn.net.cn

spring.ai.azure.openai.embedding.options.userspring-doc.cadn.net.cn

操作的调用者或最终用户的标识符。此标识符可用于跟踪或限制速率目的。spring-doc.cadn.net.cn

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

运行时选项

数字AzureOpenAiEmbeddingOptions为嵌入请求提供了配置信息。 数字AzureOpenAiEmbeddingOptions提供了一个构建器来创建选项。spring-doc.cadn.net.cn

在开始时，使用AzureOpenAiEmbeddingModel构造函数设置所有嵌入请求使用的默认选项。在运行时，您可以通过向EmbeddingRequest请求传递带有您的AzureOpenAiEmbeddingOptions实例来覆盖默认选项。spring-doc.cadn.net.cn

例如，要为特定请求覆盖默认的模型名称：spring-doc.cadn.net.cn

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-doc.cadn.net.cn

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文件中:spring-doc.cadn.net.cn

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

或者添加到您的Gradle 构建脚本文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai'
}
参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。
数字spring-ai-azure-openai的依赖项也提供了访问AzureOpenAiEmbeddingModel的途径。有关AzureOpenAiChatModel的更多信息，请参阅Azure OpenAI嵌入部分。

接下来，创建一个AzureOpenAiEmbeddingModel实例，并使用它来计算两个输入文本之间的相似度：spring-doc.cadn.net.cn

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门户中展示的 Deployment Name。