Azure OpenAI Embeddings

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

  • 相似度嵌入能够捕捉两个或多个文本之间的语义相似性。

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

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

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

先决条件

从Azure门户网站的Azure OpenAI服务部分获取Azure OpenAI的端点和api-key。

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

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

export SPRING_AI_AZURE_OPENAI_API_KEY=<在此处插入密钥>
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<在此处插入端点URL>

添加仓库和BOM

Spring AI的构件发布在Spring里程碑和快照仓库中。请参考仓库部分，将这些仓库添加到您的构建系统中。

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

## 自动配置 在Spring AI中，自动配置（Auto-configuration）模块负责根据项目中的依赖和已有的配置来自动配置Spring应用程序。自动配置功能旨在减少开发人员的配置负担，并提供一种快速启动Spring应用程序的方法。该模块使用条件化配置，根据项目中存在的类路径、bean等信息来确定需要配置哪些功能。 请提供需要翻译的 HTML 片段，我会帮您进行翻译并替换其中的英文为中文。

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'
}
请参考依赖管理部分向你的构建文件中添加Spring AI BOM。

嵌入属性

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

属性 描述 默认值

spring.ai.azure.openai.api-key

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

-

spring.ai.azure.openai.endpoint

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

-

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

属性 描述 默认值

spring.ai.azure.openai.embedding.enabled

启用Azure OpenAI嵌入客户端。

true

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 提供了一个生成选项的构建器。

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

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

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

示例代码

这将创建一个EmbeddingClient的实现，您可以将其注入到您的类中。以下是使用EmbeddingClient实现的简单@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 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依赖项添加到项目的Mavenpom.xml文件中：

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

或者添加到您的Gradlebuild.gradle构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-azure-openai'
}
参考“依赖管理”部分，将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实际上是Azure AI门户中显示的部署名称。