weaviate-client
    Preparing search index...

    Interface AggregateGroupBy<T, V>

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

    Type Parameters

    • T
    • V
    Index

    Methods

    hybrid nearImage nearObject nearText nearVector overAll

    Methods

    • 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

      Parameters

      • image: string | Buffer<ArrayBufferLike>

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

      • opts: AggregateGroupByNearOptions<T, M, V>

        The options for the request.

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

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

    Settings

    Member Visibility

    On This Page

    Methods