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

    Interface ZVecHnswQueryParams

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

    interface ZVecHnswQueryParams {
        radius?: number;
        isLinear?: boolean;
        isUsingRefiner?: boolean;
        indexType: 1;
        ef?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    radius? isLinear? isUsingRefiner? indexType ef?

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

    Must be ZVecIndexType.HNSW (1).

    ef?: number

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

    300

    Settings

    Member Visibility

    On This Page

    Properties