Graphorin API reference v0.15.1

---

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

Class: TransformersJsReRanker<TRecord>

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

Stable

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

Type Parameters

Type Parameter	Default type
TRecord extends MemoryRecord	MemoryRecord

Implements

• ReRanker

Constructors

Constructor

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

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

Parameters

Parameter	Type
options	CrossEncoderRerankerOptions<TRecord>

Returns

TransformersJsReRanker<TRecord>

Properties

Property	Modifier	Type	Default value	Description	Defined in
batchSize	readonly	number	undefined	-	packages/reranker-transformersjs/src/reranker.ts:110
dtype	readonly	RerankerDtype	undefined	-	packages/reranker-transformersjs/src/reranker.ts:109
id	readonly	"transformersjs-cross-encoder"	RERANKER_ID	Stable lowercase identifier surfaced on every span.	packages/reranker-transformersjs/src/reranker.ts:106
idleEvictionMs	readonly	number | undefined	undefined	-	packages/reranker-transformersjs/src/reranker.ts:111
locale	readonly	string	undefined	-	packages/reranker-transformersjs/src/reranker.ts:108
model	readonly	string	undefined	-	packages/reranker-transformersjs/src/reranker.ts:107

Accessors

invocationCount

Get Signature

get invocationCount(): number;

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

Stable

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

Returns

number

---

pipelineLoaded

Get Signature

get pipelineLoaded(): boolean;

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

Stable

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

Returns

boolean

Methods

rerank()

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

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

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

Parameter	Type
query	string
lists	readonly readonly MemoryHit<TInputRecord>[][]
options	ReRankOptions

Returns

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

Implementation of

ReRanker.rerank

---

unload()

unload(): void;

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

Stable

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

Returns

void