langchain_community.chat_message_histories.firestore.FirestoreChatMessageHistory¶

class langchain_community.chat_message_histories.firestore.FirestoreChatMessageHistory(collection_name: str, session_id: str, user_id: str, firestore_client: Optional[Client] = None)[source]¶

Chat message history backed by Google Firestore.

Initialize a new instance of the FirestoreChatMessageHistory class.

Parameters

  • collection_name (str) – The name of the collection to use.

  • session_id (str) – The session ID for the chat..

  • user_id (str) – The user ID for the chat.

  • firestore_client (Optional[Client]) –

Attributes

messages

A property or attribute that returns a list of messages.

Methods

__init__(collection_name, session_id, user_id)

Initialize a new instance of the FirestoreChatMessageHistory class.

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)

Add a Message object to the store.

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 this memory and Firestore.

load_messages()

Retrieve the messages from Firestore

prepare_firestore()

Prepare the Firestore client.

upsert_messages([new_message])

Update the Firestore document.
__init__(collection_name: str, session_id: str, user_id: str, firestore_client: Optional[Client] = None)[source]¶

Initialize a new instance of the FirestoreChatMessageHistory class.

Parameters

  • collection_name (str) – The name of the collection to use.

  • session_id (str) – The session ID for the chat..

  • user_id (str) – The user ID for the chat.

  • firestore_client (Optional[Client]) –

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]¶

Add a Message object to the store.

Parameters

message (BaseMessage) – A BaseMessage object to store.

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]

clear() → None[source]¶

Clear session memory from this memory and Firestore.

Return type

None

load_messages() → None[source]¶

Retrieve the messages from Firestore

Return type

None

prepare_firestore() → None[source]¶

Prepare the Firestore client.

Use this function to make sure your database is ready.

Return type

None

upsert_messages(new_message: Optional[BaseMessage] = None) → None[source]¶

Update the Firestore document.

Parameters

new_message (Optional[BaseMessage]) –

Return type

None