Azure AI Service

本节将引导你如何设置AzureVectorStore用于存储文档嵌入并使用 Azure AI 搜索服务进行相似性搜索。spring-doc.cadn.net.cn

Azure AI 搜索是一个多功能的云托管云信息检索系统，是 Microsoft 更大 AI 平台的一部分。它允许用户通过基于向量的存储和检索查询信息。spring-doc.cadn.net.cn

前提条件

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

  2. Azure AI 搜索服务：创建一个 AI 搜索服务。服务创建后，从以下平台获取管理员apiKey。钥匙部分设置并从网址在概述部分。spring-doc.cadn.net.cn

  3. （可选）Azure OpenAI Service： Create a Azure OpenAI service.注意：您可能需要填写单独表格才能访问Azure Open AI服务。服务创建后，从以下平台获取端点和apiKey。密钥与端点部分资源管理.spring-doc.cadn.net.cn

配置

启动时，AzureVectorStore如果你选择加入，可以通过设置相关条件尝试在你的AI搜索服务实例中创建新的索引初始化模式 布尔属性到true在构造函数中，或者如果使用Spring Boot，则设置…​initialize-schema=true在你的application.properties文件。spring-doc.cadn.net.cn

这是一个颠覆性的变革！在早期版本的 Spring AI 中，这种模式初始化是默认的。

或者，你也可以手动创建索引。spring-doc.cadn.net.cn

要设置 AzureVectorStore，你需要从上述前置条件中获取设置，并附带你的索引名称：spring-doc.cadn.net.cn

你可以把这些值作为作系统环境变量提供。spring-doc.cadn.net.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)

你可以用任何支持 Embeddings 界面的有效 OpenAI 实现来替代 Azure Open AI 实现。例如，你可以使用 Spring AI 的 Open AI，或者转换器嵌入嵌入的实现代替Azure的实现。spring-doc.cadn.net.cn

依赖

春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。spring-doc.cadn.net.cn

将以下依赖项添加到你的项目中：spring-doc.cadn.net.cn

1. 选择一个嵌入接口实现。你可以选择：

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

2. Azure（AI搜索）矢量存储

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-azure-store</artifactId>
</dependency>
请参考依赖管理部分，将Spring AI的物料清单添加到你的构建文件中。

配置属性

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

属性 默认值

Spring.ai.vectorstore.azure.urlspring-doc.cadn.net.cn

Spring.ai.vectorstore.azure.api-keyspring-doc.cadn.net.cn

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

falsespring-doc.cadn.net.cn

Spring.ai.vectorstore.azure.initialize-schemaspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

Spring.ai.vectorstore.azure.index-namespring-doc.cadn.net.cn

spring_ai_azure_vector_storespring-doc.cadn.net.cn

Spring.ai.vectorstore.azure.default-top-kspring-doc.cadn.net.cn

4spring-doc.cadn.net.cn

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

0.0spring-doc.cadn.net.cn

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

嵌入spring-doc.cadn.net.cn

Spring.ai.vectorstore.azure.index-namespring-doc.cadn.net.cn

Spring-ai-文档索引spring-doc.cadn.net.cn

示例代码

To configure a AzureSearchIndex客户端在你的应用中，可以使用以下代码：spring-doc.cadn.net.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();
}

要创建向量存储，你可以用以下代码注入SearchIndex客户端在上述样本中生成的豆子，并配有嵌入模型由实现所需嵌入界面的 Spring AI 库提供。spring-doc.cadn.net.cn

@Bean
public VectorStore vectorStore(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {

  return AzureVectorStore.builder(searchIndexClient, embeddingModel)
    .initializeSchema(true)
    // Define the metadata fields to be used
    // in the similarity search filters.
    .filterMetadataFields(List.of(MetadataField.text("country"), MetadataField.int64("year"),
            MetadataField.date("activationDate")))
    .defaultTopK(5)
    .defaultSimilarityThreshold(0.7)
    .indexName("spring-ai-document-index")
    .build();
}

你必须明确列出过滤表达式中使用的任何元数据键的所有元数据字段名称和类型。上述列表寄存可过滤的元数据字段：状态类型文本,年类型INT64和积极类型布尔.spring-doc.cadn.net.cn

如果可筛选的元数据字段被扩展为新条目，你必须重新上传/更新包含这些元数据的文档。spring-doc.cadn.net.cn

在你的主代码中，创建一些文档：spring-doc.cadn.net.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)));

将文档添加到你的矢量存储中：spring-doc.cadn.net.cn

vectorStore.add(documents);

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

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

如果一切顺利，你应该取回包含“春季AI超棒！！”文字的文档。spring-doc.cadn.net.cn

元数据过滤

你也可以利用AzureVectorStore的通用、可移植元数据过滤器。spring-doc.cadn.net.cn

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

vectorStore.similaritySearch(
   SearchRequest.builder()
      .query("The World")
      .topK(TOP_K)
      .similarityThreshold(SIMILARITY_THRESHOLD)
      .filterExpression("country in ['UK', 'NL'] && year >= 2020").build());

或通过程序化使用表达式 DSL：spring-doc.cadn.net.cn

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(
    SearchRequest.builder()
      .query("The World")
      .topK(TOP_K)
      .similarityThreshold(SIMILARITY_THRESHOLD)
      .filterExpression(b.and(
         b.in("country", "UK", "NL"),
         b.gte("year", 2020)).build()).build());

便携式过滤器表达式会自动转换为专有的 Azure Search OData 过滤器。例如，以下可移植的Filter表达式：spring-doc.cadn.net.cn

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

转换为以下Azure OData过滤器表达式：spring-doc.cadn.net.cn

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

访问本地客户端

Azure Vector Store 实现提供了对底层原生 Azure Search 客户端的访问（搜索客户端）通过getNativeClient（）方法：spring-doc.cadn.net.cn

AzureVectorStore vectorStore = context.getBean(AzureVectorStore.class);
Optional<SearchClient> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    SearchClient client = nativeClient.get();
    // Use the native client for Azure Search-specific operations
}

原生客户端为您提供了 Azure Search 专属的功能和作，这些可能无法通过VectorStore接口。spring-doc.cadn.net.cn