Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface PreviewIndexModel

    The IndexModel describes the configuration and status of a Pinecone index.

    IndexModel

    interface PreviewIndexModel {
        cmekId?: string;
        deletionProtection: string;
        deployment: PreviewIndexDeployment;
        host: string;
        name: string;
        privateHost?: string;
        readCapacity?: PreviewReadCapacityResponse;
        schema: PreviewIndexSchema;
        sourceBackupId?: string;
        sourceCollection?: string;
        status: PreviewIndexModelStatus;
        tags?: { [key: string]: string };
    }
    Index
    cmekId? deletionProtection deployment host name privateHost? readCapacity? schema sourceBackupId? sourceCollection? status tags?
    cmekId?: string

    The ID of the customer-managed encryption key (CMEK) used to encrypt this index, if any.

    IndexModel

    deletionProtection: string

    Whether deletion protection is enabled/disabled for the index. Possible values: disabled or enabled.

    IndexModel

    deployment: PreviewIndexDeployment

    IndexModel

    host: string

    The URL address where the index is hosted.

    IndexModel

    name: string

    The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

    IndexModel

    privateHost?: string

    The private endpoint URL of an index.

    IndexModel

    readCapacity?: PreviewReadCapacityResponse

    IndexModel

    schema: PreviewIndexSchema

    IndexModel

    sourceBackupId?: string

    The ID of the backup this index was restored from, if any.

    IndexModel

    sourceCollection?: string

    The name of the collection this index was created from, if any.

    IndexModel

    status: PreviewIndexModelStatus

    IndexModel

    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.

    IndexModel

    Settings
    Member Visibility

    On This Page
    Properties