Interface Query<T, V>

All the available methods on the .query namespace.

interface Query<T, V> {
    fetchObjectById: (<I>(id, opts?) => Promise<null | WeaviateObject<T, ReturnVectors<V, I>>>);
    fetchObjects: (<I>(opts?) => Promise<WeaviateReturn<T, ReturnVectors<V, I>>>);
    bm25<I, RV>(query, opts?): Promise<WeaviateReturn<T, RV>>;
    bm25<I, RV>(query, opts): Promise<GroupByReturn<T, RV>>;
    bm25<I, RV>(query, opts?): QueryReturn<T, RV>;
    hybrid<I, RV>(query, opts?): Promise<WeaviateReturn<T, RV>>;
    hybrid<I, RV>(query, opts): Promise<GroupByReturn<T, RV>>;
    hybrid<I, RV>(query, opts?): QueryReturn<T, RV>;
    nearImage<I, RV>(image, opts?): Promise<WeaviateReturn<T, RV>>;
    nearImage<I, RV>(image, opts): Promise<GroupByReturn<T, RV>>;
    nearImage<I, RV>(image, opts?): QueryReturn<T, RV>;
    nearMedia<I, RV>(media, type, opts?): Promise<WeaviateReturn<T, RV>>;
    nearMedia<I, RV>(media, type, opts): Promise<GroupByReturn<T, RV>>;
    nearMedia<I, RV>(media, type, opts?): QueryReturn<T, RV>;
    nearObject<I, RV>(id, opts?): Promise<WeaviateReturn<T, RV>>;
    nearObject<I, RV>(id, opts): Promise<GroupByReturn<T, RV>>;
    nearObject<I, RV>(id, opts?): QueryReturn<T, RV>;
    nearText<I, RV>(query, opts?): Promise<WeaviateReturn<T, RV>>;
    nearText<I, RV>(query, opts): Promise<GroupByReturn<T, RV>>;
    nearText<I, RV>(query, opts?): QueryReturn<T, RV>;
    nearVector<I, RV>(vector, opts?): Promise<WeaviateReturn<T, RV>>;
    nearVector<I, RV>(vector, opts): Promise<GroupByReturn<T, RV>>;
    nearVector<I, RV>(vector, opts?): QueryReturn<T, RV>;
}

Type Parameters

  • T
  • V

Hierarchy

  • Bm25<T, V>
  • Hybrid<T, V>
  • NearImage<T, V>
  • NearMedia<T, V>
  • NearObject<T, V>
  • NearText<T, V>
  • NearVector<T, V>
    • Query

Properties

fetchObjectById fetchObjects

Methods

bm25 hybrid nearImage nearMedia nearObject nearText nearVector

Properties

fetchObjectById

fetchObjectById: (<I>(id, opts?) => Promise<null | WeaviateObject<T, ReturnVectors<V, I>>>)

Retrieve an object from the server by its UUID.

Type declaration

Returns

  • The object with the given UUID, or null if it does not exist.

fetchObjects

fetchObjects: (<I>(opts?) => Promise<WeaviateReturn<T, ReturnVectors<V, I>>>)

Retrieve objects from the server without searching.

Type declaration

Returns

  • The objects within the fetched collection.

Methods

bm25

  • bm25<I, RV>(query, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects in this collection using the keyword-based BM25 algorithm.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>

      The vector(s) to include in the response. If using named vectors, pass an array of strings to include only specific vectors.

    • RV

      The vectors(s) to be returned in the response depending on the input in opts.includeVector.

    Parameters

    • query: string

      The query to search for.

    • Optional opts: BaseBm25Options<T, I>

      The available options for the search excluding the groupBy param.

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • bm25<I, RV>(query, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects in this collection using the keyword-based BM25 algorithm.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>

      The vector(s) to include in the response. If using named vectors, pass an array of strings to include only specific vectors.

    • RV

      The vectors(s) to be returned in the response depending on the input in opts.includeVector.

    Parameters

    • query: string

      The query to search for.

    • opts: GroupByBm25Options<T, I>

      The available options for the search including the groupBy param.

    Returns Promise<GroupByReturn<T, RV>>

    • The result of the search within the fetched collection.
  • bm25<I, RV>(query, opts?): QueryReturn<T, RV>

  • Search for objects in this collection using the keyword-based BM25 algorithm.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>

      The vector(s) to include in the response. If using named vectors, pass an array of strings to include only specific vectors.

    • RV

      The vectors(s) to be returned in the response depending on the input in opts.includeVector.

    Parameters

    • query: string

      The query to search for.

    • Optional opts: Bm25Options<T, I>

      The available options for the search including the groupBy param.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

hybrid

  • hybrid<I, RV>(query, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects in this collection using the hybrid algorithm blending keyword-based BM25 and vector-based similarity.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>

      The vector(s) to include in the response. If using named vectors, pass an array of strings to include only specific vectors.

    • RV

      The vectors(s) to be returned in the response depending on the input in opts.includeVector.

    Parameters

    • query: string

      The query to search for in the BM25 keyword search..

    • Optional opts: BaseHybridOptions<T, V, I>

      The available options for the search excluding the groupBy param.

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • hybrid<I, RV>(query, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects in this collection using the hybrid algorithm blending keyword-based BM25 and vector-based similarity.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>

      The vector(s) to include in the response. If using named vectors, pass an array of strings to include only specific vectors.

    • RV

      The vectors(s) to be returned in the response depending on the input in opts.includeVector.

    Parameters

    • query: string

      The query to search for in the BM25 keyword search..

    • opts: GroupByHybridOptions<T, V, I>

      The available options for the search including the groupBy param.

    Returns Promise<GroupByReturn<T, RV>>

    • The result of the search within the fetched collection.
  • hybrid<I, RV>(query, opts?): QueryReturn<T, RV>

  • Search for objects in this collection using the hybrid algorithm blending keyword-based BM25 and vector-based similarity.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • query: string

      The query to search for in the BM25 keyword search..

    • Optional opts: HybridOptions<T, V, I>

      The available options for the search including the groupBy param.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

nearImage

  • nearImage<I, RV>(image, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects by image in this collection using an image-capable vectorization module and vector-based similarity search. You must have an image-capable vectorization module installed in order to use this method, e.g. img2vec-neural, multi2vec-clip, or `multi2vec-bind.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    @param {string | Buffer} image - The image to search on. This can be a base64 string, a file path string, or a buffer. @param {BaseNearOptions<T, V>} [opts] - The available options for the search excluding the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • nearImage<I, RV>(image, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects by image in this collection using an image-capable vectorization module and vector-based similarity search. You must have an image-capable vectorization module installed in order to use this method, e.g. img2vec-neural, multi2vec-clip, or `multi2vec-bind.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    @param {string | Buffer} image - The image to search on. This can be a base64 string, a file path string, or a buffer. @param {GroupByNearOptions<T, V>} opts - The available options for the search including the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    Returns Promise<GroupByReturn<T, RV>>

    • The group by result of the search within the fetched collection.
  • nearImage<I, RV>(image, opts?): QueryReturn<T, RV>

  • Search for objects by image in this collection using an image-capable vectorization module and vector-based similarity search. You must have an image-capable vectorization module installed in order to use this method, e.g. img2vec-neural, multi2vec-clip, or `multi2vec-bind.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • image: string | Buffer

      The image to search on. This can be a base64 string, a file path string, or a buffer.

    • Optional opts: NearOptions<T, V, I>

      The available options for the search.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

nearMedia

  • nearMedia<I, RV>(media, type, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects by image in this collection using an image-capable vectorization module and vector-based similarity search. You must have a multi-media-capable vectorization module installed in order to use this method, e.g. multi2vec-bind or multi2vec-palm.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • media: string | Buffer

      The media to search on. This can be a base64 string, a file path string, or a buffer.

    • type: NearMediaType

      The type of media to search for, e.g. 'audio'.

    • Optional opts: BaseNearOptions<T, V, I>

      The available options for the search excluding the groupBy param.

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • nearMedia<I, RV>(media, type, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects by image in this collection using an image-capable vectorization module and vector-based similarity search. You must have a multi-media-capable vectorization module installed in order to use this method, e.g. multi2vec-bind or multi2vec-palm.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • media: string | Buffer

      The media to search on. This can be a base64 string, a file path string, or a buffer.

    • type: NearMediaType

      The type of media to search for, e.g. 'audio'.

    • opts: GroupByNearOptions<T, V, I>

      The available options for the search including the groupBy param.

    Returns Promise<GroupByReturn<T, RV>>

    • The group by result of the search within the fetched collection.
  • nearMedia<I, RV>(media, type, opts?): QueryReturn<T, RV>

  • Search for objects by image in this collection using an image-capable vectorization module and vector-based similarity search. You must have a multi-media-capable vectorization module installed in order to use this method, e.g. multi2vec-bind or multi2vec-palm.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • media: string | Buffer

      The media to search on. This can be a base64 string, a file path string, or a buffer.

    • type: NearMediaType

      The type of media to search for, e.g. 'audio'.

    • Optional opts: NearOptions<T, V, I>

      The available options for the search.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

nearObject

  • nearObject<I, RV>(id, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects in this collection by another object using a vector-based similarity search.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • id: string

      The UUID of the object to search for.

    • Optional opts: BaseNearOptions<T, V, I>

      The available options for the search excluding the groupBy param.

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • nearObject<I, RV>(id, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects in this collection by another object using a vector-based similarity search.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • id: string

      The UUID of the object to search for.

    • opts: GroupByNearOptions<T, V, I>

      The available options for the search including the groupBy param.

    Returns Promise<GroupByReturn<T, RV>>

    • The group by result of the search within the fetched collection.
  • nearObject<I, RV>(id, opts?): QueryReturn<T, RV>

  • Search for objects in this collection by another object using a vector-based similarity search.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • id: string

      The UUID of the object to search for.

    • Optional opts: NearOptions<T, V, I>

      The available options for the search.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

nearText

  • nearText<I, RV>(query, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects in this collection by text using text-capable vectorization module and vector-based similarity search. You must have a text-capable vectorization module installed in order to use this method, e.g. any of the text2vec- and multi2vec- modules.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • query: string | string[]

      The text query to search for.

    • Optional opts: BaseNearTextOptions<T, V, I>

      The available options for the search excluding the groupBy param.

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • nearText<I, RV>(query, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects in this collection by text using text-capable vectorization module and vector-based similarity search. You must have a text-capable vectorization module installed in order to use this method, e.g. any of the text2vec- and multi2vec- modules.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • query: string | string[]

      The text query to search for.

    • opts: GroupByNearTextOptions<T, V, I>

      The available options for the search including the groupBy param.

    Returns Promise<GroupByReturn<T, RV>>

    • The group by result of the search within the fetched collection.
  • nearText<I, RV>(query, opts?): QueryReturn<T, RV>

  • Search for objects in this collection by text using text-capable vectorization module and vector-based similarity search. You must have a text-capable vectorization module installed in order to use this method, e.g. any of the text2vec- and multi2vec- modules.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • query: string | string[]

      The text query to search for.

    • Optional opts: NearTextOptions<T, V, I>

      The available options for the search.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

nearVector

  • nearVector<I, RV>(vector, opts?): Promise<WeaviateReturn<T, RV>>

  • Search for objects by vector in this collection using a vector-based similarity search.

    See the docs for a more detailed explanation.

    This overload is for performing a search without the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • vector: NearVectorInputType

      The vector(s) to search on.

    • Optional opts: BaseNearOptions<T, V, I>

      The available options for the search excluding the groupBy param.

    Returns Promise<WeaviateReturn<T, RV>>

    • The result of the search within the fetched collection.
  • nearVector<I, RV>(vector, opts): Promise<GroupByReturn<T, RV>>

  • Search for objects by vector in this collection using a vector-based similarity search.

    See the docs for a more detailed explanation.

    This overload is for performing a search with the groupBy param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • vector: NearVectorInputType

      The vector(s) to search for.

    • opts: GroupByNearOptions<T, V, I>

      The available options for the search including the groupBy param.

    Returns Promise<GroupByReturn<T, RV>>

    • The group by result of the search within the fetched collection.
  • nearVector<I, RV>(vector, opts?): QueryReturn<T, RV>

  • Search for objects by vector in this collection using a vector-based similarity search.

    See the docs for a more detailed explanation.

    This overload is for performing a search with a programmatically defined opts param.

    Type Parameters

    • I extends IncludeVector<V>
    • RV

    Parameters

    • vector: NearVectorInputType

      The vector(s) to search for.

    • Optional opts: NearOptions<T, V, I>

      The available options for the search.

    Returns QueryReturn<T, RV>

    • The result of the search within the fetched collection.

Settings

Member Visibility

Theme

On This Page

fetchObjectByIdfetchObjectsbm25hybridnearImagenearMedianearObjectnearTextnearVector