Skip to content

Zep

ZepVectorStore #

Bases: BasePydanticVectorStore

Zep矢量存储用于存储和检索嵌入。

Zep支持规范化和非规范化的嵌入。使用余弦相似度来计算距离，返回的分数被归一化为0到1之间。

Parameters:

Name Type Description Default
collection_name str

存储嵌入的Zep集合的名称。

 required
api_url str

Zep API的URL。

 required
api_key (str, 可选)

Zep API的密钥。默认为None。

 None
collection_description (str, 可选)

集合的描述。默认为None。

 None
collection_metadata (dict, 可选)

集合的元数据。默认为None。

 None
embedding_dimensions (int, 可选)

嵌入的维度。默认为None。

 None
is_auto_embedded (bool, 可选)

嵌入是否自动嵌入。默认为False。

 False
示例

pip install llama-index-vector-stores-zep

from llama_index.vector_stores.zep import ZepVectorStore

vector_store = ZepVectorStore(
    api_url="<api_url>",
    api_key="<api_key>",
    collection_name="<unique_collection_name>",  # 可以是现有集合或新集合
    embedding_dimensions=1536,  # 可选，如果创建新集合则需要
)
Source code in llama_index/vector_stores/zep/base.py 
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
class ZepVectorStore(BasePydanticVectorStore):
    """Zep矢量存储用于存储和检索嵌入。

    Zep支持规范化和非规范化的嵌入。使用余弦相似度来计算距离，返回的分数被归一化为0到1之间。

    Args:
        collection_name (str): 存储嵌入的Zep集合的名称。
        api_url (str): Zep API的URL。
        api_key (str, 可选): Zep API的密钥。默认为None。
        collection_description (str, 可选): 集合的描述。默认为None。
        collection_metadata (dict, 可选): 集合的元数据。默认为None。
        embedding_dimensions (int, 可选): 嵌入的维度。默认为None。
        is_auto_embedded (bool, 可选): 嵌入是否自动嵌入。默认为False。

    示例:
        `pip install llama-index-vector-stores-zep`

        ```python
        from llama_index.vector_stores.zep import ZepVectorStore

        vector_store = ZepVectorStore(
            api_url="<api_url>",
            api_key="<api_key>",
            collection_name="<unique_collection_name>",  # 可以是现有集合或新集合
            embedding_dimensions=1536,  # 可选，如果创建新集合则需要
        )
        ```"""

    stores_text = True
    flat_metadata = False

    _client: ZepClient = PrivateAttr()
    _collection: DocumentCollection = PrivateAttr()

    def __init__(
        self,
        collection_name: str,
        api_url: str,
        api_key: Optional[str] = None,
        collection_description: Optional[str] = None,
        collection_metadata: Optional[Dict[str, Any]] = None,
        embedding_dimensions: Optional[int] = None,
        is_auto_embedded: bool = False,
        **kwargs: Any,
    ) -> None:
        """初始化参数。"""
        super().__init__()

        self._client = ZepClient(base_url=api_url, api_key=api_key)
        collection: Union[DocumentCollection, None] = None

        try:
            collection = self._client.document.get_collection(name=collection_name)
        except zep_python.NotFoundError:
            if embedding_dimensions is None:
                raise ValueError(
                    "embedding_dimensions must be specified if collection does not"
                    " exist"
                )
            logger.info(
                f"Collection {collection_name} does not exist, "
                f"will try creating one with dimensions={embedding_dimensions}"
            )

            collection = self._client.document.add_collection(
                name=collection_name,
                embedding_dimensions=embedding_dimensions,
                is_auto_embedded=is_auto_embedded,
                description=collection_description,
                metadata=collection_metadata,
            )

        assert collection is not None
        self._collection = collection

    @classmethod
    def class_name(cls) -> str:
        return "ZepVectorStore"

    @property
    def client(self) -> Any:
        """获取客户端。"""
        return self._client

    def _prepare_documents(
        self, nodes: List[BaseNode]
    ) -> Tuple[List["ZepDocument"], List[str]]:
        docs: List["ZepDocument"] = []
        ids: List[str] = []

        for node in nodes:
            metadata_dict: Dict[str, Any] = node_to_metadata_dict(
                node, remove_text=True, flat_metadata=self.flat_metadata
            )

            if len(node.get_content()) == 0:
                raise ValueError("No content to add to Zep")

            docs.append(
                ZepDocument(
                    document_id=node.node_id,
                    content=node.get_content(metadata_mode=MetadataMode.NONE),
                    embedding=node.get_embedding(),
                    metadata=metadata_dict,
                )
            )
            ids.append(node.node_id)

        return docs, ids

    def add(self, nodes: List[BaseNode], **add_kwargs: Any) -> List[str]:
        """将节点添加到集合中。

Args:
    nodes（List[BaseNode]）：带有嵌入的节点列表。

Returns:
    List[str]：添加文档的ID列表。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if self._collection.is_auto_embedded:
            raise ValueError("Collection is auto embedded, cannot add embeddings")

        docs, ids = self._prepare_documents(nodes)

        self._collection.add_documents(docs)

        return ids

    async def async_add(
        self,
        nodes: List[BaseNode],
        **add_kwargs: Any,
    ) -> List[str]:
        """异步地向集合中添加节点。

Args:
    nodes（List[BaseNode]）：带有嵌入的节点列表。

Returns:
    List[str]：添加文档的ID列表。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if self._collection.is_auto_embedded:
            raise ValueError("Collection is auto embedded, cannot add embeddings")

        docs, ids = self._prepare_documents(nodes)

        await self._collection.aadd_documents(docs)

        return ids

    def delete(
        self, ref_doc_id: Optional[str] = None, **delete_kwargs: Any
    ) -> None:  # type: ignore
        """从集合中删除一个文档。

Args:
    ref_doc_id（可选[str]）：要删除的文档的ID。
        目前不支持。
    delete_kwargs：必须包含带有要删除的文档的UUID的“uuid”键。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if ref_doc_id and len(ref_doc_id) > 0:
            raise NotImplementedError(
                "Delete by ref_doc_id not yet implemented for Zep."
            )

        if "uuid" in delete_kwargs:
            self._collection.delete_document(uuid=delete_kwargs["uuid"])
        else:
            raise ValueError("uuid must be specified")

    async def adelete(
        self, ref_doc_id: Optional[str] = None, **delete_kwargs: Any
    ) -> None:  # type: ignore
        """异步从集合中删除文档。

Args:
    ref_doc_id（可选[str]）：要删除的文档的ID。
        目前不支持。
    delete_kwargs：必须包含带有要删除的文档的UUID的“uuid”键。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if ref_doc_id and len(ref_doc_id) > 0:
            raise NotImplementedError(
                "Delete by ref_doc_id not yet implemented for Zep."
            )

        if "uuid" in delete_kwargs:
            await self._collection.adelete_document(uuid=delete_kwargs["uuid"])
        else:
            raise ValueError("uuid must be specified")

    def _parse_query_result(
        self, results: List["ZepDocument"]
    ) -> VectorStoreQueryResult:
        similarities: List[float] = []
        ids: List[str] = []
        nodes: List[TextNode] = []

        for d in results:
            node = metadata_dict_to_node(d.metadata or {})
            node.set_content(d.content)

            nodes.append(node)

            if d.score is None:
                d.score = 0.0
            similarities.append(d.score)

            if d.document_id is None:
                d.document_id = ""
            ids.append(d.document_id)

        return VectorStoreQueryResult(nodes=nodes, similarities=similarities, ids=ids)

    def _to_zep_filters(self, filters: MetadataFilters) -> Dict[str, Any]:
        """将过滤器转换为 Zep 过滤器。过滤器之间使用 AND 运算。"""
        filter_conditions: List[Dict[str, Any]] = []

        for f in filters.legacy_filters():
            filter_conditions.append({"jsonpath": f'$[*] ? (@.{f.key} == "{f.value}")'})

        return {"where": {"and": filter_conditions}}

    def query(
        self,
        query: VectorStoreQuery,
        **kwargs: Any,
    ) -> VectorStoreQueryResult:
        """查询索引以获取与给定查询最相似的前k个节点。

Args:
    query（VectorStoreQuery）：包含查询字符串或查询嵌入的查询对象。

Returns:
    VectorStoreQueryResult：查询结果，包含最相似的节点、它们的相似度和它们的ID。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if query.query_embedding is None and query.query_str is None:
            raise ValueError("query must have one of query_str or query_embedding")

        # If we have an embedding, we shouldn't use the query string
        # Zep does not allow both to be set
        if query.query_embedding:
            query.query_str = None

        metadata_filters = None
        if query.filters is not None:
            metadata_filters = self._to_zep_filters(query.filters)

        results = self._collection.search(
            text=query.query_str,
            embedding=query.query_embedding,
            metadata=metadata_filters,
            limit=query.similarity_top_k,
        )

        return self._parse_query_result(results)

    async def aquery(
        self,
        query: VectorStoreQuery,
        **kwargs: Any,
    ) -> VectorStoreQueryResult:
        """异步查询索引，以获取与给定查询最相似的前k个节点。

Args:
    query (VectorStoreQuery): 查询对象，包含查询字符串或查询嵌入。

Returns:
    VectorStoreQueryResult: 查询结果，包含最相似的节点、它们的相似度和它们的ID。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if query.query_embedding is None and query.query_str is None:
            raise ValueError("query must have one of query_str or query_embedding")

        # If we have an embedding, we shouldn't use the query string
        # Zep does not allow both to be set
        if query.query_embedding:
            query.query_str = None

        metadata_filters = None
        if query.filters is not None:
            metadata_filters = self._to_zep_filters(query.filters)

        results = await self._collection.asearch(
            text=query.query_str,
            embedding=query.query_embedding,
            metadata=metadata_filters,
            limit=query.similarity_top_k,
        )

        return self._parse_query_result(results)

client property #

client: Any

获取客户端。

add #

add(nodes: List[BaseNode], **add_kwargs: Any) -> List[str]

将节点添加到集合中。

Returns:

Type Description
List[str]

List[str]：添加文档的ID列表。
Source code in llama_index/vector_stores/zep/base.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
    def add(self, nodes: List[BaseNode], **add_kwargs: Any) -> List[str]:
        """将节点添加到集合中。

Args:
    nodes（List[BaseNode]）：带有嵌入的节点列表。

Returns:
    List[str]：添加文档的ID列表。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if self._collection.is_auto_embedded:
            raise ValueError("Collection is auto embedded, cannot add embeddings")

        docs, ids = self._prepare_documents(nodes)

        self._collection.add_documents(docs)

        return ids

async_add async #

async_add(
    nodes: List[BaseNode], **add_kwargs: Any
) -> List[str]

异步地向集合中添加节点。

Returns:

Type Description
List[str]

List[str]：添加文档的ID列表。
Source code in llama_index/vector_stores/zep/base.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    async def async_add(
        self,
        nodes: List[BaseNode],
        **add_kwargs: Any,
    ) -> List[str]:
        """异步地向集合中添加节点。

Args:
    nodes（List[BaseNode]）：带有嵌入的节点列表。

Returns:
    List[str]：添加文档的ID列表。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if self._collection.is_auto_embedded:
            raise ValueError("Collection is auto embedded, cannot add embeddings")

        docs, ids = self._prepare_documents(nodes)

        await self._collection.aadd_documents(docs)

        return ids

delete #

delete(
    ref_doc_id: Optional[str] = None, **delete_kwargs: Any
) -> None

从集合中删除一个文档。

Source code in llama_index/vector_stores/zep/base.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
    def delete(
        self, ref_doc_id: Optional[str] = None, **delete_kwargs: Any
    ) -> None:  # type: ignore
        """从集合中删除一个文档。

Args:
    ref_doc_id（可选[str]）：要删除的文档的ID。
        目前不支持。
    delete_kwargs：必须包含带有要删除的文档的UUID的“uuid”键。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if ref_doc_id and len(ref_doc_id) > 0:
            raise NotImplementedError(
                "Delete by ref_doc_id not yet implemented for Zep."
            )

        if "uuid" in delete_kwargs:
            self._collection.delete_document(uuid=delete_kwargs["uuid"])
        else:
            raise ValueError("uuid must be specified")

adelete async #

adelete(
    ref_doc_id: Optional[str] = None, **delete_kwargs: Any
) -> None

异步从集合中删除文档。

Source code in llama_index/vector_stores/zep/base.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
    async def adelete(
        self, ref_doc_id: Optional[str] = None, **delete_kwargs: Any
    ) -> None:  # type: ignore
        """异步从集合中删除文档。

Args:
    ref_doc_id（可选[str]）：要删除的文档的ID。
        目前不支持。
    delete_kwargs：必须包含带有要删除的文档的UUID的“uuid”键。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if ref_doc_id and len(ref_doc_id) > 0:
            raise NotImplementedError(
                "Delete by ref_doc_id not yet implemented for Zep."
            )

        if "uuid" in delete_kwargs:
            await self._collection.adelete_document(uuid=delete_kwargs["uuid"])
        else:
            raise ValueError("uuid must be specified")

query #

query(
    query: VectorStoreQuery, **kwargs: Any
) -> VectorStoreQueryResult

查询索引以获取与给定查询最相似的前k个节点。

Returns:

Type Description
VectorStoreQueryResult

VectorStoreQueryResult：查询结果，包含最相似的节点、它们的相似度和它们的ID。
Source code in llama_index/vector_stores/zep/base.py 
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
    def query(
        self,
        query: VectorStoreQuery,
        **kwargs: Any,
    ) -> VectorStoreQueryResult:
        """查询索引以获取与给定查询最相似的前k个节点。

Args:
    query（VectorStoreQuery）：包含查询字符串或查询嵌入的查询对象。

Returns:
    VectorStoreQueryResult：查询结果，包含最相似的节点、它们的相似度和它们的ID。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if query.query_embedding is None and query.query_str is None:
            raise ValueError("query must have one of query_str or query_embedding")

        # If we have an embedding, we shouldn't use the query string
        # Zep does not allow both to be set
        if query.query_embedding:
            query.query_str = None

        metadata_filters = None
        if query.filters is not None:
            metadata_filters = self._to_zep_filters(query.filters)

        results = self._collection.search(
            text=query.query_str,
            embedding=query.query_embedding,
            metadata=metadata_filters,
            limit=query.similarity_top_k,
        )

        return self._parse_query_result(results)

aquery async #

aquery(
    query: VectorStoreQuery, **kwargs: Any
) -> VectorStoreQueryResult

异步查询索引，以获取与给定查询最相似的前k个节点。

Parameters:

Name Type Description Default
query VectorStoreQuery

查询对象，包含查询字符串或查询嵌入。

 required

Returns:

Name Type Description
VectorStoreQueryResult VectorStoreQueryResult

查询结果，包含最相似的节点、它们的相似度和它们的ID。
Source code in llama_index/vector_stores/zep/base.py 
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
    async def aquery(
        self,
        query: VectorStoreQuery,
        **kwargs: Any,
    ) -> VectorStoreQueryResult:
        """异步查询索引，以获取与给定查询最相似的前k个节点。

Args:
    query (VectorStoreQuery): 查询对象，包含查询字符串或查询嵌入。

Returns:
    VectorStoreQueryResult: 查询结果，包含最相似的节点、它们的相似度和它们的ID。
"""
        if not isinstance(self._collection, DocumentCollection):
            raise ValueError("Collection not initialized")

        if query.query_embedding is None and query.query_str is None:
            raise ValueError("query must have one of query_str or query_embedding")

        # If we have an embedding, we shouldn't use the query string
        # Zep does not allow both to be set
        if query.query_embedding:
            query.query_str = None

        metadata_filters = None
        if query.filters is not None:
            metadata_filters = self._to_zep_filters(query.filters)

        results = await self._collection.asearch(
            text=query.query_str,
            embedding=query.query_embedding,
            metadata=metadata_filters,
            limit=query.similarity_top_k,
        )

        return self._parse_query_result(results)