`langchain_community.graph_vectorstores.cassandra`.CassandraGraphVectorStore¶

class langchain_community.graph_vectorstores.cassandra.CassandraGraphVectorStore(embedding: Embeddings, *, node_table: str = 'graph_nodes', session: Optional[Session] = None, keyspace: Optional[str] = None, setup_mode: SetupMode = SetupMode.SYNC)[源代码]¶

创建混合图存储。

参数

embedding (Embeddings) – 用于文档内容的嵌入。
setup_mode (SetupMode) – 用于创建Cassandra表的模式（SYNC、ASYNC或OFF）。
node_table (str) –
session (可选[Session]) –
keyspace (可选[str]) –

属性

embeddings

访问可用的查询嵌入对象。

方法

`__init__`(embedding, *[, node_table, ...])	创建混合图存储。
`aadd_documents`(documents, **kwargs)	将更多文档通过嵌入查询并添加到向量存储。
`aadd_nodes`(nodes, **kwargs)	将节点添加到图存储。
`aadd_texts`(texts[, metadatas, ids])	运行更多文本通过嵌入并将其添加到向量存储中。
`add_documents`(documents, **kwargs)	将更多文档通过嵌入查询并添加到向量存储。
`add_nodes`(nodes, **kwargs)	将节点添加到图存储。
`add_texts`(texts[, metadatas, ids])	运行更多文本通过嵌入并将其添加到向量存储中。
`adelete`([ids])	异步通过向量和其它标准进行删除。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	异步返回从文本和嵌入初始化的VectorStore。
`aget_by_ids`(ids, /)	异步通过ID获取文档。
`amax_marginal_relevance_search`(query[, k, ...])	异步返回使用最大边缘相关性的文档。
`amax_marginal_relevance_search_by_vector`(...)	异步返回使用最大边缘相关性的文档。
`ammr_traversal_search`(query, *[, k, depth, ...])	使用MMR遍历从此图形存储中检索文档。
`as_retriever`(**kwargs)	返回从此GraphVectorStore初始化的GraphVectorStoreRetriever。
`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)	异步运行带距离的相似度搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`atraversal_search`(query, *[, k, depth])	从遍历此图存储中检索文档。
`aupsert`(items, /, **kwargs)
`delete`([ids])	根据向量和其它标准进行删除。
`from_documents`(documents, embedding[, ids])	返回从文档和嵌入初始化的CassandraGraphVectorStore。
`from_texts`(texts, embedding[, metadatas, ids])	返回从文本和嵌入初始化的CassandraGraphVectorStore。
`get_by_ids`(ids, /)	通过其ID获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关度选择的文档。
`按向量执行最大边际相关度搜索`(...)	返回使用最大边际相关度选择的文档。
`mmr_traversal_search`(query, *[, k, depth, ...])	使用MMR遍历从此图形存储中检索文档。
`search`(query, search_type, **kwargs)	使用特定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k])	返回与查询最相似的文档。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回范围 [0, 1] 内的文档及相关度分数。
`similarity_search_with_score`(args, *kwargs)	使用距离运行相似度搜索。
`streaming_upsert`(items, /, batch_size, **kwargs)
`traversal_search`(query, *[, k, depth])	从遍历此图存储中检索文档。
`upsert`(items, /, **kwargs)

__init__(embedding: Embeddings, *, node_table: str = 'graph_nodes', session: Optional[Session] = None, keyspace: Optional[str] = None, setup_mode: SetupMode = SetupMode.SYNC)[source]¶

创建混合图存储。

参数

embedding (Embeddings) – 用于文档内容的嵌入。
setup_mode (SetupMode) – 用于创建Cassandra表的模式（SYNC、ASYNC或OFF）。
node_table (str) –
session (可选[Session]) –
keyspace (可选[str]) –

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

将更多文档通过嵌入查询并添加到向量存储。

存在于文档元数据字段 links 中的链接将被提取以创建 Node 链接。

例如，如果节点 a 和 b 通过超链接 https://some-url 连接，函数调用将如下所示

store.add_documents(
    [
        Document(
            id="a",
            page_content="some text a",
            metadata={
                "links": [
                    Link.incoming(kind="hyperlink", tag="http://some-url")
                ]
            }
        ),
        Document(
            id="b",
            page_content="some text b",
            metadata={
                "links": [
                    Link.outgoing(kind="hyperlink", tag="http://some-url")
                ]
            }
        ),
    ]

)

参数

documents (可迭代对象[Document]) – 需要添加到向量存储中的文档。文档的元数据键 links 应为一个 Link 的可迭代对象。
kwargs (任何类型) –

返回值

添加文本的ID列表。

返回类型

字符串列表

async aadd_nodes(nodes: 可迭代对象[Node], **kwargs: 任何类型) → AsyncIterable[str]¶

将节点添加到图存储。

参数

nodes (可迭代对象[Node]) – 要添加的节点。
kwargs (任何类型) –

返回类型

AsyncIterable[str]

async aadd_texts(texts: 可迭代对象[str], metadatas: Optional[可迭代对象[dict]]] = None, *, ids: Optional[可迭代对象[str]] = None, **kwargs: 任何类型) → 列表[str]¶

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

元数据字段 links 中存在的链接将被提取以创建 Node 链接。

例如，如果节点 a 和 b 通过超链接 https://some-url 连接，函数调用将如下所示

await store.aadd_texts(
    ids=["a", "b"],
    texts=["some text a", "some text b"],
    metadatas=[
        {
            "links": [
                Link.incoming(kind="hyperlink", tag="https://some-url")
            ]
        },
        {
            "links": [
                Link.outgoing(kind="hyperlink", tag="https://some-url")
            ]
        },
    ],
)

参数

texts (可迭代对象[str]) – 要添加到向量存储中的字符串可迭代对象。
metadatas (可选[可迭代对象[dict]]) – 可选的与文本关联的元数据列表。元数据键 links 应为一个 Link 的可迭代对象。
**kwargs (任何类型) – 向量存储特定参数。
ids (可选[可迭代对象[str]]) –
**kwargs –

返回值

将文本添加到向量存储中的ID列表。

返回类型

字符串列表

add_documents（documents: Iterable[Document]）→ List[str]¶

将更多文档通过嵌入查询并添加到向量存储。

存在于文档元数据字段 links 中的链接将被提取以创建 Node 链接。

例如，如果节点 a 和 b 通过超链接 https://some-url 连接，函数调用将如下所示

store.add_documents(
    [
        Document(
            id="a",
            page_content="some text a",
            metadata={
                "links": [
                    Link.incoming(kind="hyperlink", tag="http://some-url")
                ]
            }
        ),
        Document(
            id="b",
            page_content="some text b",
            metadata={
                "links": [
                    Link.outgoing(kind="hyperlink", tag="http://some-url")
                ]
            }
        ),
    ]

)

参数

documents (可迭代对象[Document]) – 需要添加到向量存储中的文档。文档的元数据键 links 应为一个 Link 的可迭代对象。
kwargs (任何类型) –

返回值

添加文本的ID列表。

返回类型

字符串列表

add_nodes（nodes: Iterable[Node]）→ Iterable[str][源代码]¶

将节点添加到图存储。

参数

nodes (可迭代对象[Node]) – 要添加的节点。
kwargs (任何类型) –

返回类型

可迭代[str]

add_texts（texts: Iterable[str]，: 运行更多文本通过嵌入并将其添加到向量存储中。

元数据字段 links 中存在的链接将被提取以创建 Node 链接。

例如，如果节点 a 和 b 通过超链接 https://some-url 连接，函数调用将如下所示

store.add_texts( ids=["a", "b"], texts=["some text a", "some text b"], metadatas=[ { "links": [ Link.incoming(kind="hyperlink", tag="https://some-url") ] }, { "links": [ Link.outgoing(kind="hyperlink", tag="https://some-url") ] }, ], )

参数

texts (可迭代对象[str]) – 要添加到向量存储中的字符串可迭代对象。

metadatas (可选[可迭代对象[dict]]) – 可选的与文本关联的元数据列表。元数据键 links 应为一个 Link 的可迭代对象。

**kwargs (任何类型) – 向量存储特定参数。

ids (可选[可迭代对象[str]]) –

**kwargs –

返回值

将文本添加到向量存储中的ID列表。

返回类型

字符串列表

async adelete（ids： Optional[List[str]] = None, **kwargs： Any）→ Optional[bool]¶

异步通过向量和其它标准进行删除。

参数

ids （可选[列表[字符串]]）- 要删除的 id 列表。如果为 None，则删除所有。默认为 None。

**kwargs （任何）- 子类可能会使用的其他关键字参数。

返回值

如果删除成功，则返回 True，否则返回 False，如果没有实现，则返回 None。

返回类型

Optional[bool]

async classmethod afrom_documents（documents： List[Document], embedding： Embeddings, **kwargs： Any）→ VST¶

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

参数

documents （列表[Document]）- 要添加到向量存储的文档列表。

embedding （Embeddings）- 要使用的嵌入函数。

kwargs （任何）- 其他关键字参数。

返回值

从文档和嵌入初始化的向量存储。

返回类型

VectorStore

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

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

参数

texts (List[str]) – 要添加到向量存储中的文本。

embedding （Embeddings）- 要使用的嵌入函数。

metadatas (Optional[List[dict]]) – 与文本相关联的元数据列表（可选）。默认为 None。

kwargs （任何）- 其他关键字参数。

返回值

从文本和嵌入初始化的向量存储。

返回类型

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List[Document]¶

异步通过ID获取文档。

返回的文档预期将具有 ID 字段设置为向量存储中的文档 ID。

如果某些 ID 未找到或存在重复 ID，则可能返回的文档少于请求的数量。

用户不应假设返回的文档的顺序与输入 ID 的顺序相同。相反，用户应依赖于返回文档的 ID 字段。

如果某些 ID 对应的文档未找到，此方法**不应**引发异常。

参数

ids (Sequence[str]) – 要检索的 ID 列表。

返回值

Document 列表。

返回类型

Document 列表

新功能自 0.2.11 版本起。

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

异步返回使用最大边缘相关性的文档。

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

参数

查询 (字符串) – 查找与文本相似的文档。

k (整数) – 返回的文档数量。默认为4。

fetch_k (整数) – 将传递给MMR算法的文档数量。默认为20。

lambda_mult (浮点数) – 0到1之间的值，用于确定结果中多样性的程度，0代表最大多样性，1代表最小多样性。默认为0.5。

kwargs (任何类型) –

返回值

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

返回类型

Document 列表

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

异步返回使用最大边缘相关性的文档。

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

参数

嵌入 (列表[浮点数]) – 查找与嵌入相似的文档。

k (整数) – 返回的文档数量。默认为4。

fetch_k (整数) – 将传递给MMR算法的文档数量。默认为20。

lambda_mult (浮点数) – 0到1之间的值，用于确定结果中多样性的程度，0代表最大多样性，1代表最小多样性。默认为0.5。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

Document 列表

async ammr_traversal_search(query: str, *, k: int = 4, depth: int = 2, fetch_k: int = 100, adjacent_k: int = 10, lambda_mult: float = 0.5, score_threshold: float = -inf, **kwargs: Any) → AsyncIterable[Document]¶

使用MMR遍历从此图形存储中检索文档。

该策略首先通过相似度检索前 fetch_k 个结果。然后根据给定的 lambda_mult 使用最大边际相关性选择前 k 个结果。

在每一步中，它考虑从 fetch_k 欢迎的文档以及通过相似性检索到的选择的文档（“根”）的任何通过边连接的文档。

参数

query （字符串） – 要搜索的查询字符串。

k (整数) – 返回的文档数量。默认为4。

fetch_k （int） – 通过相似性提取的文档数量。默认为 100。

adjacent_k （int） – 要提取的相邻文档数量。默认为 10。

depth （int） – 通过相似性检索到的节点（边数）的最大深度。默认为 2。

lambda_mult (浮点数) – 0到1之间的值，用于确定结果中多样性的程度，0代表最大多样性，1代表最小多样性。默认为0.5。

score_threshold （float） – 只有得分高于或等于此阈值的文档才会被选择。默认为负无穷。

kwargs (任何类型) –

返回类型

AsyncIterable[Document]

as_retriever(**kwargs: Any) → GraphVectorStoreRetriever¶

返回从此GraphVectorStore初始化的GraphVectorStoreRetriever。

参数

search_type (Optional[str]) – 定义检索器应执行搜索的类型。可以是“traversal”（默认）、“similarity”、“mmr”或“similarity_score_threshold”。

search_kwargs (Optional[Dict]) –
传递给搜索函数的关键字参数。可以包括以下内容

k: 返回的文档数量（默认：4）depth: 可遍历边的最大深度（默认：1）score_threshold: 最小相关性阈值

为similarity_score_threshold

fetch_k: 传递给MMR算法的文档数量（默认：20）lambda_mult: MMR返回结果的多样性；

1代表最小多样性，0代表最大。 (默认：0.5)

kwargs (任何类型) –

返回值

此GraphVectorStore的检索器。

返回类型

GraphVectorStoreRetriever

示例

# Retrieve documents traversing edges docsearch.as_retriever( search_type="traversal", search_kwargs={'k': 6, 'depth': 3} ) # Retrieve more documents with higher diversity # Useful if your dataset has many similar documents docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 6, 'lambda_mult': 0.25} ) # Fetch more documents for the MMR algorithm to consider # But only return the top 5 docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 5, 'fetch_k': 50} ) # Only retrieve documents that have a relevance score # Above a certain threshold docsearch.as_retriever( search_type="similarity_score_threshold", search_kwargs={'score_threshold': 0.8} ) # Only get the single most similar document from the dataset docsearch.as_retriever(search_kwargs={'k': 1})

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

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

参数

query (str) – 输入文本。

search_type (str) – 执行搜索的类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

引发异常

ValueError – 如果search_type不是“similarity”、“mmr”或“similarity_score_threshold”之一。

返回类型

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

query (str) – 输入文本。

k (整数) – 返回的文档数量。默认为4。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

List[Document]

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

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

参数

嵌入 (列表[浮点数]) – 查找与嵌入相似的文档。

k (整数) – 返回的文档数量。默认为4。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

Document 列表

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

异步返回[0, 1]范围内的文档和相关度分数。

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

参数

query (str) – 输入文本。

k (整数) – 返回的文档数量。默认为4。

**kwargs (Any) –
传递给相似度搜索的kwargs。应包括：score_threshold：可选，介于0到1之间的浮点数，用于筛选检索到的文档集

返回值

(doc, similarity_score)的元组列表

返回类型

列表[Tuple[Document, float]]

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

异步运行带距离的相似度搜索。

参数

*args (Any) – 要传递给搜索方法的参数。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

包含元组的列表，元组为(doc, similarity_score)。

返回类型

列表[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

测试版

自 0.2.11 版本开始添加。API 可能会更改。

以流的方式批量插入文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的文档的迭代集。

batch_size (int) – 每批次的大小。

kwargs (Any) – 额外的关键字参数。kwargs 应只包含所有文档通用的参数（例如，索引超时、重试策略等）。kwargs 不应包含 ID，以避免语义不明确。而是应该在 Document 对象中提供 ID。

生成值

UpsertResponse – 包含成功添加到或更新在向量存储中的 ID 列表以及未能添加或更新的 ID 列表的响应对象。

返回类型

AsyncIterator[UpsertResponse]

新功能自 0.2.11 版本起。

async atraversal_search(query: str, * , k: int = 4, depth: int = 1, **kwargs: Any) → AsyncIterable[Document]¶

从遍历此图存储中检索文档。

首先，使用每个查询字符串的搜索检索 k 个节点。然后，从这些起始节点发现更多节点，直到达到指定的深度。

参数

query (str) – 查询字符串。

k (int) – 从初始搜索中返回的文档数量。默认为 4。适用于每个查询字符串。

depth (int) – 要遍历的最大边深度。默认为 1。

kwargs (任何类型) –

返回值

检索到的文档。

返回类型

AsyncIterable[Document]

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

测试版

自 0.2.11 版本开始添加。API 可能会更改。

向向量存储中添加或更新文档。upsert 的异步版本。

upsert 功能应利用文档对象的 ID 字段（如果提供）。如果没有提供 ID，upsert 方法可以自由为文档生成一个 ID。

当指定了 ID 并且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。

kwargs （任何）- 其他关键字参数。

返回值

包含在向量存储中成功添加或更新以及未能添加或更新的 ID 列表的响应对象。

返回类型

UpsertResponse

新功能自 0.2.11 版本起。

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

根据向量和其它标准进行删除。

参数

ids （可选[列表[字符串]]）- 要删除的 id 列表。如果为 None，则删除所有。默认为 None。

**kwargs （任何）- 子类可能会使用的其他关键字参数。

返回值

如果删除成功，则返回 True，否则返回 False，如果没有实现，则返回 None。

返回类型

Optional[bool]

classmethod from_documents(documents: Iterable[Document], embedding: Embeddings, ids: Optional[Iterable[str]] = None, **kwargs: Any) → CassandraGraphVectorStore[source]¶

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

参数

documents (Iterable[Document]) –

embedding (Embeddings) –

ids (可选[可迭代对象[str]]) –

kwargs (任何类型) –

返回类型

CassandraGraphVectorStore

classmethod from_texts(texts: iterable[str], embedding: Embeddings, metadatas: Optional[list[dict]] = None, ids: Optional[iterable[str]] = None, **kwargs: Any) → CassandraGraphVectorStore[source]¶

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

参数

texts (iterable[str]) –

embedding (Embeddings) –

metadatas (Optional[list[dict]]) –

ids (可选[可迭代对象[str]]) –

kwargs (任何类型) –

返回类型

CassandraGraphVectorStore

get_by_ids(ids: sequence[str], /) → list[Document]¶

通过其ID获取文档。

返回的文档预期将具有 ID 字段设置为向量存储中的文档 ID。

如果某些 ID 未找到或存在重复 ID，则可能返回的文档少于请求的数量。

用户不应假设返回的文档的顺序与输入 ID 的顺序相同。相反，用户应依赖于返回文档的 ID 字段。

如果某些 ID 对应的文档未找到，此方法**不应**引发异常。

参数

ids (Sequence[str]) – 要检索的 ID 列表。

返回值

Document 列表。

返回类型

Document 列表

新功能自 0.2.11 版本起。

最大边际相关信息搜索(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数

查询 (字符串) – 查找与文本相似的文档。

k (整数) – 返回的文档数量。默认为4。

fetch_k (整数) – 将传递给MMR算法的文档数量。默认为20。

lambda_mult (浮点数) – 0到1之间的值，用于确定结果中多样性的程度，0代表最大多样性，1代表最小多样性。默认为0.5。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

List[Document]

通过向量进行最大边际相关信息搜索(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数

嵌入 (列表[浮点数]) – 查找与嵌入相似的文档。

k (整数) – 返回的文档数量。默认为4。

fetch_k (整数) – 将传递给MMR算法的文档数量。默认为20。

lambda_mult (浮点数) – 0到1之间的值，用于确定结果中多样性的程度，0代表最大多样性，1代表最小多样性。默认为0.5。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

Document 列表

使用MMR遍历从此图形存储中检索文档。

该策略首先通过相似度检索前 fetch_k 个结果。然后根据给定的 lambda_mult 使用最大边际相关性选择前 k 个结果。

在每一步中，它考虑从 fetch_k 欢迎的文档以及通过相似性检索到的选择的文档（“根”）的任何通过边连接的文档。

参数

query （字符串） – 要搜索的查询字符串。

k (整数) – 返回的文档数量。默认为4。

fetch_k （int） – 通过相似性提取的文档数量。默认为 100。

adjacent_k （int） – 要提取的相邻文档数量。默认为 10。

depth （int） – 通过相似性检索到的节点（边数）的最大深度。默认为 2。

lambda_mult (浮点数) – 0到1之间的值，用于确定结果中多样性的程度，0代表最大多样性，1代表最小多样性。默认为0.5。

score_threshold （float） – 只有得分高于或等于此阈值的文档才会被选择。默认为负无穷。

kwargs (任何类型) –

返回类型

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

参数

search_type (str) – 执行搜索的类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

引发异常

ValueError – 如果search_type不是“similarity”、“mmr”或“similarity_score_threshold”之一。

返回类型

List[Document]

similarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document][source]¶

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

参数

query (str) – 输入文本。

k (整数) – 返回的文档数量。默认为4。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document][source]¶

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

参数

嵌入 (列表[浮点数]) – 查找与嵌入相似的文档。

k (整数) – 返回的文档数量。默认为4。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

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

返回类型

List[Document]

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

返回范围 [0, 1] 内的文档及相关度分数。

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

参数

query (str) – 输入文本。

k (整数) – 返回的文档数量。默认为4。

**kwargs (Any) –
传递给相似度搜索的kwargs。应包括：score_threshold：可选，介于0到1之间的浮点数，用于筛选检索到的文档集

筛选检索到的文档集。

返回值

包含元组的列表，元组为(doc, similarity_score)。

返回类型

列表[Tuple[Document, float]]

similarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

使用距离运行相似度搜索。

参数

*args (Any) – 要传递给搜索方法的参数。

**kwargs （任何） – 传递给搜索方法的参数。

返回值

包含元组的列表，元组为(doc, similarity_score)。

返回类型

列表[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

测试版

自 0.2.11 版本开始添加。API 可能会更改。

以流式的方式更新文档。

参数

items (Iterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每批次的大小。
kwargs (Any) – 其他关键字参数。kwargs应只包含所有文档共有的参数。（如索引超时、重试策略等。）kwargs不应该包含ID，以避免模糊的含义。相反，ID应该作为Document对象的一部分提供。

生成值

UpsertResponse – 包含成功添加到或更新在向量存储中的 ID 列表以及未能添加或更新的 ID 列表的响应对象。

返回类型

Iterator[UpsertResponse]

新功能自 0.2.11 版本起。

traversal_search(query: str, *, k: int = 4, depth: int = 1, **kwargs: Any) → Iterable[Document][source]¶

从遍历此图存储中检索文档。

首先，使用每个查询字符串的搜索检索 k 个节点。然后，从这些起始节点发现更多节点，直到达到指定的深度。

参数

query (str) – 查询字符串。
k (int) – 从初始搜索中返回的文档数量。默认为 4。适用于每个查询字符串。
depth (int) – 要遍历的最大边深度。默认为 1。
kwargs (任何类型) –

返回值

检索到的文档。

返回类型

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

测试版

自 0.2.11 版本开始添加。API 可能会更改。

在向量存储中添加或更新文档。

upsert 功能应利用文档对象的 ID 字段（如果提供）。如果没有提供 ID，upsert 方法可以自由为文档生成一个 ID。

当指定了 ID 并且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs （任何）- 其他关键字参数。

返回值

包含在向量存储中成功添加或更新以及未能添加或更新的 ID 列表的响应对象。

返回类型

UpsertResponse

新功能自 0.2.11 版本起。

langchain_community.graph_vectorstores.cassandra.CassandraGraphVectorStore¶

`langchain_community.graph_vectorstores.cassandra`.CassandraGraphVectorStore¶