Skip to main content

Interface: MemoryRecallCandidate

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

One candidate memory of a turn: how it ranked and what became of it.

Properties​

duplicateOf?​

optional duplicateOf: string

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

The candidate it duplicates: with reason: 'dedupe', or, for one the block shows only through its graph association, with outcome: 'included'.


fusedScore​

fusedScore: number

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

The score the candidates were ordered by before assembly (under dense retrieval, the trace's retrieval score).


id​

id: string

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

The memory trace's id.


outcome​

outcome: "included" | "left_out"

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

Whether the memory block shows it.


ranks​

ranks: Partial<Record<RecallLeg, number>>

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

Its 1-based rank in each leg that returned it; empty for a memory the block shows that no leg returned.


reason?​

optional reason: "budget" | "section_full" | "dedupe" | "render_failed"

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

Set for a candidate left out, and only then: budget when its section was offered no room (or the candidate never reached a section), section_full when it did not fit whole in the room its section was offered, dedupe when another candidate holds the same memory (duplicateOf), and render_failed on a GMI hop that was sent no block because rendering it again for the hop failed (budget.renderFailed).


rerankScore?​

optional rerankScore: number

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

The score the reranker gave it, before the blend; absent when no rerank scored it.


reserve?​

optional reserve: boolean

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

Whether a memory-question reserve added it.


section?​

optional section: keyof MemoryBudgetAllocation | "involuntary"

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

The section of the block its line belongs to.


tokens​

tokens: number

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

Tokens of its line, about 4 characters a token: as rendered when included, as it would render whole when left out.