Class ChatMessageHistory

Class for storing chat message history in-memory. It extends the BaseListChatMessageHistory class and provides methods to get, add, and clear messages.

Hierarchy

BaseListChatMessageHistory
- ChatMessageHistory

Index

Constructors

Methods

addAIChatMessage addMessage addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

new ChatMessageHistory(messages?): ChatMessageHistory
Parameters
- Optional messages: BaseMessage[]
Returns ChatMessageHistory
Overrides BaseListChatMessageHistory.constructor
- Defined in docs/api_refs/langchain/src/stores/message/in_memory.ts:14

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 ChatMessageHistory instance.
Parameters
- message: BaseMessage
  
  The BaseMessage instance to add.
Returns Promise<void>
A promise that resolves when the message has been added.
Overrides BaseListChatMessageHistory.addMessage
- Defined in docs/api_refs/langchain/src/stores/message/in_memory.ts:33

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 clear all the messages from the ChatMessageHistory instance.

Returns Promise<void>
A promise that resolves when all messages have been cleared.
- Defined in docs/api_refs/langchain/src/stores/message/in_memory.ts:41

getMessages

getMessages(): Promise<BaseMessage[]>
Method to get all the messages stored in the ChatMessageHistory instance.

Returns Promise<BaseMessage[]>
Array of stored BaseMessage instances.
- Defined in docs/api_refs/langchain/src/stores/message/in_memory.ts:24

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