weaviate-client
    Preparing search index...

    Type Alias SearchOptions<T, I>

    Base options available to all the query methods that involve searching.

    type SearchOptions<T, I> = {
        autoLimit?: number;
        filters?: FilterValue;
        includeVector?: I;
        limit?: number;
        offset?: number;
        rerank?: RerankOptions<T>;
        returnMetadata?: QueryMetadata;
        returnProperties?: QueryProperty<T>[];
        returnReferences?: QueryReference<T>[];
    }

    Type Parameters

    • T
    • I
    Index

    Properties

    autoLimit? filters? includeVector? limit? offset? rerank? returnMetadata? returnProperties? returnReferences?

    Properties

    autoLimit?: number

    The autocut parameter

    filters?: FilterValue

    The filters to be applied to the query. Use weaviate.filter.* to create filters

    includeVector?: I

    Whether to include the vector of the object in the response. If using named vectors, pass an array of strings to include only specific vectors.

    limit?: number

    How many objects to return in the query

    offset?: number

    How many objects to skip in the query. Incompatible with the after cursor

    rerank?: RerankOptions<T>

    How to rerank the query results. Requires a configured reranking module.

    returnMetadata?: QueryMetadata

    Which metadata of the object to return. If not specified, no metadata is returned.

    returnProperties?: QueryProperty<T>[]

    Which properties of the object to return. Can be primitive, in which case specify their names, or nested, in which case use the QueryNested type. If not specified, all properties are returned.

    returnReferences?: QueryReference<T>[]

    Which references of the object to return. If not specified, no references are returned.

    Settings

    Member Visibility

    On This Page

    Properties