12.2 Couchbase 向量存储Couchbase 向量存储概述本节将指导您完成设置 CouchbaseSea

Couchbase 向量存储

概述

本节将指导您完成设置 CouchbaseSearchVectorStore 来存储文档嵌入并使用 Couchbase 执行相似性搜索。

Couchbase 是一个分布式的 JSON 文档数据库，具有关系型 DBMS 的所有所需功能。除其他功能外，它允许用户使用基于向量的存储和检索来查询信息。

前提条件

一个正在运行的 Couchbase 实例。有以下选项可用：

自动配置

注意

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

Spring AI 为 Couchbase Vector Store 提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-vector-store-couchbase</artifactId>
</dependency>

或者添加到您的 Gradle build.gradle 构建文件中：

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

注意

Couchbase Vector search 仅在 7.6 版本和 Java SDK 3.6.0 版本开始可用

提示

请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

提示

请参考工件仓库部分，将 Milestone 和/或 Snapshot 仓库添加到您的构建文件中。

向量存储实现可以使用默认选项为您初始化配置的存储桶、作用域、集合和搜索索引，但您必须通过在适当的构造函数中指定 initializeSchema 布尔值来选择加入。

注意

这是一个破坏性变更！在早期版本的 Spring AI 中，此模式初始化默认发生。

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

此外，您需要一个配置的 EmbeddingModel bean。有关更多信息，请参阅 EmbeddingModel 部分。

现在您可以在应用程序中自动装配 CouchbaseSearchVectorStore 作为向量存储：

@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")));

// 将文档添加到 Qdrant
vectorStore.add(documents);

// 检索与查询相似的文档
List<Document> results = vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

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

spring.ai.openai.api-key=<key>
spring.couchbase.connection-string=<conn_string>
spring.couchbase.username=<username>
spring.couchbase.password=<password>

如果您更喜欢使用环境变量来处理密码或 API 密钥等敏感信息，您有多个选择：

选项 1：使用 Spring Expression Language (SpEL)

您可以使用自定义环境变量名称，并使用 SpEL 在应用程序配置中引用它们：

# 在 application.yml 中
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}
  couchbase:
    connection-string: ${COUCHBASE_CONN_STRING}
    username: ${COUCHBASE_USER}
    password: ${COUCHBASE_PASSWORD}

# 在您的环境或 .env 文件中
export OPENAI_API_KEY=<api-key>
export COUCHBASE_CONN_STRING=<couchbase connection string like couchbase://localhost>
export COUCHBASE_USER=<couchbase username>
export COUCHBASE_PASSWORD=<couchbase password>

选项 2：以编程方式访问环境变量

或者，您可以在 Java 代码中访问环境变量：

String apiKey = System.getenv("OPENAI_API_KEY");

这种方法在命名环境变量时为您提供了灵活性，同时将敏感信息排除在应用程序配置文件之外。

注意

如果您选择创建 shell 脚本以便将来工作，请确保在启动应用程序之前通过"获取"文件来运行它，即 source <your_script_name>.sh。

Spring Boot 的 Couchbase Cluster 自动配置功能将创建一个 bean 实例，该实例将被 CouchbaseSearchVectorStore 使用。

以 spring.couchbase.* 开头的 Spring Boot 属性用于配置 Couchbase 集群实例：

属性	描述	默认值
`spring.couchbase.connection-string`	Couchbase 连接字符串	`couchbase://localhost`
`spring.couchbase.password`	用于 Couchbase 身份验证的密码	-
`spring.couchbase.username`	用于 Couchbase 身份验证的用户名	-
`spring.couchbase.env.io.minEndpoints`	每个节点的最小套接字数	1
`spring.couchbase.env.io.maxEndpoints`	每个节点的最大套接字数	12
`spring.couchbase.env.io.idleHttpConnectionTimeout`	HTTP 连接在被关闭并从池中移除之前可以保持空闲的时间长度	1s
`spring.couchbase.env.ssl.enabled`	是否启用 SSL 支持。如果提供了"bundle"且另有说明，则自动启用	-
`spring.couchbase.env.ssl.bundle`	SSL bundle 名称	-
`spring.couchbase.env.timeouts.connect`	存储桶连接超时	10s
`spring.couchbase.env.timeouts.disconnect`	存储桶断开连接超时	10s
`spring.couchbase.env.timeouts.key-value`	特定键值操作的超时	2500ms
`spring.couchbase.env.timeouts.key-value`	具有持久性级别的特定键值操作的超时	10s
`spring.couchbase.env.timeouts.key-value-durable`	具有持久性级别的特定键值操作的超时	10s
`spring.couchbase.env.timeouts.query`	SQL++ 查询操作超时	75s
`spring.couchbase.env.timeouts.view`	常规和地理空间视图操作超时	75s
`spring.couchbase.env.timeouts.search`	搜索服务的超时	75s
`spring.couchbase.env.timeouts.analytics`	分析服务的超时	75s
`spring.couchbase.env.timeouts.management`	管理操作的超时	75s

以 spring.ai.vectorstore.couchbase.* 前缀开头的属性用于配置 CouchbaseSearchVectorStore：

属性	描述	默认值
`spring.ai.vectorstore.couchbase.index-name`	用于存储向量的索引名称	spring-ai-document-index
`spring.ai.vectorstore.couchbase.bucket-name`	Couchbase 存储桶的名称，作用域的父级	default
`spring.ai.vectorstore.couchbase.scope-name`	Couchbase 作用域的名称，集合的父级。搜索查询将在作用域上下文中执行	default
`spring.ai.vectorstore.couchbase.collection-name`	用于存储文档的 Couchbase 集合的名称	default
`spring.ai.vectorstore.couchbase.dimensions`	向量中的维度数	1536
`spring.ai.vectorstore.couchbase.similarity`	要使用的相似度函数	`dot_product`
`spring.ai.vectorstore.couchbase.optimization`	要使用的相似度函数	`recall`
`spring.ai.vectorstore.couchbase.initialize-schema`	是否初始化所需的模式	`false`

以下相似度函数可用：

l2_norm
dot_product

以下索引优化可用：

recall
latency

有关每种函数的更多详细信息，请参阅 Couchbase 文档关于向量搜索的内容。

元数据过滤

您也可以利用通用的、可移植的元数据过滤器与 Couchbase store 一起使用。

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

vectorStore.similaritySearch(
    SearchRequest.defaults()
    .query("The World")
    .topK(TOP_K)
    .filterExpression("author in ['john', 'jill'] && article_type == 'blog'"));

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

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
    .query("The World")
    .topK(TOP_K)
    .filterExpression(b.and(
        b.in("author","john", "jill"),
        b.eq("article_type", "blog")).build()));

注意

这些过滤器表达式被转换为等效的 Couchbase SQL++ 过滤器。

手动配置

不使用 Spring Boot 自动配置，您也可以手动配置 Couchbase 向量存储。为此，您需要将 spring-ai-couchbase-store 添加到您的项目中：

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

或者添加到您的 Gradle build.gradle 构建文件中：

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

创建 Couchbase Cluster bean。阅读 Couchbase 文档获取有关自定义集群实例配置的更深入信息。

@Bean
public Cluster cluster() {
    return Cluster.connect("couchbase://localhost", "username", "password");
}

然后使用构建器模式创建 CouchbaseSearchVectorStore bean：

@Bean
public VectorStore couchbaseSearchVectorStore(Cluster cluster,
                                              EmbeddingModel embeddingModel,
                                              Boolean initializeSchema) {
    return CouchbaseSearchVectorStore
            .builder(cluster, embeddingModel)
            .bucketName("test")
            .scopeName("test")
            .collectionName("test")
            .initializeSchema(initializeSchema)
            .build();
}

// 这可以是任何 EmbeddingModel 实现。
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(OpenAiApi.builder().apiKey(this.openaiKey).build());
}

限制

注意

必须激活以下 Couchbase 服务：数据、查询、索引、搜索。虽然数据和搜索可能足够，但查询和索引对于支持完整的元数据过滤机制是必需的。