Skip to main content

Interface: RememberOptions

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:317

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

Properties​

entities?​

optional entities: string[]

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:351

Named entities extracted from or associated with this trace.

Example​

['Alice', 'GPT-4o', 'Q3 roadmap']

id?​

optional id: string

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:364

The new trace's id, when the caller names it before the write: a write the learning ledger records names its new traces in its pending row first. A text the scope already holds is not stored again, and the trace that holds it is returned under its own id.


importance?​

optional importance: number

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:357

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


metadata?​

optional metadata: Record<string, unknown>

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:371

Extra keys for the trace's stored metadata, merged under the keys the facade sets itself (scopeId, content_hash, entities, decay), which win. The rolling-summary sink records contributorIds here, and a memory write on a turn with no learner records turnUserId (MemoryTrace.turnUserId).


scope?​

optional scope: string

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:328

Visibility scope of the trace.

Example​

'thread' | 'user' | 'persona' | 'organization' | 'conversation'

scopeId?​

optional scopeId: string

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:339

Identifier for the scope (e.g. thread ID, user ID). The trace is filed under it, in the scope_id column and in its metadata, and a trace of the same text, type and scope counts as its duplicate only under the same scope id. A call that names none files the trace under '', whatever its scope. Under the 'conversation' scope it must be a key conversationScopeKey built: any other id is refused and nothing is stored.


tags?​

optional tags: string[]

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:345

Free-form tags for filtering and retrieval.

Example​

['project:alpha', 'decision']

type?​

optional type: string

Defined in: packages/agentos/src/cognition/memory/io/facade/types.ts:322

Tulving memory type.

Example​

'episodic' | 'semantic' | 'procedural' | 'prospective'