@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.67 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 { SearchRecordsRequestQuery } from './SearchRecordsRequestQuery';
import type { SearchRecordsRequestRerank } from './SearchRecordsRequestRerank';
/**
* A search request for records in a specific namespace.
* @export
* @interface SearchRecordsRequest
*/
export interface SearchRecordsRequest {
/**
*
* @type {SearchRecordsRequestQuery}
* @memberof SearchRecordsRequest
*/
query: SearchRecordsRequestQuery;
/**
* The fields to return in the search results. If not specified, the response will include all fields.
* @type {Array<string>}
* @memberof SearchRecordsRequest
*/
fields?: Array<string>;
/**
*
* @type {SearchRecordsRequestRerank}
* @memberof SearchRecordsRequest
*/
rerank?: SearchRecordsRequestRerank;
}
/**
* Check if a given object implements the SearchRecordsRequest interface.
*/
export declare function instanceOfSearchRecordsRequest(value: object): boolean;
export declare function SearchRecordsRequestFromJSON(json: any): SearchRecordsRequest;
export declare function SearchRecordsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchRecordsRequest;
export declare function SearchRecordsRequestToJSON(value?: SearchRecordsRequest | null): any;