Class: CognitiveMemoryManager
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:263
Implements
Constructors
Constructor
new CognitiveMemoryManager():
CognitiveMemoryManager
Returns
CognitiveMemoryManager
Methods
assembleForPrompt()
assembleForPrompt(
query,tokenBudget,mood,options?):Promise<AssembledMemoryContext>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:881
Assemble memory context for prompt injection within a token budget.
Parameters
query
string
tokenBudget
number
mood
options?
CognitiveRetrievalOptions = {}
Returns
Promise<AssembledMemoryContext>
Implementation of
ICognitiveMemoryManager.assembleForPrompt
checkProspective()
checkProspective(
context):Promise<ProspectiveMemoryItem[]>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1116
Check prospective memory triggers (Batch 2).
Parameters
context
events?
string[]
now?
number
queryEmbedding?
number[]
queryText?
string
Returns
Promise<ProspectiveMemoryItem[]>
Implementation of
ICognitiveMemoryManager.checkProspective
compactIfNeeded()
compactIfNeeded(
systemPromptTokens,memoryBudgetTokens):Promise<ContextMessage[] |null>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1254
Run context window compaction if needed. Call BEFORE assembling the LLM prompt. Returns the (potentially compacted) message list for the conversation. If infinite context is disabled, returns null (caller should use original messages).
Parameters
systemPromptTokens
number
memoryBudgetTokens
number
Returns
Promise<ContextMessage[] | null>
encode()
encode(
input,mood,gmiMood,options?):Promise<MemoryTrace>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:539
Encode a new input into a memory trace. Called after each user message.
Parameters
input
string
mood
gmiMood
string
options?
contentSentiment?
number
entities?
string[]
scope?
scopeId?
string
sourceType?
tags?
string[]
type?
Returns
Promise<MemoryTrace>
Implementation of
ICognitiveMemoryManager.encode
exportToString()
exportToString(
options?):Promise<string>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1415
Export the full brain state as a JSON string. Delegates to JsonExporter through the MemoryStore's brain. Throws if no brain is attached.
Parameters
options?
Returns
Promise<string>
flushReflection()
flushReflection(
mood?,scopeOverride?):Promise<FlushReflectionResult>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1363
Step-8: Force the reflector to run over pending notes regardless of threshold. Encodes reflection traces, soft-deletes superseded IDs. Safe to call when no reflector or no pending notes exist (returns an empty result). Errors do not propagate — reflection is non-critical.
scopeOverride forces every encoded reflection trace to use the
caller-supplied scope + scopeId, overriding whatever the reflector
LLM invented. Callers that want all reflection traces to land in a
single canonical scope (e.g. bench adapters that retrieve under
user/bench) should pass this override.
Parameters
mood?
scopeOverride?
scope
scopeId
string
Returns
Promise<FlushReflectionResult>
Implementation of
ICognitiveMemoryManager.flushReflection
getCompactionHistory()
getCompactionHistory(): readonly
CompactionEntry[]
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1287
Get compaction history for audit/UI.
Returns
readonly CompactionEntry[]
getConfig()
getConfig():
CognitiveMemoryConfig
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1334
Get the resolved cognitive-memory runtime config.
Returns
Implementation of
ICognitiveMemoryManager.getConfig
getContextTransparencyReport()
getContextTransparencyReport():
string|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1282
Get full transparency report (for agent self-inspection or UI).
Returns
string | null
Implementation of
ICognitiveMemoryManager.getContextTransparencyReport
getContextWindowManager()
getContextWindowManager():
ContextWindowManager|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1297
Get the context window manager (for advanced usage).
Returns
ContextWindowManager | null
getContextWindowStats()
getContextWindowStats():
ContextWindowStats|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1277
Get context window transparency stats.
Returns
ContextWindowStats | null
Implementation of
ICognitiveMemoryManager.getContextWindowStats
getGraph()
getGraph():
IMemoryGraph|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1338
Get graph module when enabled.
Returns
IMemoryGraph | null
Implementation of
ICognitiveMemoryManager.getGraph
getHydeRetriever()
getHydeRetriever():
HydeRetriever|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1466
Get the HyDE retriever if configured, or null.
Returns
HydeRetriever | null
Implementation of
ICognitiveMemoryManager.getHydeRetriever
getMemoryHealth()
getMemoryHealth():
Promise<MemoryHealthReport>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1189
Get memory health diagnostics.
Returns
Promise<MemoryHealthReport>
Implementation of
ICognitiveMemoryManager.getMemoryHealth
getObserver()
getObserver():
MemoryObserver|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1342
Get observer module when enabled.
Returns
MemoryObserver | null
Implementation of
ICognitiveMemoryManager.getObserver
getProspective()
getProspective():
ProspectiveMemoryManager|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1406
Get prospective-memory manager when enabled.
Returns
ProspectiveMemoryManager | null
Implementation of
ICognitiveMemoryManager.getProspective
getReflector()
getReflector():
MemoryReflector|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1347
Step-8: accessor mirror of getObserver, for the reflector.
Returns
MemoryReflector | null
Implementation of
ICognitiveMemoryManager.getReflector
getRerankerService()
getRerankerService():
RerankerService|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1477
Return the attached neural reranker, or null when none is
configured. Public read-only accessor for Step-3 bench wiring:
the bench constructs a per-case HybridRetriever that needs the
same reranker the manager uses, without bracket-accessing the
private field.
Returns
RerankerService | null
Implementation of
ICognitiveMemoryManager.getRerankerService
getStore()
getStore():
MemoryStore
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1315
Access the underlying long-term memory store for diagnostics/devtools.
Returns
Implementation of
ICognitiveMemoryManager.getStore
getSummaryContext()
getSummaryContext():
string
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1272
Get the rolling summary chain text for prompt injection.
Returns
string
getTraceCount()
getTraceCount():
number
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1325
Total number of memory traces currently resident in the manager's
in-memory trace cache. Ergonomic passthrough to
MemoryStore.getTraceCount; used by agentos-bench for
memory-footprint telemetry without reaching into getStore().
Returns
number
Implementation of
ICognitiveMemoryManager.getTraceCount
getTypedNetworkObserver()
getTypedNetworkObserver():
TypedNetworkObserver|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:526
Stage E: typed-network observer (LLM extractor), or null.
Returns
TypedNetworkObserver | null
getTypedNetworkStore()
getTypedNetworkStore():
TypedNetworkStore|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:521
Stage E: typed-network store, or null when typed-network not configured.
Returns
TypedNetworkStore | null
getTypedSpreadingActivation()
getTypedSpreadingActivation():
TypedSpreadingActivation|null
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:531
Stage E: typed spreading activation, or null (only set for 'full' variant).
Returns
TypedSpreadingActivation | null
getWorkingMemory()
getWorkingMemory():
CognitiveWorkingMemory
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1330
Access the working-memory model for diagnostics/devtools.
Returns
Implementation of
ICognitiveMemoryManager.getWorkingMemory
importFromString()
importFromString(
json,options?):Promise<ImportResult>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1429
Import a JSON brain payload into the attached brain. Delegates to JsonImporter through the MemoryStore's brain. Throws if no brain is attached.
Parameters
json
string
options?
Pick<ImportOptions, "dedup">
Returns
Promise<ImportResult>
initialize()
initialize(
config):Promise<void>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:307
Parameters
config
Returns
Promise<void>
Implementation of
ICognitiveMemoryManager.initialize
listProspective()
listProspective():
Promise<ProspectiveMemoryItem[]>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1137
List active prospective reminders.
Returns
Promise<ProspectiveMemoryItem[]>
Implementation of
ICognitiveMemoryManager.listProspective
observe()
observe(
role,content,mood?):Promise<ObservationNote[] |null>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1041
Feed a conversation message to the observation pipeline.
Pipeline flow:
- Observer extracts typed observation notes from buffered messages
- Notes are fed to the Reflector for consolidation into long-term traces
- Reflected traces are encoded via
encode()(typed as semantic/episodic/etc.) - Superseded traces are soft-deleted
- Commitment and intention notes are auto-registered with ProspectiveMemoryManager
Parameters
role
Message role (user, assistant, system, tool)
"user" | "tool" | "system" | "assistant"
content
string
Message text content
mood?
Optional PAD emotional state at observation time
Returns
Promise<ObservationNote[] | null>
Observation notes if threshold was reached, null otherwise
Implementation of
ICognitiveMemoryManager.observe
registerProspective()
registerProspective(
input):Promise<ProspectiveMemoryItem>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1126
Register a new prospective reminder/intention.
Parameters
input
Omit<ProspectiveMemoryItem, "id" | "createdAt" | "triggered" | "cueEmbedding"> & object
Returns
Promise<ProspectiveMemoryItem>
Implementation of
ICognitiveMemoryManager.registerProspective
rehydrate()
rehydrate(
traceId,requestContext?):Promise<string|null>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1159
Rehydrate a gisted/archived trace to its original verbatim content.
Delegates to the configured IMemoryArchive. Returns null when no
archive is configured or when the trace is not found/integrity fails.
Parameters
traceId
string
The trace id to rehydrate.
requestContext?
string
Optional caller hint for audit.
Returns
Promise<string | null>
The original verbatim content, or null.
Implementation of
ICognitiveMemoryManager.rehydrate
removeProspective()
removeProspective(
id):Promise<boolean>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1141
Remove a prospective reminder.
Parameters
id
string
Returns
Promise<boolean>
Implementation of
ICognitiveMemoryManager.removeProspective
retrieve()
retrieve(
query,mood,options?):Promise<CognitiveRetrievalResult>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:663
Retrieve relevant memories for a query. Called before prompt construction.
Parameters
query
string
mood
options?
CognitiveRetrievalOptions = {}
Returns
Promise<CognitiveRetrievalResult>
Implementation of
ICognitiveMemoryManager.retrieve
runConsolidation()
runConsolidation():
Promise<ConsolidationResult>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1169
Run consolidation cycle (Batch 2).
Returns
Promise<ConsolidationResult>
Implementation of
ICognitiveMemoryManager.runConsolidation
searchCompactionHistory()
searchCompactionHistory(
keyword):CompactionEntry[]
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1292
Search compaction history for a keyword.
Parameters
keyword
string
Returns
setHydeRetriever()
setHydeRetriever(
retriever):void
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1461
Attach a HyDE retriever to enable hypothesis-driven memory recall.
When set, the retrieve() and assembleForPrompt() methods can accept
options.hyde = true to generate a hypothetical memory trace before
searching. This improves recall for vague or abstract queries by
producing embeddings that are semantically closer to stored traces.
Parameters
retriever
A pre-configured HydeRetriever instance, or null
to disable HyDE.
HydeRetriever | null
Returns
void
Example
memoryManager.setHydeRetriever(new HydeRetriever({
llmCaller: myLlmCaller,
embeddingManager: myEmbeddingManager,
config: { enabled: true },
}));
Implementation of
ICognitiveMemoryManager.setHydeRetriever
shutdown()
shutdown():
Promise<void>
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1305
Shutdown and release resources.
Returns
Promise<void>
Implementation of
ICognitiveMemoryManager.shutdown
trackMessage()
trackMessage(
role,content):void
Defined in: packages/agentos/src/memory/CognitiveMemoryManager.ts:1245
Track a conversation message for context window management. Call for every user/assistant/system/tool message in the conversation.
Parameters
role
"user" | "tool" | "system" | "assistant"
content
string
Returns
void