BaseMemory

Defined in: packages/core/src/memory/base.ts:12

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

Extended by

• ChatSummaryMemoryBuffer

Type Parameters

AdditionalMessageOptions

AdditionalMessageOptions extends object = object

Constructors

Constructor

new BaseMemory<AdditionalMessageOptions>(): BaseMemory<AdditionalMessageOptions>

Returns

BaseMemory<AdditionalMessageOptions>

Methods

getMessages()

abstract getMessages(transientMessages?): ChatMessage<AdditionalMessageOptions>[] | Promise<ChatMessage<AdditionalMessageOptions>[]>

Defined in: packages/core/src/memory/base.ts:22

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?

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

ChatMessage<AdditionalMessageOptions>[] | Promise<ChatMessage<AdditionalMessageOptions>[]>

An array of chat messages, either synchronously or as a Promise.

---

getAllMessages()

abstract getAllMessages(): ChatMessage<AdditionalMessageOptions>[] | Promise<ChatMessage<AdditionalMessageOptions>[]>

Defined in: packages/core/src/memory/base.ts:32

Retrieves all messages stored in the memory.

Returns

ChatMessage<AdditionalMessageOptions>[] | Promise<ChatMessage<AdditionalMessageOptions>[]>

An array of all chat messages, either synchronously or as a Promise.

---

put()

abstract put(messages): void

Defined in: packages/core/src/memory/base.ts:40

Adds a new message to the memory.

Parameters

messages

ChatMessage<AdditionalMessageOptions>

The chat message to be added to the memory.

Returns

void

---

reset()

abstract reset(): void

Defined in: packages/core/src/memory/base.ts:45

Clears all messages from the memory.

Returns

void

---

_tokenCountForMessages()

protected _tokenCountForMessages(messages): number

Defined in: packages/core/src/memory/base.ts:47

Parameters

messages

ChatMessage[]

Returns

number