@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
60 lines (59 loc) • 2.41 kB
TypeScript
/**
* Pinecone Data Plane 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.
*/
/**
* Parameters for reranking the initial search results.
* @export
* @interface SearchRecordsRequestRerank
*/
export interface SearchRecordsRequestRerank {
/**
* The name of the [reranking model](https://docs.pinecone.io/guides/search/rerank-results#reranking-models) to use.
* @type {string}
* @memberof SearchRecordsRequestRerank
*/
model: string;
/**
* 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 SearchRecordsRequestRerank
*/
rankFields: Array<string>;
/**
* The number of top results to return after reranking. Defaults to top_k.
* @type {number}
* @memberof SearchRecordsRequestRerank
*/
topN?: number;
/**
* 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 SearchRecordsRequestRerank
*/
parameters?: {
[key: string]: any;
};
/**
* 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.
* @type {string}
* @memberof SearchRecordsRequestRerank
*/
query?: string;
}
/**
* Check if a given object implements the SearchRecordsRequestRerank interface.
*/
export declare function instanceOfSearchRecordsRequestRerank(value: object): boolean;
export declare function SearchRecordsRequestRerankFromJSON(json: any): SearchRecordsRequestRerank;
export declare function SearchRecordsRequestRerankFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchRecordsRequestRerank;
export declare function SearchRecordsRequestRerankToJSON(value?: SearchRecordsRequestRerank | null): any;