Class FirestoreChatMessageHistory

Class for managing chat message history using Google's Firestore as a storage backend. Extends the BaseListChatMessageHistory class.

Hierarchy

BaseListChatMessageHistory
- FirestoreChatMessageHistory

Index

Constructors

Methods

addAIChatMessage addMessage addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

new FirestoreChatMessageHistory(__namedParameters): FirestoreChatMessageHistory
Parameters
- __namedParameters: FirestoreDBChatMessageHistory
Returns FirestoreChatMessageHistory
Overrides BaseListChatMessageHistory.constructor
- Defined in docs/api_refs/langchain/src/stores/message/firestore.ts:55

Methods

addAIChatMessage

addAIChatMessage(message): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from BaseListChatMessageHistory.addAIChatMessage
- Defined in docs/api_refs/langchain/src/schema/index.ts:895

addMessage

addMessage(message): Promise<void>
Method to add a new message to the Firestore collection. The message is passed as a BaseMessage object.
Parameters
- message: BaseMessage
  
  The message to be added as a BaseMessage object.
Returns Promise<void>
Overrides BaseListChatMessageHistory.addMessage
- Defined in docs/api_refs/langchain/src/stores/message/firestore.ts:123

addUserMessage

addUserMessage(message): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from BaseListChatMessageHistory.addUserMessage
- Defined in docs/api_refs/langchain/src/schema/index.ts:891

clear

clear(): Promise<void>
Method to delete all messages from the Firestore collection associated with the current session.

Returns Promise<void>
- Defined in docs/api_refs/langchain/src/stores/message/firestore.ts:156

getMessages

getMessages(): Promise<BaseMessage[]>
Method to retrieve all messages from the Firestore collection associated with the current session. Returns an array of BaseMessage objects.

Returns Promise<BaseMessage[]>
Array of stored messages
- Defined in docs/api_refs/langchain/src/stores/message/firestore.ts:96

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseListChatMessageHistory.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseListChatMessageHistory.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

Generated using TypeDoc