Type alias FetchObjectByIdOptions<T>

FetchObjectByIdOptions<T>: {
    includeVector?: boolean | string[];
    returnProperties?: QueryProperty<T>[];
    returnReferences?: QueryReference<T>[];
}

Options available in the query.fetchObjectById method

Type Parameters

  • T

Type declaration

  • Optional includeVector?: boolean | string[]

    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.

  • Optional 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.

  • Optional returnReferences?: QueryReference<T>[]

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

Settings

Member Visibility

Theme