Interface Aggregate<T>

groupBy

hybrid

• hybrid<M>(query, opts?): Promise<AggregateResult<T, M>>

• Aggregate metrics over the objects returned by a hybrid search on this collection.

  This method requires that the objects in the collection have associated vectors.

  Type Parameters

  • M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]

  Parameters

  • query: string

    The text query to search for.
  • Optional opts: AggregateHybridOptions<T, M>

    The options for the request.

  Returns Promise<AggregateResult<T, M>>

  The aggregated metrics for the objects returned by the vector search.

nearImage

• nearImage<M>(image, opts?): Promise<AggregateResult<T, M>>

• Aggregate metrics over the objects returned by a near image vector search on this collection.

  At least one of certainty, distance, or object_limit must be specified here for the vector search.

  This method requires a vectorizer capable of handling base64-encoded images, e.g. img2vec-neural, multi2vec-clip, and multi2vec-bind.

  Type Parameters

  • M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]

  Parameters

  • image: string | Buffer

    The image to search on. This can be a base64 string, a file path string, or a buffer.
  • Optional opts: AggregateNearOptions<M>

    The options for the request.

  Returns Promise<AggregateResult<T, M>>

  The aggregated metrics for the objects returned by the vector search.

nearObject

• nearObject<M>(id, opts?): Promise<AggregateResult<T, M>>

• Aggregate metrics over the objects returned by a near object search on this collection.

  At least one of certainty, distance, or object_limit must be specified here for the vector search.

  This method requires that the objects in the collection have associated vectors.

  Type Parameters

  • M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]

  Parameters

  • id: string

    The ID of the object to search for.
  • Optional opts: AggregateNearOptions<M>

    The options for the request.

  Returns Promise<AggregateResult<T, M>>

  The aggregated metrics for the objects returned by the vector search.

nearText

• nearText<M>(query, opts?): Promise<AggregateResult<T, M>>

• Aggregate metrics over the objects returned by a near vector search on this collection.

  At least one of certainty, distance, or object_limit must be specified here for the vector search.

  This method requires that the objects in the collection have associated vectors.

  Type Parameters

  • M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]

  Parameters

  • query: string | string[]

    The text query to search for.
  • Optional opts: AggregateNearOptions<M>

    The options for the request.

  Returns Promise<AggregateResult<T, M>>

  The aggregated metrics for the objects returned by the vector search.

nearVector

• nearVector<M>(vector, opts?): Promise<AggregateResult<T, M>>

• Aggregate metrics over the objects returned by a near vector search on this collection.

  At least one of certainty, distance, or object_limit must be specified here for the vector search.

  This method requires that the objects in the collection have associated vectors.

  Type Parameters

  • M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]

  Parameters

  • vector: number[]

    The vector to search for.
  • Optional opts: AggregateNearOptions<M>

    The options for the request.

  Returns Promise<AggregateResult<T, M>>

  The aggregated metrics for the objects returned by the vector search.

overAll

• overAll<M>(opts?): Promise<AggregateResult<T, M>>

• Aggregate metrics over all the objects in this collection without any vector search.

  Type Parameters

  • M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]

  Parameters

  • Optional opts: AggregateOverAllOptions<M>

    The options for the request.

  Returns Promise<AggregateResult<T, M>>

  The aggregated metrics for the objects in the collection.