@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.13 kB
TypeScript
/**
* Index names are strings composed of:
* - alphanumeric characters
* - hyphens
*
* Index names must be unique within a project and may not start or end with a hyphen.
*
* @see [Understanding indexes](https://docs.pinecone.io/docs/indexes)
*/
export type IndexName = string;
/**
* Collection names are strings composed of:
* - alphanumeric characters
* - hyphens
*
* Collection names must be unique within a project and may not start or end with a hyphen.
*
* @see [Understanding collections](https://docs.pinecone.io/docs/collections)
*/
export type CollectionName = string;
/**
* The unique identifier representing a backup.
*
* @see [Backups overview](https://docs.pinecone.io/guides/manage-data/backups-overview)
*/
export type BackupId = string;
/** The unique identifier representing a restore job. */
export type RestoreJobId = string;
/**
* @see [Understanding indexes](https://docs.pinecone.io/docs/indexes)
*/
export type PodType = 's1.x1' | 's1.x2' | 's1.x4' | 's1.x8' | 'p1.x1' | 'p1.x2' | 'p1.x4' | 'p1.x8' | 'p2.x1' | 'p2.x2' | 'p2.x4' | 'p2.x8';
export declare const ValidPodTypes: PodType[];