Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/reranker-transformersjs / TransformersJsReRanker

Class: TransformersJsReRanker<TRecord>

Defined in: packages/reranker-transformersjs/src/reranker.ts:102

ReRanker implementation. Matches the contract from @graphorin/memory/search.

Stable

Type Parameters

Type ParameterDefault type
TRecord extends MemoryRecordMemoryRecord

Implements

Constructors

Constructor

ts
new TransformersJsReRanker<TRecord>(options): TransformersJsReRanker<TRecord>;

Defined in: packages/reranker-transformersjs/src/reranker.ts:124

Parameters

ParameterType
optionsCrossEncoderRerankerOptions&lt;TRecord&gt;

Returns

TransformersJsReRanker&lt;TRecord&gt;

Properties

PropertyModifierTypeDefault valueDescriptionDefined in
batchSizereadonlynumberundefined-packages/reranker-transformersjs/src/reranker.ts:109
dtypereadonlyRerankerDtypeundefined-packages/reranker-transformersjs/src/reranker.ts:108
idreadonly"transformersjs-cross-encoder"RERANKER_IDStable lowercase identifier surfaced on every span.packages/reranker-transformersjs/src/reranker.ts:105
idleEvictionMsreadonlynumber | undefinedundefined-packages/reranker-transformersjs/src/reranker.ts:110
localereadonlystringundefined-packages/reranker-transformersjs/src/reranker.ts:107
modelreadonlystringundefined-packages/reranker-transformersjs/src/reranker.ts:106

Accessors

invocationCount

Get Signature

ts
get invocationCount(): number;

Defined in: packages/reranker-transformersjs/src/reranker.ts:145

Number of rerank(...) invocations since construction. Surfaced for observability + the test suite.

Stable
Returns

number


pipelineLoaded

Get Signature

ts
get pipelineLoaded(): boolean;

Defined in: packages/reranker-transformersjs/src/reranker.ts:155

Whether the underlying ONNX pipeline is currently loaded in memory. Surfaced for the idle-eviction integration test.

Stable
Returns

boolean

Methods

rerank()

ts
rerank<TInputRecord>(
   query, 
   lists, 
options?): Promise<readonly MemoryHit<TInputRecord>[]>;

Defined in: packages/reranker-transformersjs/src/reranker.ts:174

Rerank one or more parallel ranked lists and return the fused top-K (default topK = 10). Each input list must already be sorted by score descending.

Type Parameters

Type Parameter
TInputRecord extends MemoryRecord

Parameters

ParameterType
querystring
listsreadonly readonly MemoryHit&lt;TInputRecord&gt;[][]
optionsReRankOptions

Returns

Promise<readonly MemoryHit&lt;TInputRecord&gt;[]>

Implementation of

ReRanker.rerank


unload()

ts
unload(): void;

Defined in: packages/reranker-transformersjs/src/reranker.ts:165

Drop the loaded pipeline. Equivalent to letting the idle-eviction timer fire. Idempotent.

Returns

void

Stable