ChatMemoryBuffer
Defined in: packages/core/src/memory/chat-memory-buffer.ts:15
Extends
BaseChatStoreMemory<AdditionalMessageOptions>
Type Parameters
AdditionalMessageOptions
AdditionalMessageOptions extends object = object
Constructors
Constructor
new ChatMemoryBuffer<
AdditionalMessageOptions>(options?):ChatMemoryBuffer<AdditionalMessageOptions>
Defined in: packages/core/src/memory/chat-memory-buffer.ts:20
Parameters
options?
Partial<ChatMemoryBufferOptions<AdditionalMessageOptions>>
Returns
ChatMemoryBuffer<AdditionalMessageOptions>
Overrides
BaseChatStoreMemory<AdditionalMessageOptions>.constructor
Properties
chatStore
chatStore:
BaseChatStore<AdditionalMessageOptions>
Defined in: packages/core/src/memory/base.ts:62
Inherited from
BaseChatStoreMemory.chatStore
chatStoreKey
chatStoreKey:
string=DEFAULT_CHAT_STORE_KEY
Defined in: packages/core/src/memory/base.ts:63
Inherited from
BaseChatStoreMemory.chatStoreKey
tokenLimit
tokenLimit:
number
Defined in: packages/core/src/memory/chat-memory-buffer.ts:18
Methods
_tokenCountForMessages()
protected_tokenCountForMessages(messages):number
Defined in: packages/core/src/memory/base.ts:47
Parameters
messages
Returns
number
Inherited from
BaseChatStoreMemory._tokenCountForMessages
getAllMessages()
getAllMessages():
ChatMessage<AdditionalMessageOptions>[] |Promise<ChatMessage<AdditionalMessageOptions>[]>
Defined in: packages/core/src/memory/base.ts:68
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.
Inherited from
BaseChatStoreMemory.getAllMessages
put()
put(
messages):void|Promise<void>
Defined in: packages/core/src/memory/base.ts:74
Adds a new message to the memory.
Parameters
messages
ChatMessage<AdditionalMessageOptions>
The chat message to be added to the memory.
Returns
void | Promise<void>
Inherited from
BaseChatStoreMemory.put
set()
set(
messages):void|Promise<void>
Defined in: packages/core/src/memory/base.ts:78
Parameters
messages
ChatMessage<AdditionalMessageOptions>[]
Returns
void | Promise<void>
Inherited from
BaseChatStoreMemory.set
reset()
reset():
void|Promise<void>
Defined in: packages/core/src/memory/base.ts:82
Clears all messages from the memory.
Returns
void | Promise<void>
Inherited from
BaseChatStoreMemory.reset
getMessages()
getMessages(
transientMessages?,initialTokenCount?):Promise<ChatMessage<AdditionalMessageOptions>[]>
Defined in: packages/core/src/memory/chat-memory-buffer.ts:36
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.
initialTokenCount?
number = 0
Returns
Promise<ChatMessage<AdditionalMessageOptions>[]>
An array of chat messages, either synchronously or as a Promise.
Overrides
BaseChatStoreMemory.getMessages