Azure AI 服务

本部分将指导你完成设置以存储文档嵌入并使用 Azure AI 搜索服务执行相似性搜索。AzureVectorStorespring-doc.cn

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

先决条件

  1. Azure 订阅：您需要 Azure 订阅才能使用任何 Azure 服务。spring-doc.cn

  2. Azure AI 搜索服务：创建 AI 搜索服务。创建服务后，从 section 下的 part 中获取 admin apiKey，并从 section 下的字段中检索 endpoint。KeysSettingsUrlOverviewspring-doc.cn

  3. （可选）Azure OpenAI 服务：创建 Azure OpenAI 服务。注意：可能需要填写单独的表单才能访问 Azure Open AI 服务。创建服务后，从 下的部分获取 endpoint 和 apiKey 。Keys and EndpointResource Managementspring-doc.cn

配置

启动时，如果您通过在构造函数中将相关属性设置为来选择加入，或者如果使用 Spring Boot，则在文件中设置，则可以尝试在 AI Search 服务实例中创建新索引。AzureVectorStoreinitialize-schemabooleantrue…​initialize-schema=trueapplication.propertiesspring-doc.cn

这是一个突破性的变化！在早期版本的 Spring AI 中，默认情况下会进行此架构初始化。

或者，您可以手动创建索引。spring-doc.cn

若要设置 AzureVectorStore，需要从上述先决条件中检索到的设置以及索引名称：spring-doc.cn

您可以将这些值作为操作系统环境变量提供。spring-doc.cn

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)

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

依赖

将这些依赖项添加到您的项目中：spring-doc.cn

1. 选择 Embeddings 接口实现。您可以选择：

<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 Search） 矢量存储

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

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 Azure 矢量存储。spring-doc.cn

财产 默认值

spring.ai.vectorstore.azure.urlspring-doc.cn

spring.ai.vectorstore.azure.api-keyspring-doc.cn

spring.ai.vectorstore.azure.useKeylessAuthspring-doc.cn

假spring-doc.cn

spring.ai.vectorstore.azure.initialize-schemaspring-doc.cn

假spring-doc.cn

spring.ai.vectorstore.azure.index-namespring-doc.cn

spring_ai_azure_vector_storespring-doc.cn

spring.ai.vectorstore.azure.default-top-kspring-doc.cn

4spring-doc.cn

spring.ai.vectorstore.azure.default-similarity-thresholdspring-doc.cn

0.0spring-doc.cn

spring.ai.vectorstore.azure.embedding-propertyspring-doc.cn

嵌入spring-doc.cn

spring.ai.vectorstore.azure.index-namespring-doc.cn

spring-ai-文档索引spring-doc.cn

示例代码

要在应用程序中配置 Azure，您可以使用以下代码：SearchIndexClientspring-doc.cn

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

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

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

您必须明确列出筛选条件表达式中使用的任何元数据键的所有元数据字段名称和类型。上面的列表注册了可筛选的元数据字段： type 、 type 和 type 。countryTEXTyearINT64activeBOOLEANspring-doc.cn

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

在您的主代码中，创建一些文档：spring-doc.cn

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

将文档添加到您的 vector 存储中：spring-doc.cn

vectorStore.add(documents);

最后，检索类似于查询的文档：spring-doc.cn

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

如果一切顺利，您应该检索包含文本 “Spring AI rocks！！” 的文档。spring-doc.cn

元数据筛选

还可以将通用的可移植元数据筛选器与 AzureVectorStore 结合使用。spring-doc.cn

例如，您可以使用文本表达式语言：spring-doc.cn

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

或者以编程方式使用表达式 DSL：spring-doc.cn

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 搜索 OData 筛选器。例如，以下可移植筛选条件表达式：spring-doc.cn

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

转换为以下 Azure OData 筛选器表达式：spring-doc.cn

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