Skip to main content
Open In ColabOpen on GitHub

Couchbase

Couchbase 是一个屡获殊荣的分布式NoSQL云数据库，为您的所有云、移动、AI和边缘计算应用提供无与伦比的多功能性、性能、可扩展性和财务价值。Couchbase通过为开发人员提供编码辅助和为其应用提供向量搜索来拥抱AI。

向量搜索是Couchbase中全文搜索服务（搜索服务）的一部分。

本教程解释了如何在Couchbase中使用向量搜索。您可以使用Couchbase Capella或自管理的Couchbase Server。

设置​

要访问CouchbaseVectorStore，首先需要安装langchain-couchbase合作伙伴包：

pip install -qU langchain-couchbase

凭证​

前往Couchbase 网站并创建一个新的连接，确保保存您的数据库用户名和密码：

import getpass

COUCHBASE_CONNECTION_STRING = getpass.getpass(
    "Enter the connection string for the Couchbase cluster: "
)
DB_USERNAME = getpass.getpass("Enter the username for the Couchbase cluster: ")
DB_PASSWORD = getpass.getpass("Enter the password for the Couchbase cluster: ")

如果你想获得最佳的模型调用自动追踪功能，你也可以通过取消下面的注释来设置你的LangSmith API密钥：

# os.environ["LANGCHAIN_TRACING_V2"] = "true"
# os.environ["LANGCHAIN_API_KEY"] = getpass.getpass()

初始化​

在实例化之前，我们需要创建一个连接。

创建Couchbase连接对象​

我们首先创建一个到Couchbase集群的连接，然后将集群对象传递给向量存储。

在这里，我们使用上面的用户名和密码进行连接。您也可以使用任何其他支持的方式连接到您的集群。

有关连接到Couchbase集群的更多信息，请查看文档。

from datetime import timedelta

from couchbase.auth import PasswordAuthenticator
from couchbase.cluster import Cluster
from couchbase.options import ClusterOptions

auth = PasswordAuthenticator(DB_USERNAME, DB_PASSWORD)
options = ClusterOptions(auth)
cluster = Cluster(COUCHBASE_CONNECTION_STRING, options)

# Wait until the cluster is ready for use.
cluster.wait_until_ready(timedelta(seconds=5))

我们现在将在Couchbase集群中设置要用于向量搜索的存储桶、范围和集合名称。

对于这个例子，我们使用的是默认的范围和集合。

BUCKET_NAME = "langchain_bucket"
SCOPE_NAME = "_default"
COLLECTION_NAME = "default"
SEARCH_INDEX_NAME = "langchain-test-index"

有关如何创建支持向量字段的搜索索引的详细信息，请参阅文档。

简单实例化​

下面，我们使用集群信息和搜索索引名称创建向量存储对象。

pip install -qU langchain-openai
import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
  os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(model="text-embedding-3-large")
from langchain_couchbase.vectorstores import CouchbaseVectorStore

vector_store = CouchbaseVectorStore(
    cluster=cluster,
    bucket_name=BUCKET_NAME,
    scope_name=SCOPE_NAME,
    collection_name=COLLECTION_NAME,
    embedding=embeddings,
    index_name=SEARCH_INDEX_NAME,
)
API Reference:CouchbaseVectorStore

指定文本和嵌入字段​

您可以选择性地使用text_key和embedding_key字段为文档指定文本和嵌入字段。

vector_store_specific = CouchbaseVectorStore(
    cluster=cluster,
    bucket_name=BUCKET_NAME,
    scope_name=SCOPE_NAME,
    collection_name=COLLECTION_NAME,
    embedding=embeddings,
    index_name=SEARCH_INDEX_NAME,
    text_key="text",
    embedding_key="embedding",
)

管理向量存储​

一旦你创建了你的向量存储，我们可以通过添加和删除不同的项目来与之交互。

添加项目到向量存储​

我们可以使用add_documents函数向我们的向量存储中添加项目。

from uuid import uuid4

from langchain_core.documents import Document

document_1 = Document(
    page_content="I had chocalate chip pancakes and scrambled eggs for breakfast this morning.",
    metadata={"source": "tweet"},
)

document_2 = Document(
    page_content="The weather forecast for tomorrow is cloudy and overcast, with a high of 62 degrees.",
    metadata={"source": "news"},
)

document_3 = Document(
    page_content="Building an exciting new project with LangChain - come check it out!",
    metadata={"source": "tweet"},
)

document_4 = Document(
    page_content="Robbers broke into the city bank and stole $1 million in cash.",
    metadata={"source": "news"},
)

document_5 = Document(
    page_content="Wow! That was an amazing movie. I can't wait to see it again.",
    metadata={"source": "tweet"},
)

document_6 = Document(
    page_content="Is the new iPhone worth the price? Read this review to find out.",
    metadata={"source": "website"},
)

document_7 = Document(
    page_content="The top 10 soccer players in the world right now.",
    metadata={"source": "website"},
)

document_8 = Document(
    page_content="LangGraph is the best framework for building stateful, agentic applications!",
    metadata={"source": "tweet"},
)

document_9 = Document(
    page_content="The stock market is down 500 points today due to fears of a recession.",
    metadata={"source": "news"},
)

document_10 = Document(
    page_content="I have a bad feeling I am going to get deleted :(",
    metadata={"source": "tweet"},
)

documents = [
    document_1,
    document_2,
    document_3,
    document_4,
    document_5,
    document_6,
    document_7,
    document_8,
    document_9,
    document_10,
]
uuids = [str(uuid4()) for _ in range(len(documents))]

vector_store.add_documents(documents=documents, ids=uuids)
API Reference:Document

从向量存储中删除项目​

vector_store.delete(ids=[uuids[-1]])

查询向量存储​

一旦您的向量存储已创建并且相关文档已添加，您很可能希望在链或代理运行期间查询它。

直接查询​

执行简单的相似性搜索可以按如下方式进行：

results = vector_store.similarity_search(
    "LangChain provides abstractions to make working with LLMs easy",
    k=2,
)
for res in results:
    print(f"* {res.page_content} [{res.metadata}]")

带分数的相似性搜索​

你也可以通过调用similarity_search_with_score方法来获取结果的分数。

results = vector_store.similarity_search_with_score("Will it be hot tomorrow?", k=1)
for res, score in results:
    print(f"* [SIM={score:3f}] {res.page_content} [{res.metadata}]")

指定要返回的字段​

您可以在搜索中使用fields参数指定要从文档返回的字段。这些字段作为返回文档中metadata对象的一部分返回。您可以获取存储在搜索索引中的任何字段。文档的text_key作为文档page_content的一部分返回。

如果您没有指定任何要获取的字段，则返回存储在索引中的所有字段。

如果你想获取元数据中的某个字段，你需要使用.来指定它。

例如，要获取元数据中的source字段，您需要指定metadata.source。

query = "What did I eat for breakfast today?"
results = vector_store.similarity_search(query, fields=["metadata.source"])
print(results[0])

混合查询​

Couchbase 允许您通过将向量搜索结果与文档的非向量字段（如 metadata 对象）的搜索结合起来进行混合搜索。

结果将基于向量搜索和搜索服务支持的搜索结果的组合。每个组件搜索的分数相加，得到结果的总分。

要执行混合搜索，有一个可选参数search_options可以传递给所有相似性搜索。
可以在这里找到search_options的不同搜索/查询可能性。

为了模拟混合搜索，让我们从现有文档中创建一些随机元数据。 我们统一向元数据中添加三个字段，date在2010年和2020年之间，rating在1和5之间，author设置为John Doe或Jane Doe。

from langchain_community.document_loaders import TextLoader
from langchain_text_splitters import CharacterTextSplitter

loader = TextLoader("../../how_to/state_of_the_union.txt")
documents = loader.load()
text_splitter = CharacterTextSplitter(chunk_size=500, chunk_overlap=0)
docs = text_splitter.split_documents(documents)

# Adding metadata to documents
for i, doc in enumerate(docs):
    doc.metadata["date"] = f"{range(2010, 2020)[i % 10]}-01-01"
    doc.metadata["rating"] = range(1, 6)[i % 5]
    doc.metadata["author"] = ["John Doe", "Jane Doe"][i % 2]

vector_store.add_documents(docs)

query = "What did the president say about Ketanji Brown Jackson"
results = vector_store.similarity_search(query)
print(results[0].metadata)

按精确值查询​

我们可以在metadata对象中的作者等文本字段上搜索完全匹配的内容。

query = "What did the president say about Ketanji Brown Jackson"
results = vector_store.similarity_search(
    query,
    search_options={"query": {"field": "metadata.author", "match": "John Doe"}},
    fields=["metadata.author"],
)
print(results[0])

部分匹配查询​

我们可以通过为搜索指定模糊性来搜索部分匹配。当您想要搜索搜索查询的轻微变化或拼写错误时，这非常有用。

在这里，“Jae”与“Jane”接近（模糊度为1）。

query = "What did the president say about Ketanji Brown Jackson"
results = vector_store.similarity_search(
    query,
    search_options={
        "query": {"field": "metadata.author", "match": "Jae", "fuzziness": 1}
    },
    fields=["metadata.author"],
)
print(results[0])

按日期范围查询​

我们可以在日期字段上搜索位于日期范围内的文档，例如 metadata.date。

query = "Any mention about independence?"
results = vector_store.similarity_search(
    query,
    search_options={
        "query": {
            "start": "2016-12-31",
            "end": "2017-01-02",
            "inclusive_start": True,
            "inclusive_end": False,
            "field": "metadata.date",
        }
    },
)
print(results[0])

按数值范围查询​

我们可以搜索在数值字段范围内的文档，例如 metadata.rating。

query = "Any mention about independence?"
results = vector_store.similarity_search_with_score(
    query,
    search_options={
        "query": {
            "min": 3,
            "max": 5,
            "inclusive_min": True,
            "inclusive_max": True,
            "field": "metadata.rating",
        }
    },
)
print(results[0])

组合多个搜索查询​

不同的搜索查询可以使用AND（连接词）或OR（分离词）运算符进行组合。

在这个例子中，我们正在检查评分在3到4之间且日期在2015到2018年之间的文档。

query = "Any mention about independence?"
results = vector_store.similarity_search_with_score(
    query,
    search_options={
        "query": {
            "conjuncts": [
                {"min": 3, "max": 4, "inclusive_max": True, "field": "metadata.rating"},
                {"start": "2016-12-31", "end": "2017-01-02", "field": "metadata.date"},
            ]
        }
    },
)
print(results[0])

其他查询​

同样，您可以在search_options参数中使用任何支持的查询方法，如地理距离、多边形搜索、通配符、正则表达式等。请参阅文档以获取有关可用查询方法及其语法的更多详细信息。

通过转换为检索器进行查询​

你也可以将向量存储转换为检索器，以便在你的链中更轻松地使用。

以下是如何将您的向量存储转换为检索器，然后使用简单的查询和过滤器调用检索器。

retriever = vector_store.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={"k": 1, "score_threshold": 0.5},
)
retriever.invoke("Stealing from the bank is a crime", filter={"source": "news"})

检索增强生成的使用​

有关如何使用此向量存储进行检索增强生成（RAG）的指南，请参阅以下部分：

常见问题解答

问题：在创建CouchbaseVectorStore对象之前，我应该先创建搜索索引吗？​

是的，目前你需要在创建CouchbaseVectoreStore对象之前创建搜索索引。

问题：我在搜索结果中没有看到我指定的所有字段。​

在Couchbase中，我们只能返回存储在搜索索引中的字段。请确保您在搜索结果中尝试访问的字段是搜索索引的一部分。

处理这个问题的一种方法是动态地在索引中索引和存储文档的字段。

  • 在Capella中，您需要进入“高级模式”，然后在“常规设置”下的chevron中，您可以勾选“[X] 存储动态字段”或“[X] 索引动态字段”
  • 在Couchbase Server中，在索引编辑器（非快速编辑器）中的“高级”选项下，您可以勾选“[X] 存储动态字段”或“[X] 索引动态字段”

请注意，这些选项将增加索引的大小。

有关动态映射的更多详细信息，请参阅文档。

问题：我在搜索结果中无法看到元数据对象。​

这很可能是由于文档中的metadata字段未被Couchbase搜索索引索引和/或存储。为了索引文档中的metadata字段，您需要将其作为子映射添加到索引中。

如果您选择映射映射中的所有字段，您将能够通过所有元数据字段进行搜索。或者，为了优化索引，您可以选择metadata对象中的特定字段进行索引。您可以参考文档以了解更多关于索引子映射的信息。

创建子映射

API 参考​

有关所有CouchbaseVectorStore功能和配置的详细文档，请访问API参考：https://python.langchain.com/api_reference/couchbase/vectorstores/langchain_couchbase.vectorstores.CouchbaseVectorStore.html

这个页面有帮助吗？