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 :class:`~langchain_mongodb.MongoDBChatMessageHistory` instead. It will be removed in None==1.0.

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.

aget_messages()

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]

clear() → None[source]#

Clear session memory from MongoDB

Return type:

None