Skip to main content

Interface: CognitiveRetrievalOptions

Defined in: packages/agentos/src/cognition/memory/core/types.ts:400

Properties​

entities?​

optional entities: string[]

Defined in: packages/agentos/src/cognition/memory/core/types.ts:405

hyde?​

optional hyde: boolean

Defined in: packages/agentos/src/cognition/memory/core/types.ts:439

Enable HyDE (Hypothetical Document Embedding) for memory retrieval.

When true and a HyDE retriever is configured on the memory manager, the system generates a hypothetical memory trace matching the query before embedding. This produces embeddings that are closer to actual stored memories, improving recall — especially for vague or abstract recall prompts (e.g. "that thing we discussed about deployment").

Adds one LLM call per retrieval. Use for important lookups where recall quality matters more than latency.

Default​

false

maxTierRank?​

optional maxTierRank: number

Defined in: packages/agentos/src/cognition/memory/core/types.ts:424

Optional visibility ceiling for prospective alerts. Items registered with a tierRank greater than this are withheld from the assembled "Reminders" section. Used only for prospective gating in assembleForPrompt; retrieve ignores it.

minConfidence?​

optional minConfidence: number

Defined in: packages/agentos/src/cognition/memory/core/types.ts:406

neutralMood?​

optional neutralMood: boolean

Defined in: packages/agentos/src/cognition/memory/core/types.ts:417

If true, skip emotional congruence bias (useful for factual lookups).

policy?​

optional policy: MemoryRetrievalPolicy

Defined in: packages/agentos/src/cognition/memory/core/types.ts:441

Shared retrieval profile and confidence policy.

scopes?​

optional scopes: object[]

Defined in: packages/agentos/src/cognition/memory/core/types.ts:403

scope​

scope: MemoryScope

scopeId​

scopeId: string

scoringWeights?​

optional scoringWeights: Partial<ScoringWeights>

Defined in: packages/agentos/src/cognition/memory/core/types.ts:449

Override the 6-signal retrieval weights for this call. Missing keys fall back to DEFAULT_SCORING_WEIGHTS. Useful for ablation studies (zero one weight at a time and measure Δaccuracy) and for A/B testing alternate weight configurations without mutating global defaults.

tags?​

optional tags: string[]

Defined in: packages/agentos/src/cognition/memory/core/types.ts:404

timeRange?​

optional timeRange: object

Defined in: packages/agentos/src/cognition/memory/core/types.ts:415

after?​

optional after: number

before?​

optional before: number

topK?​

optional topK: number

Defined in: packages/agentos/src/cognition/memory/core/types.ts:401

types?​

optional types: MemoryType[]

Defined in: packages/agentos/src/cognition/memory/core/types.ts:402

usableFor?​

optional usableFor: TrustCapability | TrustCapability[]

Defined in: packages/agentos/src/cognition/memory/core/types.ts:414

Restrict results to traces whose trust policy permits the listed capabilities. Pass a single capability or an array (AND semantics: a trace must permit every requested capability). Applies the same staleness check as canUseFor when the policy declares requiresReverificationAfterMs.