prorm API Reference
    Preparing search index...

    Interface MilvusSearchOptions

    Options for search().

    interface MilvusSearchOptions {
        vector: number[];
        annsField?: string;
        limit?: number;
        filter?: string;
        outputFields?: string[];
        partitionNames?: string[];
        metricType?: string;
        offset?: number;
    }
    Index
    vector annsField? limit? filter? outputFields? partitionNames? metricType? offset?
    vector: number[]

    The query vector to search for. Only a single query vector is supported per call - Milvus's underlying API also accepts a batch (number[][]) that returns one result set per query vector, but that shape isn't wrapped here; use getClient().search(...) directly for batched multi-vector search.

    annsField?: string

    Name of the vector field to search. Required if the collection has more than one vector field.

    limit?: number

    Max number of nearest neighbors to return per query vector.

    filter?: string

    Scalar filter expression narrowing candidates before/while ranking (Milvus's boolean expression language, e.g. 'age > 21 && category == "b"').

    outputFields?: string[]
    partitionNames?: string[]
    metricType?: string
    offset?: number

    Settings
    Member Visibility

    On This Page
    Properties