Interface: MemoryRecallCapture
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:105
The record of one memory assembly. No memory text and no query text.
Properties
allocation
allocation:
MemoryBudgetAllocation
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:131
The section shares the block was assembled with.
budget
budget:
object
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:110
The budget the block was assembled in: the one asked for, and the one used.
clampReason?
optionalclampReason:"prompt_share"|"zero_remaining"
Set when a model's share of the prompt held less than requested: zero_remaining when nothing was left.
effective
effective:
number
The budget the block was rendered in.
hop?
optionalhop:number
The model hop the record is for, 0 for the route's primary (a GMI turn's record).
otherContextTokens?
optionalotherContextTokens:number
The turn's RAG and long-term-memory text, in tokens, which the share holds first (a GMI turn's record).
promptShareTokens?
optionalpromptShareTokens:number
The serving model's retrieved-context share, in tokens (a GMI turn's record).
reassembled?
optionalreassembled:boolean
True when the block was rendered again at effective from the turn's recall, with no second retrieval.
renderFailed?
optionalrenderFailed:boolean
True when rendering the block again for the hop failed, so the hop was sent no block (a GMI turn's record).
requested
requested:
number
The configured budget of the block (recall.budget.totalTokens, or the caller's).
candidates
candidates:
MemoryRecallCandidate[]
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:151
Every candidate, in the order recall ranked them (under hybrid the pool in fused order, a reranked cut in the
order the rerank gave it), then any memory the block shows that no leg returned.
delivery?
optionaldelivery:object
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:163
What reached the model, once the prompt was built (a GMI turn's record): PromptEngine's count of the memory block,
which it never reduces; the other retrieved context the turn had (ragTokens, longTermMemoryTokens, by the
assembler's estimate) and what of it was sent (deliveredTokens, by PromptEngine's), with cutBy when PromptEngine
reduced it; and the codes of PromptEngine's issues about the context (RAG_SUMMARIZATION_FAILED,
TOKEN_BUDGET_EXCEEDED_POST_OPT). promptReplacedByHook is true when the host's beforeModelCall replaced the
prompt for the hop: the counts are then of the prompt PromptEngine built, and what the model received is the
hook's.
issueCodes?
optionalissueCodes:string[]
memoryBlockTokens
memoryBlockTokens:
number
otherContext?
optionalotherContext:object
otherContext.cutBy?
optionalcutBy:"prompt_engine_truncate"|"prompt_engine_summarize"
otherContext.deliveredTokens
deliveredTokens:
number
otherContext.longTermMemoryTokens
longTermMemoryTokens:
number
otherContext.ragTokens
ragTokens:
number
promptReplacedByHook?
optionalpromptReplacedByHook:boolean
embedder?
optionalembedder:object
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:139
The embedder of the dense leg, when known.
model
model:
string
provider
provider:
string
legs
legs:
object[]
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:133
Each leg of the recall: whether it ran, why not, how many candidates it returned, how long it took.
candidates
candidates:
number
ineligible
ineligible:
number
leg
leg:
RecallLeg
ms
ms:
number
ran
ran:
boolean
reason?
optionalreason:LegAbsentReason
lexicalBackend
lexicalBackend:
"none"|"fts5"|"fts4"|"postgres_tsvector"|"in_process"
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:137
The full-text backend the exact-words leg read, or none when that leg did not run.
memoryQuestionReserve
memoryQuestionReserve:
object
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:146
Whether the turn was a memory question (fired: the rule, or the manager's recall.memoryQuestion, said yes,
whatever it found to reserve), and how many reserved candidates the block shows (added). Under dense it never
fires.
added
added:
number
fired
fired:
boolean
reranker
reranker:
MemoryRecallReranker
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:140
retrieval
retrieval:
"hybrid"|"dense"
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:108
dense for the vector recall; hybrid when the recall joins several legs.
suppliedRejected?
optionalsuppliedRejected:object
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:135
Counts of supplied candidates that were refused; never their ids.
ineligible
ineligible:
number
outOfScope
outOfScope:
number
timings
timings:
object
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:153
Milliseconds of each stage, rounded.
assembleMs
assembleMs:
number
dedupeMs
dedupeMs:
number
fuseMs
fuseMs:
number
legsMs
legsMs:
number
rerankMs
rerankMs:
number
totalMs
totalMs:
number
tokensUsed
tokensUsed:
number
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:129
Estimated tokens of the block, headers included.
version
version:
"memory-recall-capture/1"
Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:106