Skip to main content

Interface: RetrievalRecallReport

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:184

What a CognitiveMemoryManager retrieval reports for the recall capture, on CognitiveRetrievalResult.diagnostics.recall: trace ids, ranks, scores and a time, never a memory's text.

Properties​

denseMs​

denseMs: number

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:196

Milliseconds of the dense leg: the query's embedding (and its HyDE hypothesis, when one is asked for), the vector search, the scoring and the graph's activation, not the co-activation the graph records after.


denseRanks​

denseRanks: Record<string, number>

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:190

Each returned trace's 1-based rank in the dense leg: the order the vector recall's cognitive scores (and the graph's activation) gave the traces, before any rerank.


legs?​

optional legs: object[]

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:202

Each recall leg of the retrieval, as the capture reports it: whether it ran, why not (no_embedder when the embedding manager gave the query no vector), how many candidates it returned, how many the eligibility checks dropped (for the dense leg, the trust-policy filter), and its time. CognitiveMemoryManager always sets it.

candidates​

candidates: number

ineligible​

ineligible: number

leg​

leg: RecallLeg

ms​

ms: number

ran​

ran: boolean

reason?​

optional reason: LegAbsentReason


lexicalBackend?​

optional lexicalBackend: "none" | "fts5" | "fts4" | "postgres_tsvector" | "in_process"

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:216

Under hybrid: the full-text backend the exact-words leg read, or none when that leg did not run.


ranked?​

optional ranked: RankedRecallCandidate[]

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:214

Under hybrid: the whole recall pool in fused order, the candidates the cut at topK left out and the ones the dedupe dropped (duplicateOf) included, each with its ranks and fused score. When a rerank answered, the cut's candidates stand in the order it gave them, in the places the cut holds in that list.


rerankMs?​

optional rerankMs: number

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:206

Milliseconds the rerank took, whether it answered, failed or timed out; 0 or absent with no reranker.


rerankScores?​

optional rerankScores: Record<string, number>

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:204

Each trace the reranker scored, with the score it gave before the blend. Absent when no rerank answered.


reserve?​

optional reserve: object

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:223

Under hybrid: whether the turn was a memory question (fired), and the ids of the exact-words candidates past the cut it reserved room for, in reserve order (they follow the cut in retrieved).

fired​

fired: boolean

ids​

ids: string[]


retrieval?​

optional retrieval: "hybrid" | "dense"

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:208

hybrid when the retrieval fused the dense, exact-words and recency legs; dense (or absent) otherwise.


suppliedRejected?​

optional suppliedRejected: object

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:225

Counts of the call's supplied candidates that were refused, set only when one was; never their ids.

ineligible​

ineligible: number

outOfScope​

outOfScope: number


timings?​

optional timings: object

Defined in: packages/agentos/src/cognition/memory/retrieval/recall/capture.ts:218

Under hybrid: milliseconds of the legs (run together), the fusion and the dedupe.

dedupeMs​

dedupeMs: number

fuseMs​

fuseMs: number

legsMs​

legsMs: number