ZepVectorStore

class langchain_community.vectorstores.zep.ZepVectorStore(collection_name: str, api_url: str, *, api_key: str | None = None, config: CollectionConfig | None = None, embedding: Embeddings | None = None)

Zep 向量存储。

它提供了向存储库添加文本或文档、搜索相似文档以及删除文档的方法。

搜索分数使用归一化到[0, 1]的余弦相似度计算。

Parameters:

• api_url (str) – Zep API 的 URL。

• collection_name (str) – Zep 存储中集合的名称。

• api_key (可选[str]) – Zep API 的 API 密钥。

• config (可选[CollectionConfig]) – 集合的配置。 如果集合尚不存在，则必须提供。

• embedding (可选[Embeddings]) – 可选的嵌入函数，用于嵌入文本。如果集合不是自动嵌入的，则必须提供。

属性

embeddings

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

方法

__init__(collection_name, api_url, *[, ...])
aadd_documents(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas, document_ids])	通过嵌入运行更多文本并将其添加到向量存储中。
add_documents(documents, **kwargs)	在向量存储中添加或更新文档。
add_texts(texts[, metadatas, document_ids])	通过嵌入运行更多文本并将其添加到向量存储中。
adelete([ids])	异步删除通过向量ID或其他条件。
afrom_documents(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
afrom_texts(texts, embedding[, metadatas, ids])	异步返回从文本和嵌入初始化的VectorStore。
aget_by_ids(ids, /)	异步通过ID获取文档。
amax_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
amax_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
as_retriever(**kwargs)	返回从此VectorStore初始化的VectorStoreRetriever。
asearch(query, search_type[, metadata, k])	使用指定的搜索类型返回与查询最相似的文档。
asimilarity_search(query[, k, metadata])	返回与查询最相似的文档。
asimilarity_search_by_vector(embedding[, k, ...])	返回与嵌入向量最相似的文档。
asimilarity_search_with_relevance_scores(query)	返回与查询最相似的文档。
asimilarity_search_with_score(*args, **kwargs)	异步运行带距离的相似性搜索。
delete([ids])	通过Zep向量UUID删除。
from_documents(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
from_texts(texts[, embedding, metadatas, ...])	类方法，返回从文本初始化的ZepVectorStore实例。
get_by_ids(ids, /)	通过ID获取文档。
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
search(query, search_type[, metadata, k])	使用指定的搜索类型返回与查询最相似的文档。
similarity_search(query[, k, metadata])	返回与查询最相似的文档。
similarity_search_by_vector(embedding[, k, ...])	返回与嵌入向量最相似的文档。
similarity_search_with_relevance_scores(query)	返回文档和相关度分数，范围在[0, 1]之间。
similarity_search_with_score(query[, k, ...])	运行带有距离的相似性搜索。

__init__(collection_name: str, api_url: str, *, api_key: str | None = None, config: CollectionConfig | None = None, embedding: Embeddings | None = None) → None

Parameters:

• collection_name (str)

• api_url (str)

• api_key (str | None)

• config (CollectionConfig | None)

• embedding (Embeddings | None)

Return type:

无

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

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

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档。

• kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果ID的数量与文档的数量不匹配。

Return type:

列表[字符串]

async aadd_texts(texts: Iterable[str], metadatas: List[Dict[str, Any]] | None = None, document_ids: List[str] | None = None, **kwargs: Any) → List[str]

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

Parameters:

• texts (可迭代对象[字符串])

• metadatas (列表[字典[字符串, 任意类型]] | 无)

• document_ids (列表[字符串] | 无)

• kwargs (Any)

Return type:

列表[str]

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

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

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档。

• kwargs (Any) – 额外的关键字参数。 如果 kwargs 包含 ids 并且 documents 也包含 ids， kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果id的数量与文档的数量不匹配。

Return type:

列表[字符串]

add_texts(texts: Iterable[str], metadatas: List[Dict[str, Any]] | None = None, document_ids: List[str] | None = None, **kwargs: Any) → List[str]

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

Parameters:

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

• metadatas (List[Dict[str, Any]] | None) – 可选的与文本关联的元数据列表。

• document_ids (List[str] | None) – 可选的与文本相关联的文档ID列表。

• kwargs (Any) – 向量存储特定参数

Returns:

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

Return type:

列表[str]

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

通过向量ID或其他条件异步删除。

Parameters:

• ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。

• **kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真， 否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

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

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档列表。

• embedding (Embeddings) – 使用的嵌入函数。

• kwargs (Any) – 额外的关键字参数。

Returns:

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

Return type:

VectorStore

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

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

Parameters:

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

• embedding (Embeddings) – 使用的嵌入函数。

• metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

• ids (list[str] | None) – 可选的与文本关联的ID列表。

• kwargs (Any) – 额外的关键字参数。

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

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

通过ID异步获取文档。

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

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

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

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

Parameters:

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

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

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

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

Parameters:

• query (str)

• k (整数)

• fetch_k (int)

• lambda_mult (float)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[文档]

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

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

Parameters:

• embedding (列表[浮点数])

• k (整数)

• fetch_k (int)

• lambda_mult (float)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[文档]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

传递给搜索函数的关键字参数。 可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。 可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

检索器应执行的搜索类型。 可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。

可以包括以下内容：

k: 返回的文档数量（默认：4） score_threshold: 最小相关性阈值

用于similarity_score_threshold

fetch_k: 传递给MMR算法的文档数量

（默认：20）

lambda_mult: MMR返回结果的多样性；

1表示最小多样性，0表示最大多样性。（默认：0.5）

filter: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

VectorStoreRetriever

示例：

# 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})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

async asearch(query: str, search_type: str, metadata: Dict[str, Any] | None = None, k: int = 3, **kwargs: Any) → List[Document]

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

Parameters:

• query (str)

• search_type (str)

• metadata (Dict[str, Any] | None)

• k (整数)

• kwargs (Any)

Return type:

列表[文档]

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

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

Parameters:

• query (str)

• k (整数)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[文档]

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

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

Parameters:

• embedding (列表[浮点数])

• k (整数)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[文档]

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

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

Parameters:

• query (str)

• k (整数)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]

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

Parameters:

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

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

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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

通过Zep向量UUID删除。

Parameters:

• ids (可选[列表[字符串]]) – 要删除的向量的UUID。

• kwargs (Any)

Raises:

ValueError – 如果没有提供UUID。

Return type:

无

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

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

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档列表。

• embedding (Embeddings) – 使用的嵌入函数。

• kwargs (Any) – 额外的关键字参数。

Returns:

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

Return type:

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[dict] | None = None, collection_name: str = '', api_url: str = '', api_key: str | None = None, config: CollectionConfig | None = None, **kwargs: Any) → ZepVectorStore

类方法，返回从文本初始化的ZepVectorStore实例。

如果集合不存在，它将被创建。

Parameters:

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

• embedding (可选[Embeddings]) – 可选的嵌入函数，用于嵌入文本。

• metadatas (可选[列表[字典[str, Any]]]) – 与文本关联的可选元数据列表。

• collection_name (str) – Zep 存储中集合的名称。

• api_url (str) – Zep API 的 URL。

• api_key (可选[str]) – Zep API 的 API 密钥。

• config (可选[CollectionConfig]) – 集合的配置。

• kwargs (Any) – 特定于向量存储的附加参数。

Returns:

ZepVectorStore 的一个实例。

Return type:

ZepVectorStore

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

通过ID获取文档。

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

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

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

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

Parameters:

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

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, metadata: Dict[str, Any] | None = None, **kwargs: Any) → List[Document]

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

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

Parameters:

• query (str) – 用于查找相似文档的文本。

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

• fetch_k (int) –

  要获取的文档数量以传递给MMR算法。 Zep会自动确定此参数，因此此参数

  被忽略。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• metadata (Dict[str, Any] | None) – 可选的，用于过滤检索到的文档集合的元数据

• kwargs (Any)

Returns:

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

Return type:

列表[文档]

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

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

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

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

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

• fetch_k (int) –

  要获取的文档数量以传递给MMR算法。 Zep会自动确定此参数，因此此参数

  被忽略。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• metadata (Dict[str, Any] | None) – 可选的，用于过滤检索到的文档集合的元数据

• kwargs (Any)

Returns:

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

Return type:

列表[文档]

search(query: str, search_type: str, metadata: Dict[str, Any] | None = None, k: int = 3, **kwargs: Any) → List[Document]

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

Parameters:

• query (str)

• search_type (str)

• metadata (Dict[str, Any] | None)

• k (整数)

• kwargs (Any)

Return type:

列表[文档]

similarity_search(query: str, k: int = 4, metadata: Dict[str, Any] | None = None, **kwargs: Any) → List[Document]

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

Parameters:

• query (str)

• k (整数)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[文档]

similarity_search_by_vector(embedding: List[float], k: int = 4, metadata: Dict[str, Any] | None = None, **kwargs: Any) → List[Document]

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

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

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

• metadata (Dict[str, Any] | None) – 可选的元数据过滤器

• kwargs (Any)

Returns:

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

Return type:

列表[文档]

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

返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

• query (str) – 输入文本。

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

• **kwargs (Any) –

  传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

  用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

similarity_search_with_score(query: str, k: int = 4, metadata: Dict[str, Any] | None = None, **kwargs: Any) → List[Tuple[Document, float]]

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

Parameters:

• query (str)

• k (整数)

• metadata (Dict[str, Any] | None)

• kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

使用 ZepVectorStore 的示例

• Zep