Interface RememberOptions

Options for storing a new memory trace via Memory.remember().

interface RememberOptions {
    type?: string;
    scope?: string;
    scopeId?: string;
    tags?: string[];
    entities?: string[];
    importance?: number;
}

Properties

type?: string

Tulving memory type.

Example

'episodic' | 'semantic' | 'procedural' | 'prospective'
scope?: string

Visibility scope of the trace.

Example

'thread' | 'user' | 'persona' | 'organization'
scopeId?: string

Identifier for the scope (e.g. thread ID, user ID). Required when scope is set.

tags?: string[]

Free-form tags for filtering and retrieval.

Example

['project:alpha', 'decision']
entities?: string[]

Named entities extracted from or associated with this trace.

Example

['Alice', 'GPT-4o', 'Q3 roadmap']
importance?: number

Manually supplied importance score (0–1). When omitted the encoding engine derives one automatically.