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

    Interface ZVecHnswIndexParams

    Configuration parameters for an HNSW index on a vector field.

    interface ZVecHnswIndexParams {
        indexType: 1;
        metricType?: ZVecMetricType;
        m?: number;
        efConstruction?: number;
        quantizeType?: ZVecQuantizeType;
        useContiguousMemory?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    indexType metricType? m? efConstruction? quantizeType? useContiguousMemory?

    Properties

    indexType: 1

    Must be ZVecIndexType.HNSW (1).

    metricType?: ZVecMetricType

    Distance metric used for similarity computation.

    ZVecMetricType.IP
    m?: number

    Number of bi-directional links created for every new element during construction.

    50
    efConstruction?: number

    Size of the dynamic candidate list for nearest neighbors during index construction.

    500
    quantizeType?: ZVecQuantizeType

    Optional quantization type for vector compression.

    ZVecQuantizeType.UNDEFINED
    useContiguousMemory?: boolean

    Whether to allocate HNSW graph nodes in contiguous memory.

    false

    Settings

    Member Visibility

    On This Page

    Properties