langchain_community.vectorstores.cassandra.Cassandra

class langchain_community.vectorstores.cassandra.Cassandra(embedding: Embeddings, session: Optional[Session] = None, keyspace: Optional[str] = None, table_name: str = '', ttl_seconds: Optional[int] = None, *, body_index_options: Optional[List[Tuple[str, Any]]] = None, setup_mode: SetupMode = SetupMode.SYNC)[source]

Apache Cassandra(R) 用于向量存储工作负载。

要使用它，您需要安装最新版本的 cassio 库，并且需要支持向量功能的Cassandra集群/ Astra DB实例。

访问 cassio.org 网站以获取详尽的快速入门和代码示例。

示例：
from langchain_community.vectorstores import Cassandra
from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
session = ...             # 创建您的Cassandra会话对象
keyspace = 'my_keyspace'  # keyspace 应该已经存在
table_name = 'my_vector_store'
vectorstore = Cassandra(embeddings, session, keyspace, table_name)
参数：

embedding: 要使用的嵌入函数。 session: Cassandra 驱动程序会话。如果未提供，则从 cassio 中解析。 keyspace: Cassandra 键空间。如果未提供，则从 cassio 中解析。 table_name: Cassandra 表（必填）。 ttl_seconds: 添加文本的可选存活时间。 body_index_options: 用于创建 body 索引的可选选项。

例如 body_index_options = [cassio.table.cql.STANDARD_ANALYZER]

setup_mode: 用于创建Cassandra表的模式（SYNC、ASYNC 或 OFF）。

Attributes

embeddings

如果可用，访问查询嵌入对象。

Methods

__init__(embedding[, session, keyspace, ...])

Apache Cassandra(R) 用于向量存储工作负载。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas, ids, ...])

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

aclear()

清空表格。

add_documents(documents, **kwargs)

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

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

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

adelete([ids])

根据向量ID删除。

adelete_by_document_id(document_id)

根据文档ID删除。

adelete_collection()

只是对`aclear`的别名 （为了更好地与其他VectorStore实现对齐）。

afrom_documents(documents, embedding, *[, ...])

从文档列表创建一个Cassandra向量存储。

afrom_texts(texts, embedding[, metadatas, ...])

从原始文本创建一个Cassandra向量存储。

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

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数： query：要查找类似文档的文本。 k：要返回的文档数量。 fetch_k：要获取的文档数量，以传递给MMR算法。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。 默认为0.5。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词语。 目前仅由Astra DB支持。 返回： 通过最大边际相关性选择的文档列表。

amax_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数： embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取并传递给MMR算法的文档数量。默认为20。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词语。目前仅由Astra DB支持。 返回： 通过最大边际相关性选择的文档列表。

as_retriever(**kwargs)

返回从此VectorStore初始化的VectorStoreRetriever。

asearch(query, search_type, **kwargs)

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

asimilarity_search(query[, k, filter, ...])

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

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

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

asimilarity_search_with_relevance_scores(query)

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

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

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

asimilarity_search_with_score_by_vector(...)

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

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

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

asimilarity_search_with_score_id_by_vector(...)

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

clear()

清空表格。

delete([ids])

根据向量ID删除。

delete_by_document_id(document_id)

根据文档ID删除。

delete_collection()

只是`clear`的别名 （为了更好地与其他VectorStore实现对齐）。

from_documents(documents, embedding, *[, ...])

从文档列表创建一个Cassandra向量存储。

from_texts(texts, embedding[, metadatas, ...])

从原始文本创建一个Cassandra向量存储。

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

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数： embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。 默认为20。 lambda_mult: 0到1之间的数字，确定结果之间多样性的程度 0对应最大多样性，1对应最小多样性。 默认为0.5。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词。 目前仅由Astra DB支持。 返回： 通过最大边际相关性选择的文档列表。

max_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数： embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取并传递给MMR算法的文档数量。默认为20。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词语。目前仅由Astra DB支持。 返回： 通过最大边际相关性选择的文档列表。

search(query, search_type, **kwargs)

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

similarity_search(query[, k, filter, ...])

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

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)

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

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

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

similarity_search_with_score_id_by_vector(...)

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

  • embedding (Embeddings) –

  • session (Optional[Session]) –

  • keyspace (Optional[str]) –

  • table_name (str) –

  • ttl_seconds (Optional[int]) –

  • body_index_options (Optional[List[Tuple[str, Any]]]) –

  • setup_mode (SetupMode) –

Return type

None

__init__(embedding: Embeddings, session: Optional[Session] = None, keyspace: Optional[str] = None, table_name: str = '', ttl_seconds: Optional[int] = None, *, body_index_options: Optional[List[Tuple[str, Any]]] = None, setup_mode: SetupMode = SetupMode.SYNC) → None[source]

Apache Cassandra(R) 用于向量存储工作负载。

要使用它，您需要安装最新版本的 cassio 库，并且需要支持向量功能的Cassandra集群/ Astra DB实例。

访问 cassio.org 网站以获取详尽的快速入门和代码示例。

示例：
from langchain_community.vectorstores import Cassandra
from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
session = ...             # 创建您的Cassandra会话对象
keyspace = 'my_keyspace'  # keyspace 应该已经存在
table_name = 'my_vector_store'
vectorstore = Cassandra(embeddings, session, keyspace, table_name)
参数：

embedding: 要使用的嵌入函数。 session: Cassandra 驱动程序会话。如果未提供，则从 cassio 中解析。 keyspace: Cassandra 键空间。如果未提供，则从 cassio 中解析。 table_name: Cassandra 表（必填）。 ttl_seconds: 添加文本的可选存活时间。 body_index_options: 用于创建 body 索引的可选选项。

例如 body_index_options = [cassio.table.cql.STANDARD_ANALYZER]

setup_mode: 用于创建Cassandra表的模式（SYNC、ASYNC 或 OFF）。

Parameters

  • embedding (Embeddings) –

  • session (Optional[Session]) –

  • keyspace (Optional[str]) –

  • table_name (str) –

  • ttl_seconds (Optional[int]) –

  • body_index_options (Optional[List[Tuple[str, Any]]]) –

  • setup_mode (SetupMode) –

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, ids: Optional[List[str]] = None, concurrency: int = 16, ttl_seconds: Optional[int] = None, **kwargs: Any) → List[str][source]

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

参数：

texts：要添加到向量存储的文本。 metadatas：元数据的可选列表。 ids：ID的可选列表。 并发性：查询数据库的并发数。

默认为16。

ttl_seconds：添加的文本的可选生存时间。

返回：

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

Parameters

  • texts (Iterable[str]) –

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

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

  • concurrency (int) –

  • ttl_seconds (Optional[int]) –

  • kwargs (Any) –

Return type

List[str]

async aclear() → None[source]

清空表格。

Return type

None

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]] = None, ids: Optional[List[str]] = None, batch_size: int = 16, ttl_seconds: Optional[int] = None, **kwargs: Any) → List[str][source]

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

参数：

texts: 要添加到向量存储的文本。 metadatas: 可选的元数据列表。 ids: 可选的ID列表。 batch_size: 发送到服务器的并发请求数量。 ttl_seconds: 添加文本的可选生存时间。

返回：

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

Parameters

  • texts (Iterable[str]) –

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

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

  • batch_size (int) –

  • ttl_seconds (Optional[int]) –

  • kwargs (Any) –

Return type

List[str]

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

根据向量ID删除。

参数：

ids：要删除的ID列表。

返回：

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

Parameters

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

  • kwargs (Any) –

Return type

Optional[bool]

async adelete_by_document_id(document_id: str) → None[source]

根据文档ID删除。

参数：

document_id：要删除的文档ID。

Parameters

document_id (str) –

Return type

None

async adelete_collection() → None[source]

只是对`aclear`的别名 （为了更好地与其他VectorStore实现对齐）。

Return type

None

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, *, session: Optional[Session] = None, keyspace: Optional[str] = None, table_name: str = '', ids: Optional[List[str]] = None, concurrency: int = 16, ttl_seconds: Optional[int] = None, body_index_options: Optional[List[Tuple[str, Any]]] = None, **kwargs: Any) → CVST[source]

从文档列表创建一个Cassandra向量存储。

参数:

documents: 要添加到向量存储的文档。 embedding: 要使用的嵌入函数。 session: Cassandra驱动程序会话。

如果未提供，则从cassio中解析。

keyspace: Cassandra键空间。

如果未提供，则从cassio中解析。

table_name: Cassandra表（必填）。 ids: 与文档关联的ID的可选列表。 concurrency: 发送到数据库的并发查询数。

默认为16。

ttl_seconds: 添加文档的可选存活时间。 body_index_options: 用于创建正文索引的可选选项。

例如 body_index_options = [cassio.table.cql.STANDARD_ANALYZER]

返回:

一个Cassandra向量存储。

Parameters

  • documents (List[Document]) –

  • embedding (Embeddings) –

  • session (Optional[Session]) –

  • keyspace (Optional[str]) –

  • table_name (str) –

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

  • concurrency (int) –

  • ttl_seconds (Optional[int]) –

  • body_index_options (Optional[List[Tuple[str, Any]]]) –

  • kwargs (Any) –

Return type

CVST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, *, session: Optional[Session] = None, keyspace: Optional[str] = None, table_name: str = '', ids: Optional[List[str]] = None, concurrency: int = 16, ttl_seconds: Optional[int] = None, body_index_options: Optional[List[Tuple[str, Any]]] = None, **kwargs: Any) → CVST[source]

从原始文本创建一个Cassandra向量存储。

参数：

texts: 要添加到向量存储中的文本。 embedding: 要使用的嵌入函数。 metadatas: 与文本相关的元数据的可选列表。 session: Cassandra驱动程序会话。

如果未提供，则会从cassio中解析。

keyspace: Cassandra键空间。

如果未提供，则会从cassio中解析。

table_name: Cassandra表（必填）。 ids: 与文本相关的ID的可选列表。 concurrency: 发送到数据库的并发查询数。

默认为16。

ttl_seconds: 添加的文本的可选存活时间。 body_index_options: 用于创建正文索引的可选选项。

例如：body_index_options = [cassio.table.cql.STANDARD_ANALYZER]

返回：

一个Cassandra向量存储。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

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

  • session (Optional[Session]) –

  • keyspace (Optional[str]) –

  • table_name (str) –

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

  • concurrency (int) –

  • ttl_seconds (Optional[int]) –

  • body_index_options (Optional[List[Tuple[str, Any]]]) –

  • kwargs (Any) –

Return type

CVST

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数：

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

默认为0.5。

filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • 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, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None, **kwargs: Any) → List[Document][source]

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取并传递给MMR算法的文档数量。默认为20。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词语。目前仅由Astra DB支持。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • 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]

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None, **kwargs: Any) → List[Document][source]

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

参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • 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(query: str, k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float]][source]

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

（文档，分数）的列表，最接近查询向量的文档。

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float]][source]

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

参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

(文档，分数)列表，与查询向量最相似的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score_id(query: str, k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float, str]][source]

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

与查询向量最相似的文档的列表（文档，分数，id）。

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float, str]]

async asimilarity_search_with_score_id_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float, str]][source]

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

参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

与查询向量最相似的文档的列表（文档，分数，id）。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float, str]]

clear() → None[source]

清空表格。

Return type

None

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

根据向量ID删除。

参数：

ids：要删除的ID列表。

返回：

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

Parameters

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

  • kwargs (Any) –

Return type

Optional[bool]

delete_by_document_id(document_id: str) → None[source]

根据文档ID删除。

参数：

document_id：要删除的文档ID。

Parameters

document_id (str) –

Return type

None

delete_collection() → None[source]

只是`clear`的别名 （为了更好地与其他VectorStore实现对齐）。

Return type

None

classmethod from_documents(documents: List[Document], embedding: Embeddings, *, session: Optional[Session] = None, keyspace: Optional[str] = None, table_name: str = '', ids: Optional[List[str]] = None, batch_size: int = 16, ttl_seconds: Optional[int] = None, body_index_options: Optional[List[Tuple[str, Any]]] = None, **kwargs: Any) → CVST[source]

从文档列表创建一个Cassandra向量存储。

参数：

documents: 要添加到向量存储中的文档。 embedding: 要使用的嵌入函数。 session: Cassandra驱动程序会话。

如果未提供，则会从cassio中解析。

keyspace: Cassandra键空间。

如果未提供，则会从cassio中解析。

table_name: Cassandra表（必填）。 ids: 与文档关联的可选ID列表。 batch_size: 发送到服务器的并发请求数量。

默认为16。

ttl_seconds: 添加文档的可选存活时间。 body_index_options: 用于创建正文索引的可选选项。

例如，body_index_options = [cassio.table.cql.STANDARD_ANALYZER]

返回：

一个Cassandra向量存储。

Parameters

  • documents (List[Document]) –

  • embedding (Embeddings) –

  • session (Optional[Session]) –

  • keyspace (Optional[str]) –

  • table_name (str) –

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

  • batch_size (int) –

  • ttl_seconds (Optional[int]) –

  • body_index_options (Optional[List[Tuple[str, Any]]]) –

  • kwargs (Any) –

Return type

CVST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, *, session: Optional[Session] = None, keyspace: Optional[str] = None, table_name: str = '', ids: Optional[List[str]] = None, batch_size: int = 16, ttl_seconds: Optional[int] = None, body_index_options: Optional[List[Tuple[str, Any]]] = None, **kwargs: Any) → CVST[source]

从原始文本创建一个Cassandra向量存储。

参数：

texts: 要添加到向量存储中的文本。 embedding: 要使用的嵌入函数。 metadatas: 与文本相关的元数据的可选列表。 session: Cassandra驱动程序会话。

如果未提供，则会从cassio中解析。

keyspace: Cassandra键空间。

如果未提供，则会从cassio中解析。

table_name: Cassandra表（必填）。 ids: 与文本相关的ID的可选列表。 batch_size: 发送到服务器的并发请求数量。

默认为16。

ttl_seconds: 添加的文本的可选存活时间。 body_index_options: 用于创建正文索引的可选选项。

例如，body_index_options = [cassio.table.cql.STANDARD_ANALYZER]

返回：

一个Cassandra向量存储。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

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

  • session (Optional[Session]) –

  • keyspace (Optional[str]) –

  • table_name (str) –

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

  • batch_size (int) –

  • ttl_seconds (Optional[int]) –

  • body_index_options (Optional[List[Tuple[str, Any]]]) –

  • kwargs (Any) –

Return type

CVST

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。

默认为20。

lambda_mult: 0到1之间的数字，确定结果之间多样性的程度

0对应最大多样性，1对应最小多样性。 默认为0.5。

filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • 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, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None, **kwargs: Any) → List[Document][source]

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性和所选文档之间的多样性。 参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取并传递给MMR算法的文档数量。默认为20。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词语。目前仅由Astra DB支持。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • 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：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None, **kwargs: Any) → List[Document][source]

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

参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

  • 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, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float]][source]

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

（文档，分数）的列表，最接近查询向量的文档。

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float]][source]

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

参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

(文档，分数)列表，与查询向量最相似的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score_id(query: str, k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float, str]][source]

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filter：要应用的元数据过滤器。 body_search：要应用的文档文本搜索词语。

目前仅由Astra DB支持。

返回：

与查询向量最相似的文档的列表（文档，分数，id）。

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float, str]]

similarity_search_with_score_id_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, body_search: Optional[Union[str, List[str]]] = None) → List[Tuple[Document, float, str]][source]

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

参数：

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要应用的元数据过滤器。 body_search: 要应用的文档文本搜索词。

目前仅由Astra DB支持。

返回：

与查询向量最相似的文档的列表（文档，分数，id）。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • body_search (Optional[Union[str, List[str]]]) –

Return type

List[Tuple[Document, float, str]]

Examples using Cassandra