BaseMemory
Defined in: .build/typescript/packages/core/src/memory/deprecated/base.ts:13
A ChatMemory is used to keep the state of back and forth chat messages
Deprecated
Section titled “Deprecated”Use Memory instead.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”AdditionalMessageOptions
Section titled “AdditionalMessageOptions”AdditionalMessageOptions extends object = object
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseMemory<
AdditionalMessageOptions>():BaseMemory<AdditionalMessageOptions>
Returns
Section titled “Returns”BaseMemory<AdditionalMessageOptions>
Methods
Section titled “Methods”getMessages()
Section titled “getMessages()”
abstractgetMessages(transientMessages?):ChatMessage<AdditionalMessageOptions>[] |Promise<ChatMessage<AdditionalMessageOptions>[]>
Defined in: .build/typescript/packages/core/src/memory/deprecated/base.ts:23
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
Section titled “Parameters”transientMessages?
Section titled “transientMessages?”ChatMessage<AdditionalMessageOptions>[]
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
Section titled “Returns”ChatMessage<AdditionalMessageOptions>[] | Promise<ChatMessage<AdditionalMessageOptions>[]>
An array of chat messages, either synchronously or as a Promise.
getAllMessages()
Section titled “getAllMessages()”
abstractgetAllMessages():ChatMessage<AdditionalMessageOptions>[] |Promise<ChatMessage<AdditionalMessageOptions>[]>
Defined in: .build/typescript/packages/core/src/memory/deprecated/base.ts:33
Retrieves all messages stored in the memory.
Returns
Section titled “Returns”ChatMessage<AdditionalMessageOptions>[] | Promise<ChatMessage<AdditionalMessageOptions>[]>
An array of all chat messages, either synchronously or as a Promise.
abstractput(messages):void
Defined in: .build/typescript/packages/core/src/memory/deprecated/base.ts:41
Adds a new message to the memory.
Parameters
Section titled “Parameters”messages
Section titled “messages”ChatMessage<AdditionalMessageOptions>
The chat message to be added to the memory.
Returns
Section titled “Returns”void
reset()
Section titled “reset()”
abstractreset():void
Defined in: .build/typescript/packages/core/src/memory/deprecated/base.ts:46
Clears all messages from the memory.
Returns
Section titled “Returns”void
_tokenCountForMessages()
Section titled “_tokenCountForMessages()”
protected_tokenCountForMessages(messages):number
Defined in: .build/typescript/packages/core/src/memory/deprecated/base.ts:48
Parameters
Section titled “Parameters”messages
Section titled “messages”Returns
Section titled “Returns”number