langchain_community.chat_message_histories.file.FileChatMessageHistory

class langchain_community.chat_message_histories.file.FileChatMessageHistory(file_path: str, *

将聊天历史存储在本地文件中的聊天历史。

初始化聊天历史的文件路径。 :param file_path: 存储聊天历史本地文件的路径。 :param encoding: 用于文件操作的编码。默认为 None。 :param ensure_ascii: 如果为 True，则对 JSON 中的非 ASCII 字符进行转义。默认为 True。

属性

messages

从本地文件检索消息

方法

__init__(file_path, *[, encoding, ensure_ascii])

初始化聊天历史的文件路径。

aadd_messages(messages)

异步添加消息列表。

aclear()

异步从存储中移除所有消息

add_ai_message(message)

将 AI 消息字符串添加到存储的方便方法。

add_message(message)

将消息追加到本地文件中的记录

add_messages(messages)

添加消息列表。

add_user_message(message)

将人类消息字符串添加到存储的方便方法。

aget_messages()

获取消息的异步版本。

clear()

从本地文件中清除会话内存
参数

  • file_path (str) –

  • encoding (Optional[str]) –

  • ensure_ascii (bool) –

__init__(file_path: str, *, encoding: Optional[str] = None, ensure_ascii: bool = True) → None[源代码]

初始化聊天历史的文件路径。 :param file_path: 存储聊天历史本地文件的路径。 :param encoding: 用于文件操作的编码。默认为 None。 :param ensure_ascii: 如果为 True，则对 JSON 中的非 ASCII 字符进行转义。默认为 True。

参数

  • file_path (str) –

  • encoding (Optional[str]) –

  • ensure_ascii (bool) –

返回类型

None

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

异步添加消息列表。

参数

messages (Sequence[BaseMessage]) – 存储的 BaseMessage 对象序列。

返回类型

None

async aclear() → None

异步从存储中移除所有消息

返回类型

None

add_ai_message(message: Union[AIMessage, str]) → None

将 AI 消息字符串添加到存储的方便方法。

请注意，这是一个便捷方法。建议代码优先使用批量添加消息的接口，以减少对底层持久化层的往返调用。

此方法可能在未来的版本中被弃用。

参数

message (Union[AIMessage, str]) – 要添加的 AI 消息。

返回类型

None

add_message(message: BaseMessage) → None[源代码]

将消息追加到本地文件中的记录

参数

message (BaseMessage) –

返回类型

None

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

添加消息列表。

实现此方法以高效批量添加消息，避免对底层存储的重复访问。

参数

messages (Sequence[BaseMessage]) – 存储的 BaseMessage 对象序列。

返回类型

None

add_user_message(message: Union[HumanMessage, str]) → None

将人类消息字符串添加到存储的方便方法。

请注意，这是一个便捷方法。建议代码优先使用批量添加消息的接口，以减少对底层持久化层的往返调用。

此方法可能在未来的版本中被弃用。

参数

message (Union[HumanMessage, str]) – 要添加到存储中的人类消息。

返回类型

None

asyncaget_messages() → List[BaseMessage]

获取消息的异步版本。

可以覆盖此方法以提供高效的异步实现。

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

返回类型

列表[BaseMessage]

clear() → None[源代码]

从本地文件中清除会话内存

返回类型

None