Interface: CognitiveRetrievalOptions

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

Properties

entities?

optional entities: string[]

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

---

hyde?

optional hyde: boolean

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

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

---

minConfidence?

optional minConfidence: number

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

---

neutralMood?

optional neutralMood: boolean

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

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

---

policy?

optional policy: MemoryRetrievalPolicy

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

Shared retrieval profile and confidence policy.

---

scopes?

optional scopes: object[]

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

scope

scope: MemoryScope

scopeId

scopeId: string

---

scoringWeights?

optional scoringWeights: Partial<ScoringWeights>

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

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:398

---

timeRange?

optional timeRange: object

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

after?

optional after: number

before?

optional before: number

---

topK?

optional topK: number

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

---

types?

optional types: MemoryType[]

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

---

usableFor?

optional usableFor: TrustCapability | TrustCapability[]

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

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.