Azure OpenAI 嵌入

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

  • 相似性嵌入擅长捕获两个或多个文本之间的语义相似性。spring-doc.cn

  • 文本搜索嵌入有助于衡量长文档是否与短查询相关。spring-doc.cn

  • 代码搜索嵌入对于嵌入代码片段和嵌入自然语言搜索查询非常有用。spring-doc.cn

Azure OpenAI 嵌入依赖于计算文档和查询之间的相似性。cosine similarityspring-doc.cn

先决条件

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

Azure API 密钥和端点

获取 Azure OpenAI 并从 Azure 门户上的 Azure OpenAI 服务部分获取。endpointapi-keyspring-doc.cn

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

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

  2. spring.ai.azure.openai.endpoint：将此设置为在 Azure 中预置模型时获取的终端节点 URL。spring-doc.cn

您可以通过导出环境变量来设置这些配置属性：spring-doc.cn

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

使用此方法时，请将 property 设置为您要使用的 OpenAI 模型的名称。spring.ai.azure.openai.chat.options.deployment-namespring-doc.cn

export SPRING_AI_AZURE_OPENAI_OPENAI_API_KEY=<INSERT OPENAI KEY HERE>

Microsoft Entra ID

要使用 Microsoft Entra ID（以前称为 Azure Active Directory）进行身份验证，请在配置中创建一个 Bean。 如果此 Bean 可用，则将使用令牌凭证创建一个实例。TokenCredentialOpenAIClientspring-doc.cn

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。spring-doc.cn

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

自动配置

Spring AI 为 Azure OpenAI 嵌入模型提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 文件中：pom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

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

嵌入属性

prefix 是用于配置与 Azure OpenAI 的连接的属性前缀。spring.ai.azure.openaispring-doc.cn

财产 描述 违约

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

“来自 Azure AI OpenAI 的密钥”部分位于Keys and EndpointResource Managementspring-doc.cn

-spring-doc.cn

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

Azure AI OpenAI 部分下的终结点Keys and EndpointResource Managementspring-doc.cn

-spring-doc.cn

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

（非 Azure）OpenAI API 密钥。用于使用 OpenAI 服务进行身份验证，而不是使用 Azure OpenAI 进行身份验证。 这会自动将终端节点设置为 api.openai.com/v1。使用 or 属性。 使用此配置，它作为 OpenAi 模型名称受到威胁。api-keyopenai-api-keyspring.ai.azure.openai.embedding.options.deployment-namespring-doc.cn

-spring-doc.cn

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

财产 描述 违约

spring.ai.azure.openai.embedding.enabledspring-doc.cn

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

真spring-doc.cn

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

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

嵌入spring-doc.cn

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

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

文本嵌入 ADA 002spring-doc.cn

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

操作的调用方或最终用户的标识符。这可能用于跟踪或速率限制目的。spring-doc.cn

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

运行时选项

这提供了嵌入请求的配置信息。 这提供了一个构建器来创建选项。AzureOpenAiEmbeddingOptionsAzureOpenAiEmbeddingOptionsspring-doc.cn

在开始时，使用构造函数设置用于所有嵌入请求的默认选项。 在运行时，您可以通过将实例与 your 传递给请求来覆盖默认选项。AzureOpenAiEmbeddingModelAzureOpenAiEmbeddingOptionsEmbeddingRequestspring-doc.cn

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

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@ControllerEmbeddingModelspring-doc.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 自动配置，则可以在应用程序中手动配置。 为此，请将依赖项添加到项目的 Maven 文件中：AzureOpenAiEmbeddingModelspring-ai-azure-openaipom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。
依赖项还提供对 .有关更多信息，请参阅 Azure OpenAI 嵌入部分。spring-ai-azure-openaiAzureOpenAiEmbeddingModelAzureOpenAiChatModel

接下来，创建一个实例并使用它来计算两个输入文本之间的相似性：AzureOpenAiEmbeddingModelspring-doc.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()
        .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"));
实际上是 Azure AI 门户中显示的。text-embedding-ada-002Deployment Name