Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/core / / MemorySearchOptions

Interface: MemorySearchOptions

Defined in: packages/core/src/types/memory.ts:376

Search options shared across memory tiers.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
asOf?readonlystringPoint-in-time ("as of") read. When set, only records whose validity interval contains this instant are returned. For facts: (valid_from IS NULL OR valid_from <= asOf) AND (valid_to IS NULL OR valid_to > asOf); for episodes: started_at <= asOf. ISO-8601. Absent ⇒ fact reads evaluate validity at NOW (see includeSuperseded).packages/core/src/types/memory.ts:397
dateRange?readonly{ from?: string; to?: string; }-packages/core/src/types/memory.ts:380
dateRange.from?readonlystring-packages/core/src/types/memory.ts:380
dateRange.to?readonlystring-packages/core/src/types/memory.ts:380
includeArchived?readonlyboolean-packages/core/src/types/memory.ts:381
includeQuarantined?readonlybooleanInclude quarantined memories in the result set (P1-4). Defaults to false: action-driving recall never returns quarantined rows. Set true only for the validation / inspector path - never for auto-recall fed back into the model.packages/core/src/types/memory.ts:388
includeSuperseded?readonlybooleanInclude superseded / validity-expired facts in the result set (memory-retrieval-01). Defaults to false: a default read behaves as asOf = now, so a fact whose validTo was closed (e.g. by supersede) never surfaces as current - exactly what the fact_supersede tool promises. Set true only for inspector / audit paths that need the full history. Ignored when an explicit asOf is supplied.packages/core/src/types/memory.ts:407
owner?readonly| MemoryOwner | readonly MemoryOwner[]Retrieval-time principal filter (D3). When set, only records whose owner is in the requested set match; rows written before the feature (owner absent) are treated as 'user'. Absent ⇒ no owner filter - behaviour is unchanged.packages/core/src/types/memory.ts:414
queryreadonlystring-packages/core/src/types/memory.ts:377
signal?readonlyAbortSignal-packages/core/src/types/memory.ts:389
tags?readonlyreadonly string[]-packages/core/src/types/memory.ts:379
topK?readonlynumber-packages/core/src/types/memory.ts:378