此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT!spring-doc.cn

Qdrant

本节将指导您设置 Qdrant 以存储文档嵌入并执行相似性搜索。VectorStorespring-doc.cn

Qdrant 是一个开源、高性能的矢量搜索引擎/数据库。spring-doc.cn

先决条件

要设置 ,您需要 Qdrant 实例中的以下信息: 、 、 和 (如果需要)。QdrantVectorStoreHostGRPC PortCollection NameAPI Keyspring-doc.cn

建议提前创建具有适当尺寸和配置的 Qdrant 集合。 如果未创建集合,则将尝试使用配置的相似性和维度创建一个集合。QdrantVectorStoreCosineEmbeddingModel

自动配置

然后将 Qdrant 启动Starters依赖项添加到您的项目中:spring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

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

矢量存储实现可以为您初始化必要的架构,但您必须通过在相应的构造函数中指定布尔值或在文件中进行设置来选择加入。initializeSchema…​initialize-schema=trueapplication.propertiesspring-doc.cn

这是一个突破性的变化!在早期版本的 Spring AI 中,默认情况下会进行此架构初始化。

Vector Store 还需要一个实例来计算文档的嵌入。 您可以选择一个可用的 EmbeddingModel ImplementationsEmbeddingModelspring-doc.cn

例如,要使用 OpenAI EmbeddingModel,请将以下依赖项添加到您的项目中:spring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 请参阅 Repositories 部分,将 Milestone 和/或 Snapshot Repositories 添加到您的构建文件中。

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

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 Vector Store 并使用它spring-doc.cn

@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-doc.cn

财产 描述 默认值

spring.ai.vectorstore.qdrant.hostspring-doc.cn

Qdrant 服务器的主机。spring-doc.cn

本地主机spring-doc.cn

spring.ai.vectorstore.qdrant.portspring-doc.cn

Qdrant 服务器的 gRPC 端口。spring-doc.cn

6334spring-doc.cn

spring.ai.vectorstore.qdrant.api-keyspring-doc.cn

用于 Qdrant 服务器身份验证的 API 密钥。spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.qdrant.collection-namespring-doc.cn

要在 Qdrant 中使用的集合的名称。spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.qdrant.use-tlsspring-doc.cn

是否使用 TLS(HTTPS)。spring-doc.cn

spring-doc.cn

spring.ai.vectorstore.qdrant.initialize-schemaspring-doc.cn

是否初始化后端 schemaspring-doc.cn

spring-doc.cn

元数据筛选

您可以将通用的可移植元数据过滤器与 Qdrant 矢量存储结合使用。spring-doc.cn

例如,您可以使用文本表达式语言:spring-doc.cn

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

或使用 DSL 以编程方式:Filter.Expressionspring-doc.cn

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 筛选条件

手动配置

您可以手动配置 .为此,您需要将依赖项添加到您的项目中:QdrantVectorStorespring-ai-qdrant-storespring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

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

要在应用程序中配置 Qdrant,您可以创建一个 QdrantClient:spring-doc.cn

@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 Starters添加到您的项目,与 OpenAI 的嵌入集成。 这为您提供了 Embeddings 客户端的实现:spring-doc.cn

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