|
此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！ |
Azure OpenAI 嵌入
Azure 的 OpenAI 扩展了 OpenAI 功能，为各种任务提供安全的文本生成和嵌入计算模型：
-
相似性嵌入擅长捕获两个或多个文本之间的语义相似性。
-
文本搜索嵌入有助于衡量长文档是否与短查询相关。
-
代码搜索嵌入对于嵌入代码片段和嵌入自然语言搜索查询非常有用。
Azure OpenAI 嵌入依赖于cosine similarity来计算文档和查询之间的相似性。
先决条件
Azure OpenAI 客户端提供三个连接选项：使用 Azure API 密钥或使用 OpenAI API 密钥，或使用 Microsoft Entra ID。
Azure API 密钥和端点
获取 Azure OpenAIendpoint和api-key从 Azure 门户上的 Azure OpenAI 服务部分。
Spring AI 定义了两个配置属性：
-
spring.ai.azure.openai.api-key：将此设置为API Key从 Azure 获得。 -
spring.ai.azure.openai.endpoint：将此设置为在 Azure 中预置模型时获取的终端节点 URL。
您可以通过导出环境变量来设置这些配置属性：
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.ai.azure.openai.chat.options.deployment-nameproperty 添加到您要使用的 OpenAI 模型的名称中。
export SPRING_AI_AZURE_OPENAI_OPENAI_API_KEY=<INSERT OPENAI KEY HERE>Microsoft Entra ID
要使用 Microsoft Entra ID（以前称为 Azure Active Directory）进行身份验证，请创建一个TokenCredentialbean 的配置。
如果此 Bean 可用，则OpenAIClient实例。
添加存储库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理，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>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
嵌入属性
前缀spring.ai.azure.openai是用于配置与 Azure OpenAI 的连接的属性前缀。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.azure.openai.api-key |
来自 Azure AI OpenAI 的密钥 |
- |
spring.ai.azure.openai.endpoint |
Azure AI OpenAI 中的终结点 |
- |
spring.ai.azure.openai.openai-api-key |
（非 Azure）OpenAI API 密钥。用于使用 OpenAI 服务进行身份验证，而不是使用 Azure OpenAI 进行身份验证。
这会自动将终端节点设置为 api.openai.com/v1。使用任一 |
- |
前缀spring.ai.azure.openai.embedding是配置EmbeddingModelAzure OpenAI 的实现
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.azure.openai.embedding.enabled |
启用 Azure OpenAI 嵌入模型。 |
真 |
spring.ai.azure.openai.embedding.metadata-mode |
文档内容提取模式 |
嵌入 |
spring.ai.azure.openai.embedding.options.deployment-name |
这是 Azure AI 门户中显示的“部署名称”的值 |
文本嵌入 ADA 002 |
spring.ai.azure.openai.embedding.options.user |
作的调用方或最终用户的标识符。这可能用于跟踪或速率限制目的。 |
- |
所有前缀为spring.ai.azure.openai.embedding.options可以通过将特定于请求的运行时选项添加到EmbeddingRequest叫。 |
运行时选项
这AzureOpenAiEmbeddingOptions提供嵌入请求的配置信息。
这AzureOpenAiEmbeddingOptions提供用于创建选项的生成器。
开始时，使用AzureOpenAiEmbeddingModelconstructor 设置用于所有嵌入请求的默认选项。
在运行时，您可以通过传递AzureOpenAiEmbeddingOptions实例替换为EmbeddingRequest请求。
例如，要覆盖特定请求的默认模型名称：
EmbeddingResponse embeddingResponse = embeddingModel.call(
new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
AzureOpenAiEmbeddingOptions.builder()
.model("Different-Embedding-Model-Deployment-Name")
.build()));示例代码
这将创建一个EmbeddingModel实现，您可以将其注入到您的类中。
下面是一个简单的示例@Controller类使用EmbeddingModel实现。
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 自动配置，则可以手动配置AzureOpenAiEmbeddingModel在您的应用程序中。
为此，请添加spring-ai-azure-openai依赖项添加到项目的 Mavenpom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
这spring-ai-azure-openai依赖项还提供对AzureOpenAiEmbeddingModel.有关AzureOpenAiChatModel请参阅 Azure OpenAI 嵌入部分。 |
接下来，创建一个AzureOpenAiEmbeddingModel实例，并使用它来计算两个输入文本之间的相似性：
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()
.model("text-embedding-ada-002")
.user("user-6")
.build());
EmbeddingResponse embeddingResponse = this.embeddingModel
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));这text-embedding-ada-002实际上是Deployment Name如 Azure AI 门户中所示。 |