langchain_community.vectorstores.couchbase.CouchbaseVectorStore

class langchain_community.vectorstores.couchbase.CouchbaseVectorStore(cluster: Cluster, bucket_name: str, scope_name: str, collection_name: str, embedding: Embeddings, index_name: str, *, text_key: Optional[str] = 'text', embedding_key: Optional[str] = 'embedding', scoped_index: bool = True)[source]

Couchbase Vector Store 矢量存储。

要使用它，您需要 - 最新版本的 couchbase 库的安装 - 具有预定义搜索索引且支持矢量字段的 Couchbase 数据库

示例:
from langchain_community.vectorstores import CouchbaseVectorStore
from langchain_openai import OpenAIEmbeddings

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

auth = PasswordAuthenticator(username, password)
options = ClusterOptions(auth)
connect_string = "couchbases://localhost"
cluster = Cluster(connect_string, options)

# 等待集群准备就绪。
cluster.wait_until_ready(timedelta(seconds=5))

embeddings = OpenAIEmbeddings()

vectorstore = CouchbaseVectorStore(
    cluster=cluster,
    bucket_name="",
    scope_name="",
    collection_name="",
    embedding=embeddings,
    index_name="vector-index",
)

vectorstore.add_texts(["hello", "world"])
results = vectorstore.similarity_search("ola", k=1)

初始化Couchbase向量存储。

参数：

cluster (Cluster): 具有活动连接的Couchbase集群对象。 bucket_name (str): 存储文档的桶名称。 scope_name (str): 存储文档的作用域中的作用域名称。 collection_name (str): 存储文档的作用域中的集合名称。 embedding (Embeddings): 要使用的嵌入函数。 index_name (str): 要使用的搜索索引的名称。 text_key (optional[str]): 用作文本的文档中的键。

默认设置为text。

embedding_key (optional[str]): 用于嵌入的文档中的键。

默认设置为embedding。

scoped_index (optional[bool]): 指定索引是否为作用域索引。

默认设置为True。

Attributes

DEFAULT_BATCH_SIZE

embeddings

返回查询嵌入对象。

Methods

__init__(cluster, bucket_name, scope_name, ...)

初始化Couchbase向量存储。

aadd_documents(documents, **kwargs)

运行更多的文档通过嵌入并添加到向量存储中。

aadd_texts(texts[, metadatas])

运行更多的文本通过嵌入，并添加到向量存储中。

add_documents(documents, **kwargs)

运行更多的文档通过嵌入并添加到向量存储中。

add_texts(texts[, metadatas, ids, batch_size])

通过嵌入将文本传递并持久化在向量存储中。

adelete([ids])

根据向量ID或其他条件进行删除。

afrom_documents(documents, embedding, **kwargs)

返回从文档和嵌入初始化的VectorStore。

afrom_texts(texts, embedding[, metadatas])

返回从文本和嵌入初始化的VectorStore。

amax_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

amax_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

as_retriever(**kwargs)

返回从此VectorStore初始化的VectorStoreRetriever。

asearch(query, search_type, **kwargs)

返回使用指定搜索类型的查询最相似的文档。

asimilarity_search(query[, k])

返回与查询最相似的文档。

asimilarity_search_by_vector(embedding[, k])

返回与嵌入向量最相似的文档。

asimilarity_search_with_relevance_scores(query)

返回文档和相关性分数在范围[0, 1]内，异步执行。

asimilarity_search_with_score(*args, **kwargs)

使用异步方式运行相似性搜索与距离。

delete([ids])

通过ids从向量存储中删除文档。

from_documents(documents, embedding, **kwargs)

返回从文档和嵌入初始化的VectorStore。

from_texts(texts, embedding[, metadatas])

从文本列表构建一个Couchbase向量存储。

max_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

max_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

search(query, search_type, **kwargs)

返回使用指定搜索类型的查询最相似的文档。

similarity_search(query[, k, search_options])

返回与嵌入向量最相似的文档及其分数。

similarity_search_by_vector(embedding[, k, ...])

返回与向量嵌入最相似的文档。

similarity_search_with_relevance_scores(query)

返回文档和相关性得分在[0, 1]范围内。

similarity_search_with_score(query[, k, ...])

返回与查询最相似的文档及其分数。

similarity_search_with_score_by_vector(embedding)

返回与嵌入向量最相似的文档及其分数。
Parameters

  • cluster (Cluster) –

  • bucket_name (str) –

  • scope_name (str) –

  • collection_name (str) –

  • embedding (Embeddings) –

  • index_name (str) –

  • text_key (Optional[str]) –

  • embedding_key (Optional[str]) –

  • scoped_index (bool) –

Return type

None

__init__(cluster: Cluster, bucket_name: str, scope_name: str, collection_name: str, embedding: Embeddings, index_name: str, *, text_key: Optional[str] = 'text', embedding_key: Optional[str] = 'embedding', scoped_index: bool = True) → None[source]

初始化Couchbase向量存储。

参数：

cluster (Cluster): 具有活动连接的Couchbase集群对象。 bucket_name (str): 存储文档的桶名称。 scope_name (str): 存储文档的作用域中的作用域名称。 collection_name (str): 存储文档的作用域中的集合名称。 embedding (Embeddings): 要使用的嵌入函数。 index_name (str): 要使用的搜索索引的名称。 text_key (optional[str]): 用作文本的文档中的键。

默认设置为text。

embedding_key (optional[str]): 用于嵌入的文档中的键。

默认设置为embedding。

scoped_index (optional[bool]): 指定索引是否为作用域索引。

默认设置为True。

Parameters

  • cluster (Cluster) –

  • bucket_name (str) –

  • scope_name (str) –

  • collection_name (str) –

  • embedding (Embeddings) –

  • index_name (str) –

  • text_key (Optional[str]) –

  • embedding_key (Optional[str]) –

  • scoped_index (bool) –

Return type

None

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]

运行更多的文档通过嵌入并添加到向量存储中。

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]

运行更多的文本通过嵌入，并添加到向量存储中。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]

运行更多的文档通过嵌入并添加到向量存储中。

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[Dict[str, Any]]] = None, ids: Optional[List[str]] = None, batch_size: Optional[int] = None, **kwargs: Any) → List[str][source]

通过嵌入将文本传递并持久化在向量存储中。

如果传递了文档ID，则现有文档（如果有）将被新文档覆盖。

参数：

texts（Iterable[str]）：要添加到向量存储中的字符串的可迭代对象。 metadatas（Optional[List[Dict]]）：与文本相关的元数据的可选列表。 ids（Optional[List[str]）：与文本相关的ID的可选列表。

ID必须是整个集合中的唯一字符串。 如果未指定，将生成并使用uuid作为ID。

batch_size（Optional[int]）：用于批量插入的可选批量大小。

默认值为100。

返回：

List[str]：将文本添加到向量存储中的ID列表。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[Dict[str, Any]]]) –

  • ids (Optional[List[str]]) –

  • batch_size (Optional[int]) –

  • kwargs (Any) –

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]

根据向量ID或其他条件进行删除。

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters
Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST

返回从文本和嵌入初始化的VectorStore。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

VST

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]

返回使用最大边际相关性选择的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回从此VectorStore初始化的VectorStoreRetriever。

参数：
search_type（可选[str]）：定义Retriever应执行的搜索类型。

可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。

search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：

k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)
Parameters

kwargs (Any) –

Return type

VectorStoreRetriever

async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]

返回使用指定搜索类型的查询最相似的文档。

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

返回与查询最相似的文档。

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]

返回与嵌入向量最相似的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关性分数在范围[0, 1]内，异步执行。

0表示不相似，1表示最相似。

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似度分数）的列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]

使用异步方式运行相似性搜索与距离。

Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

delete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool][source]

通过ids从向量存储中删除文档。

参数:

ids (List[str]): 要删除的文档的ID列表。 batch_size (Optional[int]): 批量删除的可选批量大小。

返回:

bool: 如果所有文档都成功删除，则为True，否则为False。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters
Return type

VST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[Dict[Any, Any]]] = None, **kwargs: Any) → CouchbaseVectorStore[source]

从文本列表构建一个Couchbase向量存储。

示例：

from langchain_community.vectorstores import CouchbaseVectorStore from langchain_openai import OpenAIEmbeddings

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

auth = PasswordAuthenticator(username, password) options = ClusterOptions(auth) connect_string = “couchbases://localhost” cluster = Cluster(connect_string, options)

# 等待集群准备就绪。 cluster.wait_until_ready(timedelta(seconds=5))

embeddings = OpenAIEmbeddings()

texts = [“hello”, “world”]

vectorstore = CouchbaseVectorStore.from_texts(

texts, embedding=embeddings, cluster=cluster, bucket_name=””, scope_name=””, collection_name=””, index_name=”vector-index”,

)

参数:

texts (List[str]): 要添加到向量存储的文本列表。 embedding (Embeddings): 要使用的嵌入函数。 metadatas (optional[List[Dict]): 要添加到文档的元数据列表。 **kwargs: 用于初始化向量存储和/或传递给`add_texts`方法的关键字参数。检查构造函数和/或`add_texts`以获取接受的参数列表。

返回:

一个Couchbase向量存储。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[Dict[Any, Any]]]) –

  • kwargs (Any) –

Return type

CouchbaseVectorStore

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]

返回使用指定搜索类型的查询最相似的文档。

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

返回与嵌入向量最相似的文档及其分数。

参数：

query（str）：要查找相似文档的查询 k（int）：要返回的文档数量。

默认为4。

search_options（Optional[Dict[str, Any]]）：可选的搜索选项，将其传递给Couchbase搜索。

默认为空字典

fields（Optional[List[str]]）：要包含在结果元数据中的可选字段列表。请注意，这些字段需要存储在索引中。

如果未指定任何内容，则默认为索引中存储的所有字段。

返回：

与查询最相似的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • search_options (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, search_options: Optional[Dict[str, Any]] = {}, **kwargs: Any) → List[Document][source]

返回与向量嵌入最相似的文档。

参数:

embedding (List[float]): 要查找相似文档的嵌入。 k (int): 要返回的文档数量。

默认为4。

search_options (Optional[Dict[str, Any]]): 可选的搜索选项，会传递给Couchbase搜索。

默认为空字典。

fields (Optional[List[str]]): 要包含在结果元数据中的可选字段列表。请注意，这些字段需要在索引中存储。

如果未指定任何内容，则默认为文档文本和元数据字段。

返回:

与查询最相似的文档列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • search_options (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关性得分在[0, 1]范围内。

0表示不相似，1表示最相似。

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似性得分）

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, search_options: Optional[Dict[str, Any]] = {}, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与查询最相似的文档及其分数。

参数：

query（str）：要查找相似文档的查询 k（int）：要返回的文档数量。

默认为4。

search_options（Optional[Dict[str, Any]]）：传递给Couchbase搜索的可选搜索选项。

默认为空字典。

fields（Optional[List[str]]）：要包含在结果元数据中的可选字段列表。请注意，这些字段需要存储在索引中。

如果未指定任何内容，则默认为文本和元数据字段。

返回：

与查询最相似的文档及其分数的列表。

Parameters

  • query (str) –

  • k (int) –

  • search_options (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, search_options: Optional[Dict[str, Any]] = {}, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与嵌入向量最相似的文档及其分数。

参数:

embedding (List[float]): 要查找与之相似文档的嵌入向量。 k (int): 要返回的文档数量。

默认为4。

search_options (Optional[Dict[str, Any]]): 可选的搜索选项，将其传递给Couchbase搜索。

默认为空字典。

fields (Optional[List[str]]): 要包含在结果元数据中的字段的可选列表。请注意，这些字段需要存储在索引中。

如果未指定任何内容，则默认为索引中存储的所有字段。

返回:

与查询向量最相似的文档及其分数的列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • search_options (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using CouchbaseVectorStore