Skip to main content

Class: SimpleChatHistory

A ChatHistory is used to keep the state of back and forth chat messages

Extends​

Constructors​

new SimpleChatHistory()​

new SimpleChatHistory(init?): SimpleChatHistory

Parameters​

• init?: Partial <SimpleChatHistory>

Returns​

SimpleChatHistory

Overrides​

ChatHistory . constructor

Source​

packages/core/src/ChatHistory.ts:43

Properties​

messages​

messages: ChatMessage[]

Overrides​

ChatHistory . messages

Source​

packages/core/src/ChatHistory.ts:40

messagesBefore​

private messagesBefore: number

Source​

packages/core/src/ChatHistory.ts:41

Methods​

addMessage()​

addMessage(message): void

Adds a message to the chat history.

Parameters​

• message: ChatMessage

Returns​

void

Overrides​

ChatHistory . addMessage

Source​

packages/core/src/ChatHistory.ts:49

newMessages()​

newMessages(): ChatMessage[]

Returns the new messages since the last call to this function (or since calling the constructor)

Returns​

ChatMessage[]

Overrides​

ChatHistory . newMessages

Source​

packages/core/src/ChatHistory.ts:61

requestMessages()​

requestMessages(transientMessages?): Promise <ChatMessage[]>

Returns the messages that should be used as input to the LLM.

Parameters​

• transientMessages?: ChatMessage[]

Returns​

Promise <ChatMessage[]>

Overrides​

ChatHistory . requestMessages

Source​

packages/core/src/ChatHistory.ts:53

reset()​

reset(): void

Resets the chat history so that it's empty.

Returns​

void

Overrides​

ChatHistory . reset

Source​

packages/core/src/ChatHistory.ts:57