DOCSAPI reference

INTERFACE

Memory

Defined in: packages/components/src/agents/types.ts:78

Conversation memory used by an agent.

Methods

addMessage()

addMessage(message): void;

Defined in: packages/components/src/agents/types.ts:80

Stores a message at the end of the history.

Parameters

Parameter Type
message AgentMessage

Returns

void


clear()

clear(): void;

Defined in: packages/components/src/agents/types.ts:86

Removes every stored message.

Returns

void


getFormattedMemory()

getFormattedMemory(maxTokens?): string | AgentMessage[];

Defined in: packages/components/src/agents/types.ts:84

Returns the history prepared for a model request, optionally limited to maxTokens.

Parameters

Parameter Type
maxTokens? number

Returns

string | AgentMessage[]


getMessages()

getMessages(): AgentMessage[];

Defined in: packages/components/src/agents/types.ts:82

Returns a copy of every stored message, oldest first.

Returns

AgentMessage[]