Qdrant

本节引导你设置 Qdrant VectorStore 以存储文档嵌入并执行相似度搜索。

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

前置条件

• Qdrant 实例：按照 Qdrant 文档中的安装说明 设置一个 Qdrant 实例。
• 如有需要，为 EmbeddingModel 配置一个 API 密钥，以生成 QdrantVectorStore 所存储的嵌入。

NOTE

建议事先用恰当的维度与配置创建 Qdrant 集合。

若集合尚未创建，QdrantVectorStore 会尝试使用 Cosine 相似度和所配置的 EmbeddingModel 的维度创建一个。

自动配置

NOTE

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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

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

TIP

参见 制品仓库 一节，把 Maven Central 和/或 Snapshot 仓库添加到你的构建文件。

向量库实现可以为你初始化所需的模式，但你必须显式开启——在构建器中指定 initializeSchema 布尔值，或在 application.properties 文件中设置 ...initialize-schema=true。

NOTE

这是一处破坏性变更！在较早的 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>
        content-field-name: <content field 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.content-field-name	Qdrant payload 中存储文档内容的字段名。在与使用不同字段名的既有集合集成时很有用（例如 "page_content"、"text"、"content"）。	doc_content
spring.ai.vectorstore.qdrant.use-tls	是否使用 TLS(HTTPS)	false
spring.ai.vectorstore.qdrant.initialize-schema	是否初始化模式	false

upsert 支持

QdrantVectorStore 实现了 upsert(List<EmbeddedDocument>)，因此你可以连同在别处计算好的嵌入一起写入文档，而不必让向量库去做嵌入。 以相同 id 再次写入会替换既有的行，因此用稳定的 id 重跑不会产生重复。 细节参见写入用户提供的嵌入。

手动配置

与其使用 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'
}

TIP

参见 依赖管理 一节，把 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"
        .contentFieldName("page_content")        // Optional: defaults to "doc_content"
        .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(OpenAiEmbeddingOptions.builder().apiKey(System.getenv("OPENAI_API_KEY")).build());
}

处理既有集合

把 Spring AI 与既有的 Qdrant 集合集成时，你可能需要配置内容字段名以匹配已在使用的模式。

默认情况下，QdrantVectorStore 把文档内容存储在名为 doc_content 的字段中。然而，既有集合可能使用不同的命名约定，如 page_content、text、content 或其他自定义名称。

使用自定义内容字段名

你可以配置内容字段名以匹配你既有集合的模式：

通过属性：

spring:
  ai:
    vectorstore:
      qdrant:
        collection-name: my_existing_collection
        content-field-name: page_content  # Match existing schema

以编程方式：

@Bean
public VectorStore vectorStore(QdrantClient qdrantClient, EmbeddingModel embeddingModel) {
    return QdrantVectorStore.builder(qdrantClient, embeddingModel)
        .collectionName("my_existing_collection")
        .contentFieldName("text")  // Use existing field name
        .initializeSchema(false)   // Don't recreate existing schema
        .build();
}

元数据过滤

你也可以在 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());

NOTE

这些（可移植的）过滤表达式会被自动转换为 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 特定功能与操作。