Azure OpenAI Embeddings

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

• 相似性嵌入擅长捕获两个或多个文本之间的语义相似性。
• 文本搜索嵌入有助于衡量长文档是否与短查询相关。
• 代码搜索嵌入对于嵌入代码片段和嵌入自然语言搜索查询非常有用。

Azure OpenAI 嵌入依赖于 cosine similarity 计算文档和查询之间的相似性。

先决条件

从 Azure 门户 上的 Azure OpenAI 服务 获取你的 Azure OpenAI endpoint 和 api-key 。

Spring AI 定义了一个名为 spring.ai.azure.openai.api-key 的配置属性，您应该将其设置为从 Azure 获取的值。还有一个名为spring.ai.azure.openai.endpoint 的配置属性，您应将其设置为在 Azure 中预配模型时获取的 Endpoint URL。

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

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

添加存储库和 BOM

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

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

自动配置

Spring AI 为 Azure OpenAI Embedding Client 提供 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'
}

Embedding 属性

spring.ai.azure.openai 前缀的属性，可让您配置 Azure OpenAI 客户端的连接。

spring.ai.azure.openai.embeddings 前缀的属性，可让您配置 Azure OpenAI 的 EmbeddingClient 实现。

提示: 通过向 EmbeddingRequest 调用添加请求特定的嵌入选项，可以在运行时覆盖所有 spring.ai.azure.openai.embedding.options 前缀的属性。

Embedding 选项

• 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()));

示例代码

在 src/main/resources目录下添加一个application.properties文件，以启用和配置 Azure OpenAI 客户端：

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

提示: 替换api-key为您的 Azure OpenAI 凭据。

这将创建一个可以注入到您的类中的 EmbeddingClient 实现。下面是一个@Controller使用 EmbeddingClient 的简单示例。

@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);
    }
}

手动配置

如果您不使用 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'
}

接下来，创建一个 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实际上是Azure AI 门户中呈现的 Deployment Name 内容。