Interface AggregateGroupBy<T>

interface AggregateGroupBy<T> {
    hybrid<M>(query, opts): Promise<AggregateGroupByResult<T, M>[]>;
    nearImage<M>(image, opts): Promise<AggregateGroupByResult<T, M>[]>;
    nearObject<M>(id, opts): Promise<AggregateGroupByResult<T, M>[]>;
    nearText<M>(query, opts): Promise<AggregateGroupByResult<T, M>[]>;
    nearVector<M>(vector, opts): Promise<AggregateGroupByResult<T, M>[]>;
    overAll<M>(opts?): Promise<AggregateGroupByResult<T, M>[]>;
}

Type Parameters

Index

Methods

hybrid nearImage nearObject nearText nearVector overAll

Methods

hybrid

hybrid<M>(query, opts): Promise<AggregateGroupByResult<T, M>[]>
Aggregate metrics over the objects grouped by a specified property and 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.
- opts: AggregateGroupByHybridOptions<T, M>
  The options for the request.
Returns Promise<AggregateGroupByResult<T, M>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in collections/aggregate/index.ts:742

nearImage

nearImage<M>(image, opts): Promise<AggregateGroupByResult<T, M>[]>
Aggregate metrics over the objects grouped by a specified property and 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.
- opts: AggregateGroupByNearOptions<T, M>
  The options for the request.
Returns Promise<AggregateGroupByResult<T, M>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in collections/aggregate/index.ts:757

nearObject

nearObject<M>(id, opts): Promise<AggregateGroupByResult<T, M>[]>
Aggregate metrics over the objects grouped by a specified property and 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.
- opts: AggregateGroupByNearOptions<T, M>
  The options for the request.
Returns Promise<AggregateGroupByResult<T, M>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in collections/aggregate/index.ts:772

nearText

nearText<M>(query, opts): Promise<AggregateGroupByResult<T, M>[]>
Aggregate metrics over the objects grouped by a specified property and returned by a near text 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 text, e.g. text2vec-contextionary, text2vec-openai, etc.
Type Parameters
- M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]
Parameters
- query: string | string[]
  The text to search for.
- opts: AggregateGroupByNearOptions<T, M>
  The options for the request.
Returns Promise<AggregateGroupByResult<T, M>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in collections/aggregate/index.ts:787

nearVector

nearVector<M>(vector, opts): Promise<AggregateGroupByResult<T, M>[]>
Aggregate metrics over the objects grouped by a specified property and 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.
- opts: AggregateGroupByNearOptions<T, M>
  The options for the request.
Returns Promise<AggregateGroupByResult<T, M>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in collections/aggregate/index.ts:802

overAll

overAll<M>(opts?): Promise<AggregateGroupByResult<T, M>[]>
Aggregate metrics over all the objects in this collection grouped by a specified property without any vector search.
Type Parameters
- M extends MetricsInput<string> | MetricsInput<string>[] | MetricsInput<keyof T & string> | MetricsInput<keyof T & string>[]
Parameters
- Optional opts: AggregateGroupByOptions<T, M>
  The options for the request.
Returns Promise<AggregateGroupByResult<T, M>[]>
The aggregated metrics for the objects in the collection.
- Defined in collections/aggregate/index.ts:812

Interface AggregateGroupBy<T>

Type Parameters

Index

Methods

Methods

hybrid

Type Parameters

Parameters

Returns Promise<AggregateGroupByResult<T, M>[]>

nearImage

Type Parameters

Parameters

Returns Promise<AggregateGroupByResult<T, M>[]>

nearObject

Type Parameters

Parameters

Returns Promise<AggregateGroupByResult<T, M>[]>

nearText

Type Parameters

Parameters

Returns Promise<AggregateGroupByResult<T, M>[]>

nearVector

Type Parameters

Parameters

Returns Promise<AggregateGroupByResult<T, M>[]>

overAll

Type Parameters

Parameters

Returns Promise<AggregateGroupByResult<T, M>[]>

Settings

Member Visibility

Theme

On This Page