Skip to documentation
Docs navigation
Docs/forget()
MemoGrafterAgent

forget()

Soft-forget one memory.

What it does

Soft-forget one memory.

When to use it

Use to remove one memory from active retrieval while retaining audit history.

Signature

TypeScript
forget(memoryId: string): Promise<boolean>

Parameters

memoryId (string) — The memory record to inspect or change.

Result

true when a row changed; otherwise false.

Behavior

Marks the memory forgotten. It returns true only when a row changed and false when the target was missing or already forgotten.

Side effects and completion

The row remains available to history and explicit lifecycle inspection.

Example

example.ts
const changed = await agent.forget(memoryId);