Skip to main content

graniteReranker

Workspace API

Workspace API / services/granite/graniteReranker

services/granite/graniteReranker

Classes​

GraniteReranker​

Defined in: services/granite/graniteReranker.ts:92

Client for vLLM's built-in reranking endpoint

Constructors​

Constructor​

new GraniteReranker(): GraniteReranker

Defined in: services/granite/graniteReranker.ts:100

Returns​

GraniteReranker

Accessors​

maxK​
Get Signature​

get maxK(): number

Defined in: services/granite/graniteReranker.ts:132

Get the maximum K value for reranking Exposed for external capping logic in ragService

Returns​

number

Methods​

isEnabled()​

isEnabled(): boolean

Defined in: services/granite/graniteReranker.ts:124

Check if reranker is enabled

Returns​

boolean

rerank()​

rerank(query, documents, topN?): Promise<RerankerResult[]>

Defined in: services/granite/graniteReranker.ts:158

Rerank documents based on query relevance

Parameters​
query​

string

Query to rank against

documents​

string[]

Array of document texts to rerank

topN?​

number

Number of top results to return (capped at maxK)

Returns​

Promise<RerankerResult[]>

Reranked results with indices and scores

rerankDocuments()​

rerankDocuments<T>(query, documents, getTextFn, topN?): Promise<T[]>

Defined in: services/granite/graniteReranker.ts:315

Rerank and return reordered documents (convenience method)

Type Parameters​
T​

T

Parameters​
query​

string

Query to rank against

documents​

T[]

Array of document texts to rerank

getTextFn​

(doc) => string

topN?​

number

Number of top results to return

Returns​

Promise<T[]>

Reordered documents (highest relevance first)

Interfaces​

RerankerRequest​

Defined in: services/granite/graniteReranker.ts:64

Properties​

model​

model: string

Defined in: services/granite/graniteReranker.ts:65

query​

query: string

Defined in: services/granite/graniteReranker.ts:66

documents​

documents: string[]

Defined in: services/granite/graniteReranker.ts:67

top_n?​

optional top_n: number

Defined in: services/granite/graniteReranker.ts:68

RerankerResult​

Defined in: services/granite/graniteReranker.ts:71

Properties​

index​

index: number

Defined in: services/granite/graniteReranker.ts:72

relevance_score​

relevance_score: number

Defined in: services/granite/graniteReranker.ts:73

Functions​

getGraniteReranker()​

getGraniteReranker(): GraniteReranker

Defined in: services/granite/graniteReranker.ts:337

Returns​

GraniteReranker