Interface AggregateGroupBy<T, V, M>

interface AggregateGroupBy<T, V, M> {
 hybrid
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
 >(
 query: string,
 opts: AggregateGroupByHybridOptions<T, P, V>,
 ): Promise<AggregateGroupByResult<T, P>[]>;
 nearImage
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
 >(
 image: M,
 opts: AggregateGroupByNearOptions<T, P, V>,
 ): Promise<AggregateGroupByResult<T, P>[]>;
 nearObject
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
 >(
 id: string,
 opts: AggregateGroupByNearOptions<T, P, V>,
 ): Promise<AggregateGroupByResult<T, P>[]>;
 nearText
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
 >(
 query: string | string[],
 opts: AggregateGroupByNearOptions<T, P, V>,
 ): Promise<AggregateGroupByResult<T, P>[]>;
 nearVector
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
 >(
 vector: number[],
 opts: AggregateGroupByNearOptions<T, P, V>,
 ): Promise<AggregateGroupByResult<T, P>[]>;
 overAll
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
 >(
 opts?: AggregateGroupByOptions<T, P>,
 ): Promise<AggregateGroupByResult<T, P>[]>;
}

Type Parameters

Index

Methods

hybrid nearImage nearObject nearText nearVector overAll

Methods

hybrid

hybrid
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
>(
 query: string,
 opts: AggregateGroupByHybridOptions<T, P, V>,
): Promise<AggregateGroupByResult<T, P>[]>
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
- P 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, P, V>
 The options for the request.
Returns Promise<AggregateGroupByResult<T, P>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in packages/core/src/aggregate/index.ts:884

nearImage

nearImage
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
>(
 image: M,
 opts: AggregateGroupByNearOptions<T, P, V>,
): Promise<AggregateGroupByResult<T, P>[]>
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
- P extends
 | MetricsInput<string>
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[]
Parameters
- image: M
 The image to search on. This can be a base64 string, a file path string, or a buffer.
- opts: AggregateGroupByNearOptions<T, P, V>
 The options for the request.
Returns Promise<AggregateGroupByResult<T, P>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in packages/core/src/aggregate/index.ts:899

nearObject

nearObject
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
>(
 id: string,
 opts: AggregateGroupByNearOptions<T, P, V>,
): Promise<AggregateGroupByResult<T, P>[]>
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
- 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.
- opts: AggregateGroupByNearOptions<T, P, V>
 The options for the request.
Returns Promise<AggregateGroupByResult<T, P>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in packages/core/src/aggregate/index.ts:914

nearText

nearText
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
>(
 query: string | string[],
 opts: AggregateGroupByNearOptions<T, P, V>,
): Promise<AggregateGroupByResult<T, P>[]>
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
- P 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, P, V>
 The options for the request.
Returns Promise<AggregateGroupByResult<T, P>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in packages/core/src/aggregate/index.ts:929

nearVector

nearVector
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[],
>(
 vector: number[],
 opts: AggregateGroupByNearOptions<T, P, V>,
): Promise<AggregateGroupByResult<T, P>[]>
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
- P extends
 | MetricsInput<string>
 | MetricsInput<string>[]
 | MetricsInput<keyof T & string>
 | MetricsInput<keyof T & string>[]
Parameters
- vector: number[]
 The vector to search for.
- opts: AggregateGroupByNearOptions<T, P, V>
 The options for the request.
Returns Promise<AggregateGroupByResult<T, P>[]>
The aggregated metrics for the objects returned by the vector search.
- Defined in packages/core/src/aggregate/index.ts:944

overAll

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

Interface AggregateGroupBy<T, V, M>

Type Parameters

Index

Methods

Methods

hybrid

Type Parameters

Parameters

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

nearImage

Type Parameters

Parameters

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

nearObject

Type Parameters

Parameters

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

nearText

Type Parameters

Parameters

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

nearVector

Type Parameters

Parameters

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

overAll

Type Parameters

Parameters

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

Settings

On This Page