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

    Interface CreateIndexOptions

    interface CreateIndexOptions {
        deletionProtection?: string;
        dimension?: number;
        metric?: string;
        name: string;
        spec: CreateIndexSpec;
        suppressConflicts?: boolean;
        tags?: { [key: string]: string };
        timeout?: number;
        vectorType?: string;
        waitUntilReady?: boolean;
    }

    Hierarchy

    Index
    deletionProtection?: string

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

    CreateIndexRequest

    dimension?: number

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

    CreateIndexRequest

    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.

    CreateIndexRequest

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

    CreateIndexRequest

    This option specifies how the index should be deployed.

    suppressConflicts?: boolean

    This option tells the client not to throw if you attempt to create an index that already exists.

    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.

    CreateIndexRequest

    timeout?: number

    Maximum time in milliseconds to wait for the index to become ready when waitUntilReady is true. Omit to poll indefinitely. Throws Errors.PineconeTimeoutError if the deadline is exceeded.

    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.

    CreateIndexRequest

    waitUntilReady?: boolean

    This option tells the client not to resolve the returned promise until the index is ready to receive data.