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

    Interface ZVecIVFQueryParams

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

    interface ZVecIVFQueryParams {
        radius?: number;
        isLinear?: boolean;
        isUsingRefiner?: boolean;
        indexType: 3;
        nprobe?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    radius? isLinear? isUsingRefiner? indexType nprobe?

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

    Must be ZVecIndexType.IVF (3).

    nprobe?: number

    Number of closest clusters (inverted lists) to search. Higher values improve recall but increase latency.

    10

    Settings

    Member Visibility

    On This Page

    Properties