|
此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！ |
Azure AI 服务
本节将引导您设置AzureVectorStore，以使用 Azure AI Search Service 存储文档嵌入并执行相似性搜索。
Azure AI Search 是一个多功能的云托管信息检索系统，属于微软更大规模 AI 平台的一部分。除其他功能外，它允许用户使用基于向量的存储和检索来查询信息。
前置条件
-
Azure 订阅：您需要一个 Azure 订阅 才能使用任何 Azure 服务。
-
Azure AI Search Service：创建AI Search 服务。服务创建完成后，从
Settings下的Keys部分获取管理员 apiKey，并从Overview部分的Url字段中检索终结点。 -
（可选）Azure OpenAI 服务：创建一个 Azure OpenAI 服务。注意：您可能需要填写单独的表格以获得 Azure OpenAI 服务的访问权限。服务创建完成后，从
Resource Management下的Keys and Endpoint部分获取端点和 apiKey。
配置
启动时，如果通过在构造函数中将相关的 initialize-schema boolean 属性设置为 true opted in，或者在使用 Spring Boot 时在 application.properties 文件中设置 …initialize-schema=true，AzureVectorStore 会尝试在您的 AI Search 服务实例中创建新索引。
| 这是一个破坏性变更！在早期版本的 Spring AI 中，此架构初始化是默认发生的。 |
或者，您也可以手动创建索引。
要设置 AzureVectorStore，您需要上述前提条件中检索到的设置以及您的索引名称：
-
Azure AI Search 终结点
-
Azure AI Search 密钥
-
（可选）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)|
您可以将 Azure Open AI 实现替换为任何支持 Embeddings 接口的有效 OpenAI 实现。例如，您可以使用 Spring AI 的 Open AI 或 |
依赖项
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
将以下依赖项添加到您的项目中：
1. 选择一个 Embeddings 接口实现。您可以在以下选项中进行选择：
-
OpenAI Embedding
-
Azure AI Embedding
-
Local Sentence Transformers Embedding
<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 Search) 向量存储
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-store</artifactId>
</dependency>| 请参阅依赖管理部分，将Spring AI BOM添加到您的构建文件中。 |
配置属性
您可以在 Spring Boot 配置中使用以下属性来自定义 Azure 向量存储。
| <property> </property> | 默认值 |
|---|---|
|
|
|
|
|
false |
|
false |
|
spring_ai_azure_vector_store |
|
4 |
|
0.0 |
|
内容 |
|
嵌入 |
|
元数据 |
示例代码
要在您的应用程序中配置 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 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();
}|
您必须为筛选表达式中使用的任何元数据键显式列出所有元数据字段名称和类型。上述列表注册了可筛选的元数据字段：类型为 如果可过滤的元数据字段扩展了新条目，您必须（重新）上传或更新带有此元数据的文档。 |
在您的主代码中，创建一些文档：
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.builder()
.query("Spring")
.topK(5).build());如果一切顺利，您应该能检索到包含文本"Spring AI rocks!!"的文档。
元数据过滤
您也可以将通用的、可移植的元数据过滤器与 AzureVectorStore 一起使用。
例如，您可以使用文本表达式语言：
vectorStore.similaritySearch(
SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression("country in ['UK', 'NL'] && year >= 2020").build());或以编程方式使用表达式 DSL：
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 筛选器。例如，以下可移植的筛选表达式：
country in ['UK', 'NL'] && year >= 2020已转换为以下 Azure OData 筛选表达式：
$filter search.in(meta_country, 'UK,NL', ',') and meta_year ge 2020自定义字段名称
默认情况下，Azure Vector Store 在 Azure AI Search 索引中使用以下字段名：
-
content- 用于文档文本 -
embedding- 用于向量嵌入 -
metadata- 用于文档元数据
然而，当使用具有不同字段名称的现有 Azure AI Search 索引时，您可以配置自定义字段名称以匹配您的索引架构。这使得您能够将 Spring AI 与预先存在的索引集成，而无需修改它们。
用例
自定义字段名称在以下情况下特别有用：
-
与现有索引集成：您的组织已经拥有具有既定字段命名约定（例如
chunk_text、vector、meta_data）的 Azure AI Search 索引。 -
遵循命名规范：您的团队遵循与默认值不同的特定命名约定。
-
从其他系统迁移：您正在从另一个向量数据库或搜索系统迁移，并希望保持一致的字段名称。
配置通过属性
您可以使用 Spring Boot 应用程序属性配置自定义字段名称：
spring.ai.vectorstore.azure.url=${AZURE_AI_SEARCH_ENDPOINT}
spring.ai.vectorstore.azure.api-key=${AZURE_AI_SEARCH_API_KEY}
spring.ai.vectorstore.azure.index-name=my-existing-index
spring.ai.vectorstore.azure.initialize-schema=false
# Custom field names to match existing index schema
spring.ai.vectorstore.azure.content-field-name=chunk_text
spring.ai.vectorstore.azure.embedding-field-name=vector
spring.ai.vectorstore.azure.metadata-field-name=meta_data当使用具有自定义字段名称的现有索引时，请设置 initialize-schema=false 以防止 Spring AI 尝试使用默认架构创建新索引。 |
通过 Builder API 进行配置
或者，您可以使用构建器 API 以编程方式配置自定义字段名称：
@Bean
public VectorStore vectorStore(SearchIndexClient searchIndexClient, EmbeddingModel embeddingModel) {
return AzureVectorStore.builder(searchIndexClient, embeddingModel)
.indexName("my-existing-index")
.initializeSchema(false) // Don't create schema - use existing index
// Configure custom field names to match existing index
.contentFieldName("chunk_text")
.embeddingFieldName("vector")
.metadataFieldName("meta_data")
.filterMetadataFields(List.of(
MetadataField.text("category"),
MetadataField.text("source")))
.build();
}完整示例：使用现有索引进行工作
下面是一个完整的示例，展示如何将 Spring AI 与现有的 Azure AI Search 索引（包含自定义字段名称）配合使用：
@Configuration
public class VectorStoreConfig {
@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
public VectorStore vectorStore(SearchIndexClient searchIndexClient,
EmbeddingModel embeddingModel) {
return AzureVectorStore.builder(searchIndexClient, embeddingModel)
.indexName("production-documents-index")
.initializeSchema(false) // Use existing index
// Map to existing index field names
.contentFieldName("document_text")
.embeddingFieldName("text_vector")
.metadataFieldName("document_metadata")
// Define filterable metadata fields from existing schema
.filterMetadataFields(List.of(
MetadataField.text("department"),
MetadataField.int64("year"),
MetadataField.date("created_date")))
.defaultTopK(10)
.defaultSimilarityThreshold(0.75)
.build();
}
}然后您可以像往常一样使用向量存储：
// Search using the existing index with custom field names
List<Document> results = vectorStore.similaritySearch(
SearchRequest.builder()
.query("artificial intelligence")
.topK(5)
.filterExpression("department == 'Engineering' && year >= 2023")
.build());
// The results contain documents with text from the 'document_text' field
results.forEach(doc -> System.out.println(doc.getText()));使用自定义字段名称创建新索引
您还可以通过设置 initializeSchema=true 来创建具有自定义字段名称的新索引：
@Bean
public VectorStore vectorStore(SearchIndexClient searchIndexClient,
EmbeddingModel embeddingModel) {
return AzureVectorStore.builder(searchIndexClient, embeddingModel)
.indexName("new-custom-index")
.initializeSchema(true) // Create new index with custom field names
.contentFieldName("text_content")
.embeddingFieldName("content_vector")
.metadataFieldName("doc_metadata")
.filterMetadataFields(List.of(
MetadataField.text("category"),
MetadataField.text("author")))
.build();
}这将创建一个新的 Azure AI Search 索引，并使用您自定义的字段名称，使您能够从一开始就建立自己的命名规范。
访问原生客户端
Azure 向量存储实现通过 getNativeClient() 方法提供对底层原生 Azure Search 客户端（SearchClient）的访问：
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 搜索特有的功能和操作，这些功能和操作可能未通过 VectorStore 接口公开。