FileChatMessageHistory#
- class langchain_community.chat_message_histories.file.FileChatMessageHistory(file_path: str, *, encoding: str | None = None, ensure_ascii: bool = True)[source]#
Chat message history that stores history in a local file.
Initialize the file path for the chat history. :param file_path: The path to the local file to store the chat history. :param encoding: The encoding to use for file operations. Defaults to None. :param ensure_ascii: If True, escape non-ASCII in JSON. Defaults to True.
Attributes
messages
Retrieve the messages from the local file
Methods
__init__
(file_path,Β *[,Β encoding,Β ensure_ascii])Initialize the file path for the chat history.
aadd_messages
(messages)Async add a list of messages.
aclear
()Async remove all messages from the store
add_ai_message
(message)Convenience method for adding an AI message string to the store.
add_message
(message)Append the message to the record in the local file
add_messages
(messages)Add a list of messages.
add_user_message
(message)Convenience method for adding a human message string to the store.
Async version of getting messages.
clear
()Clear session memory from the local file
- Parameters:
file_path (str) β
encoding (str | None) β
ensure_ascii (bool) β
- __init__(file_path: str, *, encoding: str | None = None, ensure_ascii: bool = True) None [source]#
Initialize the file path for the chat history. :param file_path: The path to the local file to store the chat history. :param encoding: The encoding to use for file operations. Defaults to None. :param ensure_ascii: If True, escape non-ASCII in JSON. Defaults to True.
- Parameters:
file_path (str) β
encoding (str | None) β
ensure_ascii (bool) β
- Return type:
None
- async aadd_messages(messages: Sequence[BaseMessage]) None #
Async add a list of messages.
- Parameters:
messages (Sequence[BaseMessage]) β A sequence of BaseMessage objects to store.
- Return type:
None
- async aclear() None #
Async remove all messages from the store
- Return type:
None
- add_ai_message(message: AIMessage | str) None #
Convenience method for adding an AI message string to the store.
Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.
This method may be deprecated in a future release.
- Parameters:
message (AIMessage | str) β The AI message to add.
- Return type:
None
- add_message(message: BaseMessage) None [source]#
Append the message to the record in the local file
- Parameters:
message (BaseMessage) β
- Return type:
None
- add_messages(messages: Sequence[BaseMessage]) None #
Add a list of messages.
Implementations should over-ride this method to handle bulk addition of messages in an efficient manner to avoid unnecessary round-trips to the underlying store.
- Parameters:
messages (Sequence[BaseMessage]) β A sequence of BaseMessage objects to store.
- Return type:
None
- add_user_message(message: HumanMessage | str) None #
Convenience method for adding a human message string to the store.
Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.
This method may be deprecated in a future release.
- Parameters:
message (HumanMessage | str) β The human message to add to the store.
- Return type:
None
- async aget_messages() List[BaseMessage] #
Async version of getting messages.
Can over-ride this method to provide an efficient async implementation.
In general, fetching messages may involve IO to the underlying persistence layer.
- Return type:
List[BaseMessage]