MongoDBChatMessageHistory#
- class langchain_community.chat_message_histories.mongodb.MongoDBChatMessageHistory(connection_string: str, session_id: str, database_name: str = 'chat_history', collection_name: str = 'message_store', create_index: bool = True)[source]#
Deprecated since version 0.0.25: Use
langchain_mongodb.MongoDBChatMessageHistory
instead.Chat message history that stores history in MongoDB.
- Parameters:
connection_string (str) β connection string to connect to MongoDB
session_id (str) β arbitrary key that is used to store the messages of a single chat session.
database_name (str) β name of the database to use
collection_name (str) β name of the collection to use
create_index (bool) β whether to create an index with name SessionId. Set to False if such an index already exists.
Attributes
messages
Retrieve the messages from MongoDB
Methods
__init__
(connection_string,Β session_id[,Β ...])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 MongoDB
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 MongoDB
- __init__(connection_string: str, session_id: str, database_name: str = 'chat_history', collection_name: str = 'message_store', create_index: bool = True)[source]#
- Parameters:
connection_string (str) β
session_id (str) β
database_name (str) β
collection_name (str) β
create_index (bool) β
- 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 MongoDB
- 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]