Qdrant
本节将引导您设置Qdrant VectorStore,用于存储文档嵌入向量并执行相似性搜索。
Qdrant 是一款开源、高性能的向量搜索引擎/数据库。它采用 HNSW(分层可导航小世界)算法实现高效的 k-NN 搜索操作,并为基于元数据的查询提供高级过滤功能。
先决条件
-
Qdrant 实例:按照 Qdrant 文档中的安装说明设置 Qdrant 实例。
-
如果需要,为 EmbeddingModel 获取一个 API 密钥,用于生成由
QdrantVectorStore存储的嵌入向量。
建议提前创建 Qdrant 集合,并配置好合适的维度和配置。如果集合尚未创建,QdrantVectorStore 将会尝试使用 Cosine 相似度和配置的 EmbeddingModel 的维度来创建一个集合。
自动配置
Spring AI 的自动配置和 starter 模块的 artifact 名称已发生重大变更。请查阅 升级说明 以获取更多信息。
Spring AI 为 Qdrant 向量存储提供了 Spring Boot 自动配置功能。要启用它,请将以下依赖项添加到项目的 Maven pom.xml 文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-vector-store-qdrant</artifactId>
</dependency>
或将其添加到您的 Gradle build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-vector-store-qdrant'
}
:::提示
请参考依赖管理章节,将Spring AI BOM添加到您的构建文件中。
:::
请查看向量存储的配置参数列表,了解其默认值和配置选项。
参考制品仓库部分,将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。
向量存储实现可以为您初始化所需的模式,但您必须通过在构建器中指定 initializeSchema 布尔值或在 application.properties 文件中设置 …initialize-schema=true 来选择启用。
这是一项重大变更!在 Spring AI 的早期版本中,默认情况下会进行此模式初始化。
此外,你需要一个配置好的 EmbeddingModel bean。更多信息请参阅 EmbeddingModel 章节。
现在你可以在应用中自动装配 QdrantVectorStore 作为向量存储。
@Autowired VectorStore vectorStore;
// ...
List<Document> documents = List.of(
new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
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("meta2", "meta2")));
// Add the documents to Qdrant
vectorStore.add(documents);
// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());
配置属性
要连接到 Qdrant 并使用 QdrantVectorStore,您需要提供 Qdrant 实例的访问信息。可以通过 Spring Boot 的 application.yml 文件提供简单的配置:
spring:
ai:
vectorstore:
qdrant:
host: <qdrant host>
port: <qdrant grpc port>
api-key: <qdrant api key>
collection-name: <collection name>
use-tls: false
initialize-schema: true
以 spring.ai.vectorstore.qdrant.* 开头的属性用于配置 QdrantVectorStore:
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.vectorstore.qdrant.host | Qdrant 服务器的主机地址 | localhost |
spring.ai.vectorstore.qdrant.port | Qdrant 服务器的 gRPC 端口 | 6334 |
spring.ai.vectorstore.qdrant.api-key | 用于身份验证的 API 密钥 | - |
spring.ai.vectorstore.qdrant.collection-name | 要使用的集合名称 | vector_store |
spring.ai.vectorstore.qdrant.use-tls | 是否使用 TLS (HTTPS) | false |
spring.ai.vectorstore.qdrant.initialize-schema | 是否初始化 schema | false |
手动配置
如果不使用 Spring Boot 自动配置,您可以手动配置 Qdrant 向量存储。为此,您需要在项目中添加 spring-ai-qdrant-store 依赖:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-qdrant-store</artifactId>
</dependency>
或添加到您的 Gradle build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-qdrant-store'
}
:::提示
参考依赖管理章节,将 Spring AI BOM 添加到您的构建文件中。
:::
创建一个Qdrant客户端Bean:
@Bean
public QdrantClient qdrantClient() {
QdrantGrpcClient.Builder grpcClientBuilder =
QdrantGrpcClient.newBuilder(
"<QDRANT_HOSTNAME>",
<QDRANT_GRPC_PORT>,
<IS_TLS>);
grpcClientBuilder.withApiKey("<QDRANT_API_KEY>");
return new QdrantClient(grpcClientBuilder.build());
}
然后使用构建器模式创建 QdrantVectorStore Bean:
@Bean
public VectorStore vectorStore(QdrantClient qdrantClient, EmbeddingModel embeddingModel) {
return QdrantVectorStore.builder(qdrantClient, embeddingModel)
.collectionName("custom-collection") // Optional: defaults to "vector_store"
.initializeSchema(true) // Optional: defaults to false
.batchingStrategy(new TokenCountBatchingStrategy()) // Optional: defaults to TokenCountBatchingStrategy
.build();
}
// This can be any EmbeddingModel implementation
@Bean
public EmbeddingModel embeddingModel() {
return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}
元数据过滤
您同样可以将通用的、可移植的元数据过滤器与 Qdrant 向量数据库结合使用。
例如,您可以使用文本表达式语言:
vectorStore.similaritySearch(
SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression("author in ['john', 'jill'] && article_type == 'blog'").build());
或通过 Filter.Expression DSL 以编程方式实现:
FilterExpressionBuilder b = new FilterExpressionBuilder();
vectorStore.similaritySearch(SearchRequest.builder()
.query("The World")
.topK(TOP_K)
.similarityThreshold(SIMILARITY_THRESHOLD)
.filterExpression(b.and(
b.in("author", "john", "jill"),
b.eq("article_type", "blog")).build()).build());
这些(可移植的)过滤器表达式会自动转换为 Qdrant 专有的过滤器表达式。
访问原生客户端
Qdrant Vector Store 实现通过 getNativeClient() 方法提供了对底层原生 Qdrant 客户端(QdrantClient)的访问:
QdrantVectorStore vectorStore = context.getBean(QdrantVectorStore.class);
Optional<QdrantClient> nativeClient = vectorStore.getNativeClient();
if (nativeClient.isPresent()) {
QdrantClient client = nativeClient.get();
// Use the native client for Qdrant-specific operations
}
原生客户端让您能够访问Qdrant特有的功能和操作,这些可能无法通过VectorStore接口实现。