|
如需最新的快照版本,请使用 Spring AI 1.1.3! |
Qdrant
本节将指导您设置 Qdrant VectorStore 以存储文档嵌入并执行相似性搜索。
Qdrant 是一个开源、高性能的向量搜索引擎/数据库。它使用 HNSW(分层可导航小世界)算法进行高效的 k-NN 搜索操作,并为基于元数据的查询提供高级过滤功能。
前置条件
-
Qdrant 实例:按照 Qdrant 文档中的 安装说明 设置 Qdrant 实例。
-
如果需要,为EmbeddingModel提供一个API密钥,用于生成由
QdrantVectorStore存储的嵌入向量。
建议提前创建具有适当维度和配置的 Qdrant 集合。
如果未创建集合,QdrantVectorStore 将尝试使用 Cosine 相似度和配置的 EmbeddingModel 的维度创建一个。 |
Auto-configuration
|
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 中央仓库和/或快照仓库添加到您的构建文件中。 |
向量存储实现可以为您初始化所需的模式,但您必须通过在构建器中指定 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,您需要为您的实例提供访问详细信息。
可以通过 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:
| <property> </property> | <description> </description> | 默认值 |
|---|---|---|
|
Qdrant 服务器的主机 |
|
|
Qdrant 服务器的 gRPC 端口 |
|
|
用于身份验证的 API 密钥 |
- |
|
要使用的集合名称 |
|
|
是否使用 TLS(HTTPS) |
|
|
是否初始化 schema |
|
手动配置
除了使用 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 向量存储实现通过 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 接口暴露。