Class: abstract ChatHistory<AdditionalMessageOptions>
A ChatHistory is used to keep the state of back and forth chat messages
Extended by
Type Parameters
• AdditionalMessageOptions extends object = object
Constructors
new ChatHistory()
new ChatHistory<
AdditionalMessageOptions>():ChatHistory<AdditionalMessageOptions>
Returns
ChatHistory<AdditionalMessageOptions>
Accessors
messages
getabstractmessages():ChatMessage<AdditionalMessageOptions>[]
Returns
ChatMessage<AdditionalMessageOptions>[]
Defined in
packages/llamaindex/src/ChatHistory.ts:16
Methods
addMessage()
abstractaddMessage(message):void
Adds a message to the chat history.
Parameters
• message: ChatMessage<AdditionalMessageOptions>
Returns
void
Defined in
packages/llamaindex/src/ChatHistory.ts:21
newMessages()
abstractnewMessages():ChatMessage<AdditionalMessageOptions>[]
Returns the new messages since the last call to this function (or since calling the constructor)
Returns
ChatMessage<AdditionalMessageOptions>[]
Defined in
packages/llamaindex/src/ChatHistory.ts:38
requestMessages()
abstractrequestMessages(transientMessages?):Promise<ChatMessage<AdditionalMessageOptions>[]>
Returns the messages that should be used as input to the LLM.
Parameters
• transientMessages?: ChatMessage<AdditionalMessageOptions>[]
Returns
Promise<ChatMessage<AdditionalMessageOptions>[]>
Defined in
packages/llamaindex/src/ChatHistory.ts:26
reset()
abstractreset():void
Resets the chat history so that it's empty.
Returns
void