@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
57 lines (56 loc) • 1.91 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.
*/
import type { SearchRecordsVector } from './SearchRecordsVector';
/**
* .
* @export
* @interface SearchRecordsRequestQuery
*/
export interface SearchRecordsRequestQuery {
/**
* The number of similar records to return.
* @type {number}
* @memberof SearchRecordsRequestQuery
*/
topK: number;
/**
* The filter to apply. You can use vector metadata to limit your search. See [Understanding metadata](https://docs.pinecone.io/guides/index-data/indexing-overview#metadata).
* @type {object}
* @memberof SearchRecordsRequestQuery
*/
filter?: object;
/**
*
* @type {object}
* @memberof SearchRecordsRequestQuery
*/
inputs?: object;
/**
*
* @type {SearchRecordsVector}
* @memberof SearchRecordsRequestQuery
*/
vector?: SearchRecordsVector;
/**
* The unique ID of the vector to be used as a query vector.
* @type {string}
* @memberof SearchRecordsRequestQuery
*/
id?: string;
}
/**
* Check if a given object implements the SearchRecordsRequestQuery interface.
*/
export declare function instanceOfSearchRecordsRequestQuery(value: object): boolean;
export declare function SearchRecordsRequestQueryFromJSON(json: any): SearchRecordsRequestQuery;
export declare function SearchRecordsRequestQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchRecordsRequestQuery;
export declare function SearchRecordsRequestQueryToJSON(value?: SearchRecordsRequestQuery | null): any;