`langchain_community.vectorstores.zep`.ZepVectorStore¶

class langchain_community.vectorstores.zep.ZepVectorStore(collection_name: str, api_url: str, *, api_key: Optional[str] = None, config: Optional[CollectionConfig] = None, embedding: Optional[Embeddings] = None)[source]¶

`Zep`向量存储。

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

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

参数:

api_url (str): Zep API的URL。 collection_name (str): Zep存储库中的集合名称。 api_key (Optional[str]): Zep API的API密钥。 config (Optional[CollectionConfig]): 集合的配置。

如果集合尚不存在，则为必需。

embedding (Optional[Embeddings]): 用于嵌入文本的可选嵌入函数。: 如果集合未自动嵌入，则为必需。

Attributes

embeddings

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

Methods

`__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])	返回从文本和嵌入初始化的VectorStore。
`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向量UUIDs。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts[, embedding, metadatas, ...])	返回一个从文本初始化的ZepVectorStore实例的类方法。
`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, ...])	使用距离进行相似性搜索。

Parameters

collection_name (str) –
api_url (str) –
api_key (Optional[str]) –
config (Optional[CollectionConfig]) –
embedding (Optional[Embeddings]) –

Return type

None

__init__(collection_name: str, api_url: str, *, api_key: Optional[str] = None, config: Optional[CollectionConfig] = None, embedding: Optional[Embeddings] = None) → None[source]¶

Parameters

collection_name (str) –
api_url (str) –
api_key (Optional[str]) –
config (Optional[CollectionConfig]) –
embedding (Optional[Embeddings]) –

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[str, Any]]] = None, document_ids: Optional[List[str]] = None, **kwargs: Any) → List[str][source]¶

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

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[Dict[str, Any]]]) –
document_ids (Optional[List[str]]) –
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, document_ids: Optional[List[str]] = None, **kwargs: Any) → List[str][source]¶

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

参数：: texts：要添加到向量存储的字符串的可迭代对象。 metadatas：与文本相关的元数据的可选列表。 document_ids：与文本相关的文档ID的可选列表。 kwargs：向量存储特定参数
返回：: 将文本添加到向量存储中的ID列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[Dict[str, Any]]]) –
document_ids (Optional[List[str]]) –
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

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

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

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

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

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
metadata (Optional[Dict[str, Any]]) –
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, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → List[Document][source]¶

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
metadata (Optional[Dict[str, Any]]) –
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, metadata: Optional[Dict[str, Any]] = None, k: int = 3, **kwargs: Any) → List[Document][source]¶

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

Parameters

query (str) –
search_type (str) –
metadata (Optional[Dict[str, Any]]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
k (int) –
metadata (Optional[Dict[str, Any]]) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

embedding (List[float]) –
k (int) –
metadata (Optional[Dict[str, Any]]) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
k (int) –
metadata (Optional[Dict[str, Any]]) –
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) → None[source]¶

删除由Zep向量UUIDs。

ids：Optional[List[str]]: 要删除的向量的UUIDs。

Raises

ValueError – 如果未提供UUIDs。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

None

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

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

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

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

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

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

参数:: texts (List[str]): 要添加到向量存储的文本列表。 embedding (Optional[Embeddings]): 可选的嵌入函数，用于嵌入文本。 metadatas (Optional[List[Dict[str, Any]]]): 与文本相关的元数据的可选列表。 collection_name (str): Zep存储中集合的名称。 api_url (str): Zep API的URL。 api_key (Optional[str]): Zep API的API密钥。 config (Optional[CollectionConfig]): 集合的配置。 **kwargs: 特定于向量存储的其他参数。
返回:: ZepVectorStore: ZepVectorStore的一个实例。

Parameters

texts (List[str]) –
embedding (Optional[Embeddings]) –
metadatas (Optional[List[dict]]) –
collection_name (str) –
api_url (str) –
api_key (Optional[str]) –
config (Optional[CollectionConfig]) –
kwargs (Any) –

Return type

ZepVectorStore

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

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。

Zep会自动确定这个数量，此参数会被忽略。

lambda_mult：0到1之间的数字，确定结果中多样性的程度，: 其中0对应最大多样性，1对应最小多样性。默认为0.5。

metadata：可选，用于过滤检索到的文档集的元数据。

返回：

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

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
metadata (Optional[Dict[str, Any]]) –
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, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数:

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

Zep会自动确定这个数量，因此此参数会被忽略。

lambda_mult: 介于0和1之间的数字，确定结果中多样性的程度，: 0对应最大多样性，1对应最小多样性。默认为0.5。

metadata: 可选，用于过滤检索到的文档集的元数据。

返回:

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
metadata (Optional[Dict[str, Any]]) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
search_type (str) –
metadata (Optional[Dict[str, Any]]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
k (int) –
metadata (Optional[Dict[str, Any]]) –
kwargs (Any) –

Return type

List[Document]

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

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

参数:: embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 metadata: 可选的，元数据过滤器。
返回:: 与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
metadata (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, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

Parameters

query (str) –
k (int) –
metadata (Optional[Dict[str, Any]]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using ZepVectorStore¶

langchain_community.vectorstores.zep.ZepVectorStore¶

Examples using ZepVectorStore¶

`langchain_community.vectorstores.zep`.ZepVectorStore¶