The BackupModel describes the configuration and status of a Pinecone backup.

BackupModel

interface BackupModel {
    backupId: string;
    cloud: string;
    createdAt?: string;
    description?: string;
    dimension?: number;
    metric?: string;
    name?: string;
    namespaceCount?: number;
    recordCount?: number;
    region: string;
    schema?: MetadataSchema;
    sizeBytes?: number;
    sourceIndexId: string;
    sourceIndexName: string;
    status: string;
    tags?: { [key: string]: string };
}

Properties

backupId: string

Unique identifier for the backup.

BackupModel

cloud: string

Cloud provider where the backup is stored.

BackupModel

createdAt?: string

Timestamp when the backup was created.

BackupModel

description?: string

Optional description providing context for the backup.

BackupModel

dimension?: number

The dimensions of the vectors to be inserted in the index.

BackupModel

metric?: string

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'. Possible values: cosine, euclidean, or dotproduct.

BackupModel

name?: string

Optional user-defined name for the backup.

BackupModel

namespaceCount?: number

Number of namespaces in the backup.

BackupModel

recordCount?: number

Total number of records in the backup.

BackupModel

region: string

Cloud region where the backup is stored.

BackupModel

BackupModel

sizeBytes?: number

Size of the backup in bytes.

BackupModel

sourceIndexId: string

ID of the index.

BackupModel

sourceIndexName: string

Name of the index from which the backup was taken.

BackupModel

status: string

Current status of the backup (e.g., Initializing, Ready, Failed).

BackupModel

tags?: { [key: string]: string }

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

BackupModel