FirestoreChatMessageHistory#

class langchain_community.chat_message_histories.firestore.FirestoreChatMessageHistory(collection_name: str, session_id: str, user_id: str, firestore_client: Client | None = 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

Methods

__init__(collection_name,Β session_id,Β user_id)

Initialize a new instance of the FirestoreChatMessageHistory class.

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)

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: Client | None = 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#

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

Add a Message object to the store.

Parameters:

message (BaseMessage) – A BaseMessage object to store.

Raises:

NotImplementedError – If the sub-class has not implemented an efficient add_messages method.

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 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: BaseMessage | None = None) β†’ None[source]#

Update the Firestore document.

Parameters:

new_message (BaseMessage | None)

Return type:

None