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

    Interface ZVecIvfRabitqQueryParams

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

    Platform support: Only available on Linux x86_64 with AVX2/AVX-512.

    interface ZVecIvfRabitqQueryParams {
        radius?: number;
        isLinear?: boolean;
        isUsingRefiner?: boolean;
        indexType: 7;
        nprobe?: number;
        scaleFactor?: number;
    }

    Hierarchy

    • ZVecVectorQueryParams
      • ZVecIvfRabitqQueryParams
    Index

    Properties

    radius? isLinear? isUsingRefiner? indexType nprobe? scaleFactor?

    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: 7

    Must be ZVecIndexType.IVF_RABITQ (7).

    nprobe?: number

    Number of closest clusters (inverted lists) to search.

    10
    scaleFactor?: number

    Candidate expansion factor used by the optional refiner.

    10

    Settings

    Member Visibility

    On This Page

    Properties