Azure AI 服务

本节将引导您完成设置 AzureVectorStore 以存储文档嵌入并使用 Azure AI 搜索服务执行相似性搜索的过程。

Azure AI 搜索 是一个多功能的云托管云信息检索系统，它是微软更大 AI 平台的一部分。除其他功能外，它还允许用户使用基于向量的存储和检索来查询信息。

先决条件

  1. Azure 订阅：您需要一个 Azure 订阅 才能使用任何 Azure 服务。

  2. Azure AI 搜索服务：创建一个 AI 搜索服务。创建服务后，从“设置”下的“密钥”部分获取管理员 apiKey，并从“概述”部分下的“URL”字段检索端点。

  3. (可选) Azure OpenAI 服务：创建一个 Azure OpenAI 服务。**注意：**您可能需要填写单独的表格才能访问 Azure Open AI 服务。创建服务后，从“资源管理”下的“密钥和端点”部分获取端点和 apiKey。

配置

在启动时，如果您已通过在构造函数中将相关的 initialize-schema boolean 属性设置为 true 选择加入，或者如果使用 Spring Boot，则在您的 application.properties 文件中设置 …​initialize-schema=true，则 AzureVectorStore 可以尝试在您的 AI 搜索服务实例中创建一个新索引。

这是一个重大更改！在早期版本的 Spring AI 中，此模式初始化是默认执行的。

或者，您可以手动创建索引。

要设置 AzureVectorStore，您将需要从以上先决条件中检索到的设置以及您的索引名称

  • Azure AI 搜索端点

  • Azure AI 搜索密钥

  • (可选) Azure OpenAI API 端点

  • (可选) Azure OpenAI API 密钥

您可以将这些值作为操作系统环境变量提供。

export AZURE_AI_SEARCH_API_KEY=<My AI Search API Key>
export AZURE_AI_SEARCH_ENDPOINT=<My AI Search Index>
export OPENAI_API_KEY=<My Azure AI API Key> (Optional)

您可以用任何支持 Embeddings 接口的有效 OpenAI 实现替换 Azure Open AI 实现。例如，您可以使用 Spring AI 的 Open AI 或 TransformersEmbedding 实现来进行嵌入，而不是 Azure 实现。

依赖项

将这些依赖项添加到您的项目中

1. 选择一个 Embeddings 接口实现。您可以在以下选项之间进行选择：

  • OpenAI 嵌入

  • Azure AI 嵌入

  • 本地 Sentence Transformers 嵌入

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

2. Azure (AI 搜索) 向量存储

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-azure-store</artifactId>
</dependency>
请参阅 依赖项管理 部分，以将 Spring AI BOM 添加到您的构建文件中。

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 Azure 向量存储。

属性 默认值

spring.ai.vectorstore.azure.url

spring.ai.vectorstore.azure.api-key

spring.ai.vectorstore.azure.initialize-schema

false

spring.ai.vectorstore.azure.index-name

spring_ai_azure_vector_store

spring.ai.vectorstore.azure.default-top-k

4

spring.ai.vectorstore.azure.default-similarity-threshold

0.0

spring.ai.vectorstore.azure.embedding-property

embedding

spring.ai.vectorstore.azure.index-name

spring-ai-document-index

示例代码

要在您的应用程序中配置 Azure SearchIndexClient，您可以使用以下代码

@Bean
public SearchIndexClient searchIndexClient() {
  return new SearchIndexClientBuilder().endpoint(System.getenv("AZURE_AI_SEARCH_ENDPOINT"))
    .credential(new AzureKeyCredential(System.getenv("AZURE_AI_SEARCH_API_KEY")))
    .buildClient();
}

要创建向量存储，您可以使用以下代码，方法是注入上面示例中创建的 SearchIndexClient bean 以及 Spring AI 库提供的实现所需 Embeddings 接口的 EmbeddingModel。

@Bean
public VectorStore vectorStore(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {
  return new AzureVectorStore(searchIndexClient, embeddingModel,
    // Define the metadata fields to be used
    // in the similarity search filters.
    List.of(MetadataField.text("country"),
            MetadataField.int64("year"),
            MetadataField.bool("active")));
}

您必须显式列出筛选表达式中使用的任何元数据键的所有元数据字段名称和类型。上面的列表注册了可筛选的元数据字段：类型为 TEXT 的 country、类型为 INT64 的 year 和类型为 BOOLEAN 的 active。

如果可筛选的元数据字段扩展了新条目，则必须使用此元数据（重新）上传/更新文档。

在您的主代码中，创建一些文档

List<Document> documents = List.of(
	new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("country", "BG", "year", 2020)),
	new Document("The World is Big and Salvation Lurks Around the Corner"),
	new Document("You walk forward facing the past and you turn back toward the future.", Map.of("country", "NL", "year", 2023)));

将文档添加到您的向量存储中

vectorStore.add(documents);

最后，检索与查询类似的文档

List<Document> results = vectorStore.similaritySearch(
    SearchRequest
      .query("Spring")
      .withTopK(5));

如果一切顺利，您应该检索包含文本“Spring AI rocks!!”的文档。

元数据筛选

您也可以使用 AzureVectorStore 利用通用、可移植的 元数据筛选器。

例如，您可以使用文本表达式语言

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression("country in ['UK', 'NL'] && year >= 2020"));

或以编程方式使用表达式 DSL

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(
    SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression(b.and(
         b.in("country", "UK", "NL"),
         b.gte("year", 2020)).build()));

可移植筛选器表达式会自动转换为专有的 Azure Search OData 筛选器。例如，以下可移植筛选器表达式

country in ['UK', 'NL'] && year >= 2020

转换为以下 Azure OData 筛选器表达式

$filter search.in(meta_country, 'UK,NL', ',') and meta_year ge 2020