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

    Interface ZVecGroupByQuery

    Vector query that groups search results by a scalar field.

    interface ZVecGroupByQuery {
        fieldName: string;
        vector: ZVecVector;
        groupByFieldName: string;
        groupCount?: number;
        topkPerGroup?: number;
        filter?: string;
        includeVector?: boolean;
        outputFields?: string[];
        params?:
            | ZVecHnswQueryParams
            | ZVecHnswRabitqQueryParams
            | ZVecIVFQueryParams
            | ZVecDiskAnnQueryParams;
    }
    Index

    Properties

    fieldName vector groupByFieldName groupCount? topkPerGroup? filter? includeVector? outputFields? params?

    Properties

    fieldName: string

    The vector field to search.

    vector: ZVecVector

    The query vector.

    groupByFieldName: string

    Scalar field whose values define the result groups.

    groupCount?: number

    Maximum number of groups to return.

    2
    topkPerGroup?: number

    Maximum number of documents to return per group.

    3
    filter?: string

    Boolean expression used to filter candidates.

    includeVector?: boolean

    Whether vector data is included in returned documents.

    false
    outputFields?: string[]

    Scalar fields to include. If undefined, all fields are returned.

    params?:
        | ZVecHnswQueryParams
        | ZVecHnswRabitqQueryParams
        | ZVecIVFQueryParams
        | ZVecDiskAnnQueryParams

    Query-time parameters for the selected vector index.

    Settings

    Member Visibility

    On This Page

    Properties