Type Alias SearchRecordsRerank

SearchRecordsRerank: {
    model: string;
    parameters?: { [key: string]: any };
    query?: string;
    rankFields: string[];
    topN?: number;
}

Parameters used for reranking the initial search results.

Type declaration

  • model: string

    The name of the reranking model to use.

  • Optionalparameters?: { [key: string]: any }

    Additional model-specific parameters. Refer to the model guide for available model parameters.

  • Optionalquery?: string

    The query to rerank documents against. If a specific rerank query is specified, it overwrites the query input that was provided at the top level.

  • rankFields: string[]

    The field(s) to consider for reranking. If not provided, the default is ["text"]. The number of fields supported is model-specific

  • OptionaltopN?: number

    The number of top results to return after reranking. Defaults to the topK in SearchRecordsQuery.