Interface CreateIndexForModelRequest

The desired configuration for the index and associated embedding model.

CreateIndexForModelRequest

interface CreateIndexForModelRequest {
    cloud: string;
    deletionProtection?: string;
    embed: CreateIndexForModelRequestEmbed;
    name: string;
    readCapacity?: ReadCapacity;
    region: string;
    schema?: MetadataSchema;
    tags?: { [key: string]: string };
}

Properties

cloud: string

The public cloud where you would like your index hosted. Possible values: gcp, aws, or azure.

CreateIndexForModelRequest

deletionProtection?: string

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

CreateIndexForModelRequest

embed: CreateIndexForModelRequestEmbed

CreateIndexForModelRequest

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 '-'.

CreateIndexForModelRequest

readCapacity?: ReadCapacity

CreateIndexForModelRequest

region: string

The region where you would like your index to be created.

CreateIndexForModelRequest

CreateIndexForModelRequest

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.

CreateIndexForModelRequest