RetainOptions

Defined in: src/lib/memory/types.ts:188 

Properties

autoMergeThreshold?

optional autoMergeThreshold: number

Defined in: src/lib/memory/types.ts:196 

Cosine similarity threshold for auto-merge. Default: 0.85.

consolidateOptions?

optional consolidateOptions: object

Defined in: src/lib/memory/types.ts:203 

When provided, runs an LLM-based consolidation pass against the top-K existing memories above consolidateThreshold (looser than auto-merge). The LLM emits create/update/noop per Hindsight’s facet-dedup rules. Auth/endpoint required; without these we keep the cosine-only path.

apiKey

apiKey: string

baseUrl?

optional baseUrl: string

model?

optional model: string

onFallback()?

optional onFallback: (reason: ConsolidationFallbackReason) => void

Invoked when the consolidator degrades to its “create” fallback instead of returning a real decision — llm_error for network / timeout / unparseable output, invalid_response for well-formed JSON that violates the schema (unknown action, bad targetId). A flaky consolidator silently accumulates duplicate memories; wire this to logging/metrics so the fallback rate is observable.

Parameters

Returns

void

consolidateThreshold?

optional consolidateThreshold: number

Defined in: src/lib/memory/types.ts:218 

Cosine similarity floor for the consolidator candidate set. Default: 0.65.

consolidateTopK?

optional consolidateTopK: number

Defined in: src/lib/memory/types.ts:220 

Top-K consolidation candidates to feed the LLM. Default: 5.

enableAutoMerge?

optional enableAutoMerge: boolean

Defined in: src/lib/memory/types.ts:194 

When provided, applies merge-on-write logic instead of plain insert.

eventTime?

optional eventTime: { end: number | null; kind: "point" | "range" | "ongoing"; start: number; } | null

Defined in: src/lib/memory/types.ts:227 

W6 temporal lane — when the event in this fact occurred. Persisted to memory_vault.event_time_* columns; recall’s temporal lane filters and boosts memories whose event-time overlaps the query window. Auto-extraction emits this; manual writes can omit it.

folderId?

optional folderId: string | null

Defined in: src/lib/memory/types.ts:192 

scope?

optional scope: string

Defined in: src/lib/memory/types.ts:191 

source?

optional source: RetainSource

Defined in: src/lib/memory/types.ts:189 

sourceChunkIds?

optional sourceChunkIds: string[]

Defined in: src/lib/memory/types.ts:190