weaviate-client
    Preparing search index...

    Type Alias FetchObjectsOptions<T, I>

    Options available in the query.fetchObjects method

    type FetchObjectsOptions<T, I> = {
        after?: string;
        filters?: FilterValue;
        includeVector?: I;
        limit?: number;
        offset?: number;
        returnMetadata?: QueryMetadata;
        returnProperties?: QueryProperty<T>[];
        returnReferences?: QueryReference<T>[];
        sort?: Sorting<T>;
    }

    Type Parameters

    • T
    • I
    Index

    Properties

    after? filters? includeVector? limit? offset? returnMetadata? returnProperties? returnReferences? sort?

    Properties

    after?: string

    The cursor to start the query from. Incompatible with the offset param

    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

    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.

    sort?: Sorting<T>

    The sorting to be applied to the query. Use weaviate.sort.* to create sorting

    Settings

    Member Visibility

    On This Page

    Properties