weaviate-client
    Preparing search index...

    Type Alias FetchObjectByIdOptions<T, I>

    Options available in the query.fetchObjectById method

    type FetchObjectByIdOptions<T, I> = {
        includeVector?: I;
        returnProperties?: QueryProperty<T>[];
        returnReferences?: QueryReference<T>[];
    }

    Type Parameters

    • T
    • I
    Index

    Properties

    includeVector? returnProperties? returnReferences?

    Properties

    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.

    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