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 Parameter | Default type |
|---|---|
TRecord extends MemoryRecord | MemoryRecord |
Implements
Constructors
Constructor
new TransformersJsReRanker<TRecord>(options): TransformersJsReRanker<TRecord>;Defined in: packages/reranker-transformersjs/src/reranker.ts:124
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:109 |
dtype | readonly | RerankerDtype | undefined | - | packages/reranker-transformersjs/src/reranker.ts:108 |
id | readonly | "transformersjs-cross-encoder" | RERANKER_ID | Stable lowercase identifier surfaced on every span. | packages/reranker-transformersjs/src/reranker.ts:105 |
idleEvictionMs | readonly | number | undefined | undefined | - | packages/reranker-transformersjs/src/reranker.ts:110 |
locale | readonly | string | undefined | - | packages/reranker-transformersjs/src/reranker.ts:107 |
model | readonly | string | undefined | - | packages/reranker-transformersjs/src/reranker.ts:106 |
Accessors
invocationCount
Get Signature
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
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()
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
| Parameter | Type |
|---|---|
query | string |
lists | readonly readonly MemoryHit<TInputRecord>[][] |
options | ReRankOptions |
Returns
Promise<readonly MemoryHit<TInputRecord>[]>
Implementation of
unload()
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