Qdrant

本站(springdoc.cn)中的内容来源于 spring.io ，原始版权归属于 spring.io。由 springdoc.cn 进行翻译，整理。可供个人学习、研究，未经许可，不得进行任何转载、商用或与之相关的行为。 商标声明：Spring 是 Pivotal Software, Inc. 在美国以及其他国家的商标。

本节将引导你完成 Qdrant VectorStore 的设置，以存储文档嵌入并执行相似性搜索。

Qdrant 是一个开源的高性能向量搜索引擎/数据库。它使用 HNSW（分层可导航小世界）算法来实现高效的 k-NN 搜索操作，并为基于元数据的查询提供了高级过滤功能。

先决条件

  • Qdrant 实例：按照 Qdrant 文档中的 安装说明 设置一个 Qdrant 实例。

  • API 密钥（如需要）：如果使用的 EmbeddingModel（如 OpenAI、Azure 等）需要认证，则需提供相应的 API 密钥，用于生成由 QdrantVectorStore 存储的嵌入向量。

建议提前按照适当的维度和配置 创建 Qdrant 集合。如果集合尚未创建，QdrantVectorStore 将尝试使用余弦相似性（Cosine similarity）以及所配置 EmbeddingModel 的向量维度来自动创建一个集合。

自动配置

Spring AI 的自动配置和 Starter 模块的工件名称发生了重大变化。请参阅 升级说明 以获取更多信息。

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 添加到你的构建文件中。

请查看向量存储的 配置参数列表，以了解默认值和配置选项。

请参阅 “Artifact 仓库” 部分，将 Maven Central 和/或快照仓库添加到你的构建文件中。

该向量存储实现可以为你初始化所需的 Schema，但你必须通过在 Builder 中指定 initializeSchema 布尔值，或在 application.properties 文件中设置 …​initialize-schema=true 来选择启用该功能。

这是一个破坏性变更！在 Spring AI 的早期版本中，Schema 初始化是默认自动进行的。

此外，你还需要配置一个 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：

属性 说明 默认值

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 添加到你的构建文件中。

创建 QdrantClient 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());
}

然后使用 Builder 模式创建 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
}

原生客户端使你可以访问 VectorStore 接口可能未暴露的、Qdrant 特有的功能和操作。