12.11 Qdrant

吴祖贤
56 阅读4分钟

Qdrant

本节将指导您设置 Qdrant VectorStore 来存储文档嵌入（embeddings）并执行相似性搜索。

Qdrant 是一个开源的高性能向量搜索引擎/数据库。它使用 HNSW（Hierarchical Navigable Small World）算法进行高效的 k-NN 搜索操作，并为基于元数据的查询提供高级过滤功能。

Prerequisites（先决条件）

  • Qdrant 实例: 按照 Qdrant 文档中的 安装说明 设置 Qdrant 实例。
  • 如果需要，为 EmbeddingModel 提供 API 密钥，用于生成由 QdrantVectorStore 存储的嵌入。

注意: 建议提前使用适当的维度和配置 创建 Qdrant 集合。如果未创建集合，QdrantVectorStore 将尝试使用 Cosine 相似度和配置的 EmbeddingModel 的维度创建一个。

Auto-configuration（自动配置）

注意: Spring AI 自动配置和启动器模块的构件名称发生了重大变化。请参考 升级说明 了解更多信息。

Spring AI 为 Qdrant Vector Store 提供 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 Repositories 添加到您的构建文件中。

向量存储实现可以为您初始化所需的架构，但您必须通过在构建器中指定 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());

Configuration Properties（配置属性）

要连接到 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：

属性描述默认值
spring.ai.vectorstore.qdrant.hostQdrant 服务器的主机localhost
spring.ai.vectorstore.qdrant.portQdrant 服务器的 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是否初始化架构false

Manual Configuration（手动配置）

您也可以手动配置 Qdrant 向量存储，而不是使用 Spring Boot 自动配置。为此，您需要将 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")     // 可选：默认为 "vector_store"
        .initializeSchema(true)                  // 可选：默认为 false
        .batchingStrategy(new TokenCountBatchingStrategy()) // 可选：默认为 TokenCountBatchingStrategy
        .build();
}

// This can be any EmbeddingModel implementation
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}

Metadata Filtering（元数据过滤）

您也可以在 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 过滤表达式。

Accessing the Native Client（访问原生客户端）

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
}

原生客户端让您能够访问可能未通过 VectorStore 接口暴露的 Qdrant 特定功能和操作。

avatar
文章
阅读
粉丝