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

  • 相似性嵌入很擅长捕捉两段或更多文本之间的语义相似性。

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

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

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

先决条件

从链接：https://portal.azure.com[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>

添加仓库和BOM

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

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

自动配置

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'
}
Tip
 请参考依赖管理章节，以将Spring AI BOM添加到您的构建文件中。

嵌入属性

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

'''

属性

描述

默认值

spring.ai.azure.openai.api-key

来自 资源管理 下 Keys and Endpoint 部分的 Azure AI OpenAI 的密钥

-

spring.ai.azure.openai.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 Portal 中展示的“部署名称”的值

text-embedding-ada-002

spring.ai.azure.openai.embedding.options.user

操作的调用者或最终用户的标识符。这可能用于跟踪或限速目的。
Tip
 所有前缀为`spring.ai.azure.openai.embedding.options`的属性可以在运行时被覆盖，通过在`EmbeddingRequest`调用中添加一个特定请求的[embedding-options]来实现。

运行时选项

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`实现，你可以将其注入到你的类中。这里有一个简单的`@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);
    }
}

手动配置

如果您不愿意使用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'
}
Tip
 请参考依赖管理章节，以将Spring AI BOM添加到您的构建文件中。
Note
 spring-ai-azure-openai` 依赖同样提供了访问 AzureOpenAiEmbeddingClient 的权限。想要获取更多关于 AzureOpenAiChatClient 的信息，请查阅链接:../embeddings/azure-openai-embeddings.html[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"));
Note
 text-embedding-ada-002`实际上是在Azure AI Portal中呈现的`Deployment Name`。