Skip to content

Graphorin API reference v0.4.0


Graphorin API reference / @graphorin/memory / / IterativeRetrievalDeps

Interface: IterativeRetrievalDeps<H>

Defined in: packages/memory/src/search/iterative.ts:349

Dependencies injected into runIterativeRetrieval. The loop does no I/O of its own — retrieve and grader own all side effects.

Stable

Type Parameters

Type Parameter
H

Properties

PropertyTypeDescriptionDefined in
grader| RetrievalGrader | nullGrader; null ⇒ single-shot (no grading, no provider call).packages/memory/src/search/iterative.ts:361

Methods

idOf()

ts
idOf(hit): string;

Defined in: packages/memory/src/search/iterative.ts:359

Stable id used to dedup hits across passes.

Parameters

ParameterType
hitH

Returns

string


retrieve()

ts
retrieve(
   query, 
   widen, 
signal?): Promise<readonly H[]>;

Defined in: packages/memory/src/search/iterative.ts:355

Run one retrieval pass for query. widen is true on reformulation passes so the caller can broaden recall (e.g. enable P2-1 one-hop graph expansion).

Parameters

ParameterType
querystring
widenboolean
signal?AbortSignal

Returns

Promise&lt;readonly H[]&gt;


snippetOf()

ts
snippetOf(hit): string;

Defined in: packages/memory/src/search/iterative.ts:357

Snippet shown to the grader for a hit.

Parameters

ParameterType
hitH

Returns

string