@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
49 lines (48 loc) • 2 kB
TypeScript
/**
* Pinecone Control 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 { ByocSpec } from './ByocSpec';
import type { PodSpec } from './PodSpec';
import type { ServerlessSpec } from './ServerlessSpec';
/**
* The spec object defines how the index should be deployed.
*
* For serverless indexes, you set only the [cloud and region](http://docs.pinecone.io/guides/index-data/create-an-index#cloud-regions) where the index should be hosted. For pod-based indexes, you set the [environment](http://docs.pinecone.io/guides/indexes/pods/understanding-pod-based-indexes#pod-environments) where the index should be hosted, the [pod type and size](http://docs.pinecone.io/guides/indexes/pods/understanding-pod-based-indexes#pod-types) to use, and other index characteristics. For [BYOC indexes](http://docs.pinecone.io/guides/production/bring-your-own-cloud), you set the environment name provided to you during onboarding.
* @export
* @interface IndexSpec
*/
export interface IndexSpec {
/**
*
* @type {ServerlessSpec}
* @memberof IndexSpec
*/
serverless?: ServerlessSpec;
/**
*
* @type {PodSpec}
* @memberof IndexSpec
*/
pod?: PodSpec;
/**
*
* @type {ByocSpec}
* @memberof IndexSpec
*/
byoc?: ByocSpec;
}
/**
* Check if a given object implements the IndexSpec interface.
*/
export declare function instanceOfIndexSpec(value: object): boolean;
export declare function IndexSpecFromJSON(json: any): IndexSpec;
export declare function IndexSpecFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndexSpec;
export declare function IndexSpecToJSON(value?: IndexSpec | null): any;