Interface Aggregate<T, V>

groupBy

hybrid

• hybrid<
      P extends
          | MetricsInput<string>
          | MetricsInput<string>[]
          | MetricsInput<keyof T & string>
          | MetricsInput<keyof T & string>[],
  >(
      query: string,
      opts?: AggregateHybridOptions<T, P, V>,
      callOpts?: CallOptions,
  ): Promise<AggregateResult<T, P>>

  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

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

  Parameters

  • query: string

    The text query to search for.

  • Optionalopts: AggregateHybridOptions<T, P, V>

    The options for the request.

  • OptionalcallOpts: CallOptions

    The available options for the API call.

  Returns Promise<AggregateResult<T, P>>

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

nearImage

• nearImage<
      P extends
          | MetricsInput<string>
          | MetricsInput<string>[]
          | MetricsInput<keyof T & string>
          | MetricsInput<keyof T & string>[],
  >(
      image: Media,
      opts?: AggregateNearOptions<P, V>,
      callOpts?: CallOptions,
  ): Promise<AggregateResult<T, P>>

  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

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

  Parameters

  • image: Media

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

  • Optionalopts: AggregateNearOptions<P, V>

    The options for the request.

  • OptionalcallOpts: CallOptions

    The available options for the API call.

  Returns Promise<AggregateResult<T, P>>

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

nearObject

• nearObject<
      P extends
          | MetricsInput<string>
          | MetricsInput<string>[]
          | MetricsInput<keyof T & string>
          | MetricsInput<keyof T & string>[],
  >(
      id: string,
      opts?: AggregateNearOptions<P, V>,
      callOpts?: CallOptions,
  ): Promise<AggregateResult<T, P>>

  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

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

  Parameters

  • id: string

    The ID of the object to search for.

  • Optionalopts: AggregateNearOptions<P, V>

    The options for the request.

  • OptionalcallOpts: CallOptions

    The available options for the API call.

  Returns Promise<AggregateResult<T, P>>

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

nearText

• nearText<
      P extends
          | MetricsInput<string>
          | MetricsInput<string>[]
          | MetricsInput<keyof T & string>
          | MetricsInput<keyof T & string>[],
  >(
      query: string | string[],
      opts?: AggregateNearOptions<P, V>,
      callOpts?: CallOptions,
  ): Promise<AggregateResult<T, P>>

  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

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

  Parameters

  • query: string | string[]

    The text query to search for.

  • Optionalopts: AggregateNearOptions<P, V>

    The options for the request.

  • OptionalcallOpts: CallOptions

    The available options for the API call.

  Returns Promise<AggregateResult<T, P>>

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

nearVector

• nearVector<
      P extends
          | MetricsInput<string>
          | MetricsInput<string>[]
          | MetricsInput<keyof T & string>
          | MetricsInput<keyof T & string>[],
  >(
      vector: number[],
      opts?: AggregateNearOptions<P, V>,
      callOpts?: CallOptions,
  ): Promise<AggregateResult<T, P>>

  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

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

  Parameters

  • vector: number[]

    The vector to search for.

  • Optionalopts: AggregateNearOptions<P, V>

    The options for the request.

  • OptionalcallOpts: CallOptions

    The available options for the API call.

  Returns Promise<AggregateResult<T, P>>

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

overAll

• overAll<
      P extends
          | MetricsInput<string>
          | MetricsInput<string>[]
          | MetricsInput<keyof T & string>
          | MetricsInput<keyof T & string>[],
  >(
      opts?: AggregateOverAllOptions<P>,
      callOpts?: CallOptions,
  ): Promise<AggregateResult<T, P>>

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

  Type Parameters

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

  Parameters

  • Optionalopts: AggregateOverAllOptions<P>

    The options for the request.

  • OptionalcallOpts: CallOptions

    The available options for the API call.

  Returns Promise<AggregateResult<T, P>>

  The aggregated metrics for the objects in the collection.