Type Alias ConfigureIndexOptions

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

Options for configuring an index.

Type declaration

  • OptionaldeletionProtection?: string

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

  • Optionalembed?: ConfigureIndexRequestEmbed

    The integrated inference embedding settings for this index.

  • name: IndexName

    The name of the index to configure.

  • OptionalpodReplicas?: 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.

  • OptionalpodType?: string

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

  • OptionalreadCapacity?: CreateIndexReadCapacity

    The read capacity configuration for dedicated read nodes.

    See

    Dedicated Read Nodes

  • Optionaltags?: { [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.

See

Manage Indexes

Settings

Member Visibility