Zvec Node.js API Reference
    Preparing search index...

    Interface ZVecIVFIndexParams

    Configuration parameters for an IVF index on a vector field.

    interface ZVecIVFIndexParams {
        indexType: 3;
        metricType?: ZVecMetricType;
        nList?: number;
        nIters?: number;
        quantizeType?: ZVecQuantizeType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    indexType metricType? nList? nIters? quantizeType?

    Properties

    indexType: 3

    Must be ZVecIndexType.IVF (3).

    metricType?: ZVecMetricType

    Distance metric used for similarity computation.

    ZVecMetricType.IP
    nList?: number

    Number of clusters (inverted lists) to partition the dataset into.

    10
    nIters?: number

    Number of iterations for k-means clustering during index training.

    10
    quantizeType?: ZVecQuantizeType

    Optional quantization type for vector compression.

    ZVecQuantizeType.UNDEFINED

    Settings

    Member Visibility

    On This Page

    Properties