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

    Interface IndexModel

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

    IndexModel

    interface IndexModel {
        deletionProtection?: string;
        dimension?: number;
        embed?: ModelIndexEmbed;
        host: string;
        metric: string;
        name: string;
        privateHost?: string;
        spec: IndexModelSpec;
        status: IndexModelStatus;
        tags?: { [key: string]: string };
        vectorType: string;
    }
    Index
    deletionProtection?: string

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

    IndexModel

    dimension?: number

    The dimensions of the vectors to be inserted in the index.

    IndexModel

    IndexModel

    host: string

    The URL address where the index is hosted.

    IndexModel

    metric: string

    The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'. Possible values: cosine, euclidean, or dotproduct.

    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

    IndexModel

    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

    vectorType: string

    The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

    IndexModel