Couchbase

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

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

前提条件

运行中的 Couchbase 实例。以下选项可用： Couchbase * Docker * Capella - Couchbase 即服务 * 本地安装 Couchbase * Couchbase Kubernetes Operator

自动配置

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

Spring AI 为 Couchbase 向量存储提供了 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 向量搜索仅在 7.6 版本和 Java SDK 3.6.0 版本中可用。

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

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

向量存储实现可以使用默认选项为您初始化配置的 bucket、scope、collection 和搜索索引，但您必须通过在适当的构造函数中指定 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 表达式语言 (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 连接字符串，如 couchbase://localhost>
export COUCHBASE_USER=<couchbase 用户名>
export COUCHBASE_PASSWORD=<couchbase 密码>

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

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

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

这种方法让您可以灵活地命名环境变量，同时将敏感信息排除在应用程序配置文件之外。

注意：如果您选择创建一个 shell 脚本以便将来工作，请确保在启动应用程序之前通过"source"文件运行它，即 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

Bucket 连接超时。

10s

spring.couchbase.env.timeouts.disconnect

Bucket 断开连接超时。

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 Bucket 的名称，scope 的父级。

default

spring.ai.vectorstore.couchbase.scope-name

Couchbase scope 的名称，collection 的父级。搜索查询将在 scope 上下文中执行。

default

spring.ai.vectorstore.couchbase.collection-name

存储文档的 Couchbase collection 的名称。

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 存储。

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

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 文档 了解更多关于自定义 Cluster 实例配置的信息。

@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 服务：Data、Query、Index、Search。虽然 Data 和 Search 可能足够，但 Query 和 Index 对于支持完整的元数据过滤机制是必要的。