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

    Interface ZVecDiskAnnIndexParams

    Configuration parameters for a DiskANN index on a vector field.

    interface ZVecDiskAnnIndexParams {
        indexType: 5;
        metricType?: ZVecMetricType;
        maxDegree?: number;
        listSize?: number;
        pqChunkNum?: number;
        quantizeType?: ZVecQuantizeType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    indexType: 5

    Must be ZVecIndexType.DISKANN (5).

    metricType?: ZVecMetricType

    Distance metric used for similarity computation.

    ZVecMetricType.IP
    
    maxDegree?: number

    Maximum out-degree of each graph node.

    100
    
    listSize?: number

    Candidate list size used during graph construction.

    50
    
    pqChunkNum?: number

    Maximum number of PQ chunks for product quantization. 0 lets the engine choose.

    0
    
    quantizeType?: ZVecQuantizeType

    Optional quantization type for vector compression.

    ZVecQuantizeType.UNDEFINED