Qdrant

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

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

前提条件

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

  • 如果需要，为 EmbeddingModel 提供一个 API 密钥，用于生成由 QdrantVectorStore 存储的嵌入。

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

自动配置

Spring AI 自动配置、starter 模块的 artifact 名称发生了重大变化。更多信息请参阅升级说明。

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

向量存储实现可以为您初始化所需的 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 添加到您的构建文件中。

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

然后使用 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 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 特定功能和操作。