langchain_community.chat_message_histories.file.FileChatMessageHistory¶
- class langchain_community.chat_message_histories.file.FileChatMessageHistory(file_path: str)[source]¶
Chat message history that stores history in a local file.
Initialize the file path for the chat history.
- Parameters
file_path (str) – The path to the local file to store the chat history.
Attributes
messagesRetrieve the messages from the local file
Methods
__init__(file_path)Initialize the file path for the chat history.
aadd_messages(messages)Add a list of messages.
aclear()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
- __init__(file_path: str) None[source]¶
Initialize the file path for the chat history.
- Parameters
file_path (str) – The path to the local file to store the chat history.
- Return type
None
- async aadd_messages(messages: Sequence[BaseMessage]) None¶
Add a list of messages.
- Parameters
messages (Sequence[BaseMessage]) – A list of BaseMessage objects to store.
- Return type
None
- async aclear() None¶
Remove all messages from the store
- Return type
None
- add_ai_message(message: Union[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 (Union[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 list of BaseMessage objects to store.
- Return type
None
- add_user_message(message: Union[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 (Union[HumanMessage, str]) – The human message to add
- 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]