Member Junction
    Preparing search index...

    Class CohereReranker

    Cohere implementation of the BaseReranker class. Uses Cohere's Rerank API for semantic document reranking. A request's CancellationToken is handed to the SDK as its abortSignal, so cancelling it tears the HTTP request down.

    Supported models:

    • rerank-v3.5: Latest English reranker with best accuracy
    • rerank-multilingual-v3.0: Supports 100+ languages

    Driver class: Registered as both CohereReranker (the name the Cohere reranker models' model-vendor rows carry, and so the one AIRerankerRunner and RerankerService resolve) and CohereLLM.

    API Key: The legacy environment-variable fallback is named after the model-vendor row's driver class: AI_VENDOR_API_KEY__COHERERERANKER for the shipped Cohere reranker models. A Cohere credential binding takes precedence over it.

    Usage:

    const reranker = ClassFactory.CreateInstance<BaseReranker>(
        BaseReranker,
        'CohereReranker',
        apiKey,
        'rerank-v3.5'
    );

    const response = await reranker.Rerank({
        query: 'What is the capital of France?',
        documents: [
            { id: '1', text: 'Paris is the capital of France.' },
            { id: '2', text: 'London is in England.' }
        ],
        topK: 5
    });

    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

    • get apiKey(): string

      Only sub-classes can access the API key

      Returns string

    • get ModelName(): string

      Get the model name used for this reranker

      Returns string

    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

    • Create a standardized error response. Used internally when validation fails or an exception occurs.

      Parameters

      • message: string
      • startTime: number

      Returns RerankResponse

    • 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