Azure OpenAI Embeddings

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

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

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

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

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

Prerequisites

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

Spring AI 定义了一个名为 spring.ai.azure.openai.api-key 的配置属性，你应该将其设置为从 Azure 获得的 API Key 的值。还存在一个名为 spring.ai.azure.openai.endpoint 的配置属性，你应该将其设置为在 Azure 中配置模型时获得的端点 URL。

导出环境变量是一种设置这些配置属性的方法：

export SPRING_AI_AZURE_OPENAI_API_KEY=<INSERT KEY HERE>
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<INSERT ENDPOINT URL HERE>

Add Repositories and BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。有关将这些存储库添加到你的构建系统的说明，请参阅 Repositories 部分。

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

Auto-configuration

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

  1. 参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

Embedding Properties

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

Property Description Default

spring.ai.azure.openai.api-key

Azure AI OpenAI 下 Keys and Endpoint 部分中的密钥 Resource Management

-

spring.ai.azure.openai.endpoint

Azure AI OpenAI 下 Keys and Endpoint 部分中的端点 Resource Management

-

前缀 spring.ai.azure.openai.embeddings 是为 Azure OpenAI 配置 EmbeddingClient 实现的属性前缀

Property Description Default

spring.ai.azure.openai.embedding.enabled

启用 Azure OpenAI 嵌入客户端。

true

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

Document content extraction 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 调用添加特定于请求的 Embedding Options 来覆盖。

Embedding Options

AzureOpenAiEmbeddingOptions 提供嵌入请求的配置信息。AzureOpenAiEmbeddingOptions 提供一个生成该选项的构建器。

在启动时，使用 AzureOpenAiEmbeddingClient 构造函数设置用于所有嵌入请求的默认选项。在运行时，可以通过将 AzureOpenAiEmbeddingOptions 实例与你的 EmbeddingRequest 请求一起传递来覆盖默认选项。

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

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        AzureOpenAiEmbeddingOptions.builder()
        .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

Sample Code

这将创建一个 EmbeddingClient 实现，你可以将其注入到你的类中。这里有一个简单的 @Controller 类的示例，它使用 EmbeddingClient 实现。

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 EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

Manual Configuration

如果你不想使用 Spring Boot 自动配置，则可以手动在应用程序中配置 AzureOpenAiEmbeddingClient。为此，将 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'
}

  1. 参见 Dependency Management 部分，将 Spring AI BOM 添加到你的构建文件中。

spring-ai-azure-openai 依赖项还提供对 AzureOpenAiEmbeddingClient 的访问。有关 AzureOpenAiChatClient 的更多信息，请参阅 Azure OpenAI Embeddings 部分。

接下来，创建一个 AzureOpenAiEmbeddingClient 实例，并使用它来计算两个输入文本之间的相似度：

var openAIClient = OpenAIClientBuilder()
        .credential(new AzureKeyCredential(System.getenv("AZURE_OPENAI_API_KEY")))
		.endpoint(System.getenv("AZURE_OPENAI_ENDPOINT"))
		.buildClient();

var embeddingClient = new AzureOpenAiEmbeddingClient(openAIClient)
    .withDefaultOptions(AzureOpenAiEmbeddingOptions.builder()
        .withModel("text-embedding-ada-002")
        .withUser("user-6")
        .build());

EmbeddingResponse embeddingResponse = embeddingClient
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

text-embedding-ada-002 实际上是 Deployment Name，如 Azure AI Portal 中所示。