Interface RerankOptions

Options one can send with a request to rerank *

Param

The number of documents to return in the response. Default is the number of documents passed in the request.

Param

Whether to return the documents in the response. Default is true.

Param

The fields by which to rank the documents. If no field is passed, default is ['text']. Note: some models only support 1 reranking field. See the model documentation for more information.

Param

Additional model-specific parameters to send with the request, e.g. {truncate: "END"}.

Hierarchy

  • RerankOptions

Properties

parameters?: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string
rankFields?: string[]
returnDocuments?: boolean
topN?: number