@pinecone-database/pinecone/dist/pinecone-generated-ts-fetch/inference/models/RerankRequest.d.ts

This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.

/**
 * Pinecone Inference API
 * Pinecone is a vector database that makes it easy to search and retrieve billions of high-dimensional vectors.
 *
 * The version of the OpenAPI document: 2025-04
 * Contact: support@pinecone.io
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 *
 * @export
 * @interface RerankRequest
 */
export interface RerankRequest {
    /**
     * The [model](https://docs.pinecone.io/guides/search/rerank-results#reranking-models) to use for reranking.
     * @type {string}
     * @memberof RerankRequest
     */
    model: string;
    /**
     * The query to rerank documents against.
     * @type {string}
     * @memberof RerankRequest
     */
    query: string;
    /**
     * The number of results to return sorted by relevance. Defaults to the number of inputs.
     * @type {number}
     * @memberof RerankRequest
     */
    topN?: number;
    /**
     * Whether to return the documents in the response.
     * @type {boolean}
     * @memberof RerankRequest
     */
    returnDocuments?: boolean;
    /**
     * The field(s) to consider for reranking. If not provided, the default is `["text"]`.
     *
     * The number of fields supported is [model-specific](https://docs.pinecone.io/guides/search/rerank-results#reranking-models).
     * @type {Array<string>}
     * @memberof RerankRequest
     */
    rankFields?: Array<string>;
    /**
     * The documents to rerank.
     * @type {Array<{ [key: string]: any; }>}
     * @memberof RerankRequest
     */
    documents: Array<{
        [key: string]: any;
    }>;
    /**
     * Additional model-specific parameters. Refer to the [model guide](https://docs.pinecone.io/guides/search/rerank-results#reranking-models) for available model parameters.
     * @type {{ [key: string]: any; }}
     * @memberof RerankRequest
     */
    parameters?: {
        [key: string]: any;
    };
}
/**
 * Check if a given object implements the RerankRequest interface.
 */
export declare function instanceOfRerankRequest(value: object): boolean;
export declare function RerankRequestFromJSON(json: any): RerankRequest;
export declare function RerankRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RerankRequest;
export declare function RerankRequestToJSON(value?: RerankRequest | null): any;