Class CohereRerank

constructor

• new CohereRerank(fields?): CohereRerank

• Parameters

  • Optionalfields: CohereRerankArgs

  Returns CohereRerank

client

maxChunksPerDoc

model

topN

compressDocuments

• compressDocuments(documents, query): Promise<DocumentInterface<Record<string, any>>[]>

• Compress documents using Cohere's rerank API.

  Parameters

  • documents: DocumentInterface<Record<string, any>>[]

    A sequence of documents to compress.
  • query: string

    The query to use for compressing the documents.

  Returns Promise<DocumentInterface<Record<string, any>>[]>

  A sequence of compressed documents.

rerank

• rerank(documents, query, options?): Promise<{
      index: number;
      relevanceScore: number;
  }[]>

• Returns an ordered list of documents ordered by their relevance to the provided query.

  Parameters

  • documents: (string | Record<string, string> | DocumentInterface<Record<string, any>>)[]

    A list of documents as strings, DocumentInterfaces or objects with a pageContent key.
  • query: string

    The query to use for reranking the documents.
  • Optionaloptions: {
        maxChunksPerDoc?: number;
        model?: string;
        topN?: number;
    }

    • OptionalmaxChunksPerDoc?: number

      The maximum number of chunks per document.

    • Optionalmodel?: string

      The name of the model to use.

    • OptionaltopN?: number

      How many documents to return.

  Returns Promise<{
      index: number;
      relevanceScore: number;
  }[]>

  An ordered list of documents with relevance scores.