Member Junction
    Preparing search index...

    Class BaseRerankerAbstract

    Abstract base class for all reranker implementations. Extends BaseModel to follow MJ conventions for AI model classes.

    Provides common functionality including:

    • Input validation
    • Response standardization
    • Utility methods for sorting and filtering results

    Example usage:

    @RegisterClass(BaseReranker, 'CohereReranker')
    export class CohereReranker extends BaseReranker {
        protected async doRerank(params: RerankParams): Promise<RerankResult[]> {
            // Call Cohere API and return results
        }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _modelName

    Accessors

    apiKey ModelName

    Methods

    createCancelledResponse createErrorResponse doRerank filterByThreshold Rerank sortByRelevance

    Constructors

    Properties

    Protected_modelName

    _modelName: string

    Accessors

    Methods

    • The response for a call its signal ended, before or during the driver's work. A caller cancellation is classified Cancelled, so it is never failed over; an abort caused by a timeout reads as a retriable network error.

      Parameters

      • signal: AbortSignal
      • error: unknown
      • startTime: number

      Returns RerankResponse

    • Provider-specific reranking implementation. Subclasses must implement this method to perform the actual reranking.

      Implementation requirements:

      • Call the provider's reranking API, handing it params.CancellationToken when one is set
      • Map results to RerankResult format
      • Sort results by relevance score (highest first)
      • Preserve document metadata for zero-copy retrieval

      Parameters

      Returns Promise<RerankResult[]>

      Promise resolving to array of RerankResult sorted by relevance

    • Rerank documents based on their relevance to a query. This is the main entry point for reranking operations.

      The method:

      1. Validates input parameters, and refuses a call whose CancellationToken is already aborted
      2. Calls the provider-specific doRerank() implementation
      3. Applies topK limit if specified
      4. Returns standardized RerankResponse

      Parameters

      • params: RerankParams

        Reranking parameters including query and documents

      Returns Promise<RerankResponse>

      Promise resolving to RerankResponse with reranked results

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods