ChatSummaryMemoryBuffer
Defined in: packages/core/src/memory/summary-memory.ts:8
A ChatMemory is used to keep the state of back and forth chat messages
Extends
Constructors
Constructor
new ChatSummaryMemoryBuffer(
options?):ChatSummaryMemoryBuffer
Defined in: packages/core/src/memory/summary-memory.ts:19
Parameters
options?
Partial<ChatSummaryMemoryBuffer>
Returns
ChatSummaryMemoryBuffer
Overrides
Properties
tokenizer
tokenizer:
Tokenizer
Defined in: packages/core/src/memory/summary-memory.ts:13
Tokenizer function that converts text to tokens, this is used to calculate the number of tokens in a message.
tokensToSummarize
tokensToSummarize:
number
Defined in: packages/core/src/memory/summary-memory.ts:14
messages
messages:
ChatMessage[]
Defined in: packages/core/src/memory/summary-memory.ts:15
summaryPrompt
summaryPrompt:
SummaryPrompt
Defined in: packages/core/src/memory/summary-memory.ts:16
llm
llm:
LLM
Defined in: packages/core/src/memory/summary-memory.ts:17
Methods
_tokenCountForMessages()
protected_tokenCountForMessages(messages):number
Defined in: packages/core/src/memory/base.ts:47
Parameters
messages
Returns
number
Inherited from
BaseMemory._tokenCountForMessages
getLastSummary()
getLastSummary():
null|ChatMessage
Defined in: packages/core/src/memory/summary-memory.ts:79
Returns
null | ChatMessage
reset()
reset():
void
Defined in: packages/core/src/memory/summary-memory.ts:127
Clears all messages from the memory.
Returns
void
Overrides
getMessages()
getMessages(
transientMessages?):Promise<ChatMessage[]>
Defined in: packages/core/src/memory/summary-memory.ts:131
Retrieves messages from the memory, optionally including transient messages. Compared to getAllMessages, this method a) allows for transient messages to be included in the retrieval and b) may return a subset of the total messages by applying a token limit.
Parameters
transientMessages?
Optional array of temporary messages to be included in the retrieval. These messages are not stored in the memory but are considered for the current interaction.
Returns
Promise<ChatMessage[]>
An array of chat messages, either synchronously or as a Promise.
Overrides
getAllMessages()
getAllMessages():
Promise<ChatMessage[]>
Defined in: packages/core/src/memory/summary-memory.ts:161
Retrieves all messages stored in the memory.
Returns
Promise<ChatMessage[]>
An array of all chat messages, either synchronously or as a Promise.
Overrides
put()
put(
message):void
Defined in: packages/core/src/memory/summary-memory.ts:165
Adds a new message to the memory.
Parameters
message
Returns
void