@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
46 lines (45 loc) • 1.51 kB
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.
*/
/**
* A ranked document with a relevance score and an index position.
* @export
* @interface RankedDocument
*/
export interface RankedDocument {
/**
* The index position of the document from the original request.
* @type {number}
* @memberof RankedDocument
*/
index: number;
/**
* The relevance of the document to the query, normalized between 0 and 1, with scores closer to 1 indicating higher relevance.
* @type {number}
* @memberof RankedDocument
*/
score: number;
/**
* Document for reranking
* @type {{ [key: string]: any; }}
* @memberof RankedDocument
*/
document?: {
[key: string]: any;
};
}
/**
* Check if a given object implements the RankedDocument interface.
*/
export declare function instanceOfRankedDocument(value: object): boolean;
export declare function RankedDocumentFromJSON(json: any): RankedDocument;
export declare function RankedDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): RankedDocument;
export declare function RankedDocumentToJSON(value?: RankedDocument | null): any;