@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
34 lines (33 loc) • 1.47 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.
*/
/**
* The request for the `describe_index_stats` operation.
* @export
* @interface DescribeIndexStatsRequest
*/
export interface DescribeIndexStatsRequest {
/**
* If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See [Understanding metadata](https://docs.pinecone.io/guides/index-data/indexing-overview#metadata).
*
* Serverless indexes do not support filtering `describe_index_stats` by metadata.
* @type {object}
* @memberof DescribeIndexStatsRequest
*/
filter?: object;
}
/**
* Check if a given object implements the DescribeIndexStatsRequest interface.
*/
export declare function instanceOfDescribeIndexStatsRequest(value: object): boolean;
export declare function DescribeIndexStatsRequestFromJSON(json: any): DescribeIndexStatsRequest;
export declare function DescribeIndexStatsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DescribeIndexStatsRequest;
export declare function DescribeIndexStatsRequestToJSON(value?: DescribeIndexStatsRequest | null): any;