Skip to content

Graphorin API reference v0.4.0


Graphorin API reference / @graphorin/memory / / explainRecall

Function: explainRecall()

ts
function explainRecall<TRecord>(hits, opts): RecallExplanation;

Defined in: packages/memory/src/search/explain.ts:75

Build a RecallExplanation from a ranked hit list. Pure and deterministic: it surfaces whatever per-signal scores the hybrid pipeline left on each MemoryHit.signals (FTS, vector, RRF, decay, future graph-hop terms) without re-deriving them, so the explanation always matches what actually drove the ranking. Hits are assumed to be in final-rank order (as returned by search).

Type Parameters

Type Parameter
TRecord extends MemoryRecord

Parameters

ParameterType
hitsreadonly MemoryHit&lt;TRecord&gt;[]
opts{ query: string; rerankerId: string; }
opts.querystring
opts.rerankerIdstring

Returns

RecallExplanation

Stable