Couchbase

本节将引导您完成 CouchbaseSearchVectorStore 的设置，以存储文档嵌入并使用 Couchbase 执行相似性搜索。 Couchbase 是一个分布式 JSON 文档数据库，具有关系型 DBMS 的所有所需功能。除其他功能外，它允许用户使用基于向量的存储和检索来查询信息。

先决条件

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

自动配置

Spring AI 自动配置、启动器模块的 artifact 名称发生了重大变化。 有关更多信息，请参阅 升级说明。

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 添加到您的构建文件中。

请参阅 Artifact 仓库 部分，将里程碑和/或快照仓库添加到您的构建文件中。

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

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

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

此外，您还需要一个配置好的 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")));

// Add the documents to Qdrant
vectorStore.add(documents);

// Retrieve documents similar to a query
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 引用它们：

# In application.yml
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}
  couchbase:
    connection-string: ${COUCHBASE_CONN_STRING}
    username: ${COUCHBASE_USER}
    password: ${COUCHBASE_PASSWORD}
# In your environment or .env file
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”该文件，即 source <your_script_name>.sh。

Couchbase Cluster 的 Spring Boot 自动配置功能将创建一个 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 存储。

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

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();
}

// This can be any EmbeddingModel implementation.
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(OpenAiApi.builder().apiKey(this.openaiKey).build());
}

限制

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