Class: ChatHistory
A ChatHistory is used to keep the state of back and forth chat messages
Hierarchy
ChatHistory
Constructors
constructor
• new ChatHistory()
Accessors
messages
• Abstract
get
messages(): ChatMessage
[]
Returns
Defined in
packages/core/src/ChatHistory.ts:13
Methods
addMessage
▸ Abstract
addMessage(message
): void
Adds a message to the chat history.
Parameters
Name | Type |
---|---|
message | ChatMessage |
Returns
void
Defined in
packages/core/src/ChatHistory.ts:18
newMessages
▸ Abstract
newMessages(): ChatMessage
[]
Returns the new messages since the last call to this function (or since calling the constructor)
Returns
Defined in
packages/core/src/ChatHistory.ts:35
requestMessages
▸ Abstract
requestMessages(transientMessages?
): Promise
<ChatMessage
[]>
Returns the messages that should be used as input to the LLM.
Parameters
Name | Type |
---|---|
transientMessages? | ChatMessage [] |
Returns
Promise
<ChatMessage
[]>
Defined in
packages/core/src/ChatHistory.ts:23
reset
▸ Abstract
reset(): void
Resets the chat history so that it's empty.
Returns
void