Qdrant

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

Qdrant 是一个开源、高性能的向量搜索引擎/数据库。

先决条件

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

  • 如果需要，则需要用于EmbeddingModel 的 API 密钥来生成 QdrantVectorStore 存储的嵌入。

要设置 QdrantVectorStore，您需要从您的 Qdrant 实例中获取以下信息：Host、GRPC Port、Collection Name 和 API Key（如果需要）。

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

自动配置

然后将 Qdrant 启动程序依赖项添加到您的项目中

<dependency>
	<groupId>org.springframework.ai</groupId>
	<artifactId>spring-ai-qdrant-store-spring-boot-starter</artifactId>
</dependency>

或到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-qdrant-store-spring-boot-starter'
}

向量存储实现可以为您初始化所需的架构，但您必须通过在相应的构造函数中指定 initializeSchema 布尔值或在 application.properties 文件中设置 …​initialize-schema=true 来选择加入。

这是一个重大更改！在早期版本的 Spring AI 中，此架构初始化默认发生。

向量存储还需要一个 EmbeddingModel 实例来计算文档的嵌入。您可以选择一个可用的EmbeddingModel 实现。

例如，要使用OpenAI EmbeddingModel，请将以下依赖项添加到您的项目中

<dependency>
	<groupId>org.springframework.ai</groupId>
	<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>

或到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅依赖项管理部分以将 Spring AI BOM 添加到您的构建文件中。请参阅存储库部分以将里程碑和/或快照存储库添加到您的构建文件中。

要连接到 Qdrant 并使用 QdrantVectorStore，您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.properties 提供简单的配置，

spring.ai.vectorstore.qdrant.host=<host of your qdrant instance>
spring.ai.vectorstore.qdrant.port=<the GRPC port of your qdrant instance>
spring.ai.vectorstore.qdrant.api-key=<your api key>
spring.ai.vectorstore.qdrant.collection-name=<The name of the collection to use in Qdrant>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>
查看配置参数列表以了解默认值和配置选项。

现在，您可以在应用程序中自动连接 Qdrant 向量存储并使用它

@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 = this.vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 Qdrant 向量存储。

属性 描述 默认值

spring.ai.vectorstore.qdrant.host

Qdrant 服务器的主机。

localhost

spring.ai.vectorstore.qdrant.port

Qdrant 服务器的 gRPC 端口。

6334

spring.ai.vectorstore.qdrant.api-key

用于对 Qdrant 服务器进行身份验证的 API 密钥。

-

spring.ai.vectorstore.qdrant.collection-name

要在 Qdrant 中使用的集合的名称。

-

spring.ai.vectorstore.qdrant.use-tls

是否使用 TLS(HTTPS)。

false

spring.ai.vectorstore.qdrant.initialize-schema

是否初始化后端架构。

false

元数据过滤

您可以使用通用的、可移植的元数据过滤器与 Qdrant 向量存储一起使用。

例如，您可以使用文本表达式语言

vectorStore.similaritySearch(
    SearchRequest.defaults()
    .withQuery("The World")
    .withTopK(TOP_K)
    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
    .withFilterExpression("author in ['john', 'jill'] && article_type == 'blog'"));

或使用 Filter.Expression DSL 以编程方式使用

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
    .withQuery("The World")
    .withTopK(TOP_K)
    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
    .withFilterExpression(b.and(
        b.in("author", "john", "jill"),
        b.eq("article_type", "blog")).build()));
这些过滤器表达式将转换为等效的 Qdrant过滤器。

手动配置

而不是使用 Spring Boot 自动配置，您可以手动配置 QdrantVectorStore。为此，您需要将 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'
}

要配置应用程序中的 Qdrant，您可以创建一个 QdrantClient

@Bean
public QdrantClient qdrantClient() {

    QdrantGrpcClient.Builder grpcClientBuilder =
        QdrantGrpcClient.newBuilder(
            "<QDRANT_HOSTNAME>",
            <QDRANT_GRPC_PORT>,
            <IS_TSL>);
    grpcClientBuilder.withApiKey("<QDRANT_API_KEY>");

    return new QdrantClient(grpcClientBuilder.build());
}

通过将 Spring Boot OpenAI 启动程序添加到您的项目中来集成 OpenAI 的嵌入。这为您提供了一个 Embeddings 客户端的实现

@Bean
public QdrantVectorStore vectorStore(EmbeddingModel embeddingModel, QdrantClient qdrantClient) {
    return new QdrantVectorStore(qdrantClient, "<QDRANT_COLLECTION_NAME>", embeddingModel);
}