langchain_community.chat_message_histories.zep.ZepChatMessageHistory

class langchain_community.chat_message_histories.zep.ZepChatMessageHistory(session_id: str, url: str = 'http://localhost:8000', api_key: Optional[str] = None)

使用 Zep 作为后端的聊天消息历史。

推荐用法

# Set up Zep Chat History
zep_chat_history = ZepChatMessageHistory(
    session_id=session_id,
    url=ZEP_API_URL,
    api_key=<your_api_key>,
)

# Use a standard ConversationBufferMemory to encapsulate the Zep chat history
memory = ConversationBufferMemory(
    memory_key="chat_history", chat_memory=zep_chat_history
)

Zep 为 LLM 应用提供长期对话存储。服务器存储、总结、嵌入、索引并丰富对话型 AI 聊天历史，并通过简单的、低延迟的 API 进行公开。

有关服务器安装说明和更多内容，请参阅：https://docs.getzep.com/deployment/quickstart/

此类是对 zep-python 包的薄包装。额外的 Zep 功能通过 zep_summary 和 zep_messages 属性暴露。

有关 zep-python 包的更多信息，请参阅：https://github.com/getzep/zep-python

属性

messages	从 Zep 存储中检索消息
zep_messages	从 Zep 存储中检索摘要
zep_summary	从 Zep 存储中检索摘要

方法

__init__(session_id[, url, api_key])
aadd_messages(messages)	异步将消息追加到 Zep 内存历史中
aclear()	异步清除 Zep 会话内存。
add_ai_message(message[, metadata])	用于向存储中添加 AI 消息字符串的便捷方法。
add_message(message[, metadata])	将消息追加到 Zep 内存历史中
add_messages(messages)	将消息追加到 Zep 内存历史中
add_user_message(message[, metadata])	用于向存储中添加人类消息字符串的便捷方法。
aget_messages()	获取消息的异步版本。
clear()	从 Zep 清除会话内存。
search(查询[, 元数据, 搜索范围, ...])	在Zep内存中搜索与查询匹配的消息

参数

• session_id (字符串) –

• url (字符串) –

• api_key (可选[字符串]) –

__init__(session_id: str, url: str = 'http://localhost:8000', api_key: Optional[str] = None) → None

参数

• session_id (字符串) –

• url (字符串) –

• api_key (可选[字符串]) –

返回类型

None

async aadd_messages(messages: Sequence[BaseMessage]) → None

异步将消息追加到 Zep 内存历史中

参数

messages (序列[BaseMessage]) –

返回类型

None

async aclear() → None

异步地从Zep会话内存中清除。请注意，Zep是内存的长期存储，除非您有特定的数据保留需求，否则不建议这样做。

返回类型

None

add_ai_message(message: str, metadata: Optional[Dict[str, Any]] = None) → None

用于向存储中添加 AI 消息字符串的便捷方法。

参数

• message (str) – 人工智能消息的字符串内容。

• metadata (可选[Dict[str, Any]]) – 可选的附加到消息上的元数据。

返回类型

None

add_message(message: BaseMessage, metadata: Optional[Dict[str, Any]] = None) → None

将消息追加到 Zep 内存历史中

参数

• message (BaseMessage) –

• metadata (可选[Dict[str, Any]]) –

返回类型

None

add_messages(messages: Sequence[BaseMessage]) → None

将消息追加到 Zep 内存历史中

参数

messages (序列[BaseMessage]) –

返回类型

None

add_user_message(message: str, metadata: Optional[Dict[str, Any]] = None) → None

用于向存储中添加人类消息字符串的便捷方法。

参数

• message (str) – 人类消息的字符串内容。

• metadata (可选[Dict[str, Any]]) – 可选的附加到消息上的元数据。

返回类型

None

asyncaget_messages() → List[BaseMessage]¶

获取消息的异步版本。

可以重写此方法以提供高效的异步实现。

通常，获取消息可能涉及到对底层持久层的I/O操作。

返回类型

列表[BaseMessage]

clear() → None

从Zep清除会话内存。请注意，Zep是内存的长久存储，除非您有特定的数据保留需求，否则不建议这么做。

返回类型

None

search(查询: str, 元数据: Optional[Dict] = None, 搜索范围: SearchScope = SearchScope.messages, 搜索类型: SearchType = SearchType.similarity, mmr_lambda: Optional[float] = None, limit: Optional[int] = None) → List[MemorySearchResult]

在Zep内存中搜索与查询匹配的消息

参数

• 查询 (字符串) –

• 元数据 (可选[字典]) –

• 搜索范围 (SearchScope) –

• 搜索类型 (SearchType) –

• mmr_lambda (可选[浮点数]) –

• 限制 (可选[整数]) –

返回类型

列表[MemorySearchResult]