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

    Type Alias ConfigureIndexOptions

    Options for configuring an index.

    Manage Indexes

    type ConfigureIndexOptions = {
        deletionProtection?: string;
        embed?: ConfigureIndexRequestEmbed;
        name: IndexName;
        podReplicas?: number;
        podType?: string;
        readCapacity?: CreateIndexReadCapacity;
        tags?: { [key: string]: string };
    }
    Index
    deletionProtection? embed? name podReplicas? podType? readCapacity? tags?
    deletionProtection?: string

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

    embed?: ConfigureIndexRequestEmbed

    The integrated inference embedding settings for this index.

    name: IndexName

    The name of the index to configure.

    podReplicas?: number

    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

    podType?: string

    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

    readCapacity?: CreateIndexReadCapacity

    The read capacity configuration for serverless and BYOC indexes. Configures whether the index uses on-demand or dedicated read capacity.

    Dedicated Read Nodes

    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.

    Settings
    Member Visibility

    On This Page
    Properties