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

    Interface ZVecHnswRabitqQueryParams

    Query-time parameters for searches performed against an HNSW-RaBitQ index.

    interface ZVecHnswRabitqQueryParams {
        radius?: number;
        isLinear?: boolean;
        isUsingRefiner?: boolean;
        indexType: 4;
        ef?: number;
        scaleFactor?: number;
    }

    Hierarchy

    • ZVecVectorQueryParams
      • ZVecHnswRabitqQueryParams
    Index

    Properties

    radius?: number

    Search radius for range queries. Used in combination with top-k to filter results.

    0.0 (disabled)
    
    isLinear?: boolean

    If True, forces brute-force linear search instead of using the index. Useful for debugging or small datasets.

    false
    
    isUsingRefiner?: boolean

    Whether to use refiner for the query.

    false
    
    indexType: 4

    Must be ZVecIndexType.HNSW_RABITQ (4).

    ef?: number

    Size of the dynamic candidate list during search. Larger values improve recall but slow down search.

    300
    
    scaleFactor?: number

    Candidate multiplier used when isUsingRefiner is true; ignored otherwise. Must be finite and nonnegative. Zero uses max(topk, ef) candidates; positive values use floor(topk * scaleFactor), with a minimum of topk.

    0