Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Interface IndexModelData

    The configuration and status of an index, as returned by Indexes.describe, Indexes.create, and Indexes.configure.

    interface IndexModelData {
        cmekId?: string;
        deletionProtection: string & {} | DeletionProtection;
        deployment: IndexDeployment;
        host: string;
        name: string;
        privateHost?: string;
        readCapacity?: ReadCapacityResponse;
        schema: IndexSchema;
        sourceBackupId?: string;
        sourceCollection?: string;
        status: IndexModelStatus;
        tags?: { [key: string]: string } | null;
    }

    Hierarchy (View Summary)

    • Omit<
          GeneratedIndexModel,
          "status"
          | "schema"
          | "readCapacity"
          | "deletionProtection",
      >
    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 & {} | DeletionProtection

    Whether deletion protection is enabled for the index.

    deployment: IndexDeployment

    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?: ReadCapacityResponse

    The read capacity configuration of the index.

    schema: IndexSchema

    The typed fields stored in each document.

    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: IndexModelStatus

    The current status of the index.

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

    Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags.

    IndexModel

    Settings
    Member Visibility

    On This Page
    Properties