Interface: ICognitiveMemoryManager
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:98
Methods
assembleForPrompt()
assembleForPrompt(
query,tokenBudget,mood,options?):Promise<AssembledMemoryContext>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:132
Assemble memory context for prompt injection within a token budget.
Parameters
query
string
tokenBudget
number
mood
options?
Returns
Promise<AssembledMemoryContext>
checkProspective()?
optionalcheckProspective(context):Promise<ProspectiveMemoryItem[]>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:148
Check prospective memory triggers (Batch 2).
Parameters
context
events?
string[]
maxTierRank?
number
Policy-tier ceiling: drop prospective items whose tierRank exceeds it,
matching the assembly path. Forwarded to prospective.check.
now?
number
queryEmbedding?
number[]
queryText?
string
Returns
Promise<ProspectiveMemoryItem[]>
encode()
encode(
input,mood,gmiMood,options?):Promise<MemoryTrace>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:102
Encode a new input into a memory trace. Called after each user message.
Parameters
input
string
mood
gmiMood
string
options?
contentSentiment?
number
entities?
string[]
perspectiveSource?
{ eventHash: string; eventId: string; }
When encoding a subjective trace from PerspectiveObserver,
thread the source-event identifiers through so the resulting
MemoryTrace carries the MechanismMetadata fields that
applyReconsolidation reads at retrieval time.
perspectiveSource.eventHash
string
perspectiveSource.eventId
string
scope?
scopeId?
string
sourceType?
tags?
string[]
type?
Returns
Promise<MemoryTrace>
flushReflection()
flushReflection(
mood?,scopeOverride?):Promise<FlushReflectionResult>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:218
Step-8: Force the memory reflector to run over any pending observation notes regardless of accumulated-token threshold. Encoded reflection traces land in the memory store; superseded trace IDs are soft-deleted. Returns the IDs so callers can apply side effects (e.g. BM25 indexing).
Parameters
mood?
Optional mood override passed to each encoded trace.
scopeOverride?
When set, overrides the scope + scopeId on
every reflection-derived trace before encoding. Needed when the
caller (e.g. bench adapter) needs all reflection traces to land in
the same scope the retrieval path queries, regardless of what the
reflector LLM invented.
scope
scopeId
string
Returns
Promise<FlushReflectionResult>
getConfig()
getConfig():
CognitiveMemoryConfig
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:194
Get the resolved cognitive-memory runtime config.
Returns
getContextTransparencyReport()
getContextTransparencyReport():
string|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:247
Get a human-readable compaction/transparency report when enabled.
Returns
string | null
getContextWindowStats()
getContextWindowStats():
ContextWindowStats|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:244
Get infinite-context runtime stats when enabled.
Returns
ContextWindowStats | null
getGraph()
getGraph():
IMemoryGraph|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:197
Get graph module when enabled.
Returns
IMemoryGraph | null
getHydeRetriever()?
optionalgetHydeRetriever():HydeRetriever|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:233
Get the HyDE retriever if configured, or null.
Returns
HydeRetriever | null
getMemoryHealth()
getMemoryHealth():
Promise<MemoryHealthReport>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:177
Get memory health diagnostics.
Returns
Promise<MemoryHealthReport>
getObserver()
getObserver():
MemoryObserver|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:200
Get observer module when enabled.
Returns
MemoryObserver | null
getProspective()
getProspective():
ProspectiveMemoryManager|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:224
Get prospective-memory manager when enabled.
Returns
ProspectiveMemoryManager | null
getReflector()
getReflector():
MemoryReflector|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:203
Get the memory reflector if configured, or null.
Returns
MemoryReflector | null
getRerankerService()?
optionalgetRerankerService():RerankerService|null
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:241
Get the attached neural reranker, or null when none is
configured. Step 3 uses this so the bench-side HybridRetriever
can plumb the manager's reranker into the per-case retriever
without bracket-accessing a private field.
Returns
RerankerService | null
getStore()
getStore():
MemoryStore
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:180
Access the underlying long-term memory store for diagnostics/devtools.
Returns
getTraceCount()
getTraceCount():
number
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:188
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.
Returns
number
getWorkingMemory()
getWorkingMemory():
CognitiveWorkingMemory
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:191
Access the working-memory model for diagnostics/devtools.
Returns
initialize()
initialize(
config):Promise<void>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:99
Parameters
config
Returns
Promise<void>
listProspective()?
optionallistProspective():Promise<ProspectiveMemoryItem[]>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:168
List active prospective reminders.
Returns
Promise<ProspectiveMemoryItem[]>
observe()?
optionalobserve(role,content,mood?,options?):Promise<ObservationNote[] |null>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:140
Feed a message to the observer (Batch 2). Returns notes if threshold reached.
Parameters
role
"user" | "tool" | "system" | "assistant"
content
string
mood?
options?
contentSentiment?
number
Returns
Promise<ObservationNote[] | null>
registerProspective()?
optionalregisterProspective(input):Promise<ProspectiveMemoryItem>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:161
Register a new prospective reminder/intention.
Parameters
input
Omit<ProspectiveMemoryItem, "id" | "createdAt" | "triggered" | "cueEmbedding"> & object
Returns
Promise<ProspectiveMemoryItem>
rehydrate()?
optionalrehydrate(traceId,requestContext?):Promise<string|null>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:258
Return the verbatim content that was archived when this trace was
consolidated, or null if the trace is not gisted/archived or the
archive is unreachable.
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.
removeProspective()?
optionalremoveProspective(id):Promise<boolean>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:171
Remove a prospective reminder.
Parameters
id
string
Returns
Promise<boolean>
retrieve()
retrieve(
query,mood,options?):Promise<CognitiveRetrievalResult>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:125
Retrieve relevant memories for a query. Called before prompt construction.
Parameters
query
string
mood
options?
Returns
Promise<CognitiveRetrievalResult>
runConsolidation()?
optionalrunConsolidation():Promise<ConsolidationResult>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:174
Run consolidation cycle (Batch 2).
Returns
Promise<ConsolidationResult>
setHydeRetriever()?
optionalsetHydeRetriever(retriever):void
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:230
Attach a HyDE retriever for hypothesis-driven memory recall.
Pass null to disable.
Parameters
retriever
HydeRetriever | null
Returns
void
shutdown()
shutdown():
Promise<void>
Defined in: packages/agentos/src/cognition/memory/CognitiveMemoryManager.ts:261
Shutdown and release resources.
Returns
Promise<void>