ZepChatMessageHistory#

class langchain_community.chat_message_histories.zep.ZepChatMessageHistory(session_id: str, url: str = 'http://localhost:8000', api_key: str | None = 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包的更多信息，请参阅： 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`(query[, metadata, search_scope, ...])	在Zep内存中搜索与查询匹配的消息

Parameters:

session_id (str)
url (str)
api_key (可选[str])

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

Parameters:

session_id (str)
url (str)
api_key (str | None)

Return type:

无

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

将消息异步附加到Zep内存历史记录中

Parameters:: 消息 (序列[BaseMessage])
Return type:: 无

async aclear() → None[source]#

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

Return type:: 无

add_ai_message(message: str, metadata: Dict[str, Any] | None = None) → None[来源]#

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

Parameters:

message (str) – AI消息的字符串内容。
metadata (Dict[str, Any] | None) – 可选的元数据，附加到消息上。

Return type:

无

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

将消息附加到Zep记忆历史中

Parameters:

消息 (BaseMessage)
metadata (Dict[str, Any] | None)

Return type:

无

add_messages(messages: Sequence[BaseMessage]) → None[source]#

将消息附加到Zep内存历史记录中

Parameters:: 消息 (序列[BaseMessage])
Return type:: 无

add_user_message(message: str, metadata: Dict[str, Any] | None = None) → None[source]#

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

Parameters:

message (str) – 人类消息的字符串内容。
metadata (Dict[str, Any] | None) – 可选的元数据附加到消息上。

Return type:

无

async aget_messages() → list[BaseMessage]#

获取消息的异步版本。

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

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

Return type:: 列表[BaseMessage]

clear() → None[source]#

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

Return type:: 无

search(query: str, metadata: Dict | None = None, search_scope: SearchScope = SearchScope.messages, search_type: SearchType = SearchType.similarity, mmr_lambda: float | None = None, limit: int | None = None) → List[MemorySearchResult][source]#

搜索Zep内存以查找与查询匹配的消息

Parameters:

query (str)
metadata (可选[字典])
search_scope (SearchScope)
search_type (SearchType)
mmr_lambda (可选[float])
limit (可选[整数])

Return type:

列表[内存搜索结果]