weaviate-client
    Preparing search index...

    Interface Aggregate<T, V>

    interface Aggregate<T, V> {
        groupBy: AggregateGroupBy<T, V>;
        hybrid<
            M extends
                | MetricsInput<string>
                | MetricsInput<string>[]
                | MetricsInput<keyof T & string>
                | MetricsInput<keyof T & string>[],
        >(
            query: string,
            opts?: AggregateHybridOptions<T, M, V>,
        ): Promise<AggregateResult<T, M>>;
        nearImage<
            M extends
                | MetricsInput<string>
                | MetricsInput<string>[]
                | MetricsInput<keyof T & string>
                | MetricsInput<keyof T & string>[],
        >(
            image: string | Buffer<ArrayBufferLike>,
            opts?: AggregateNearOptions<M, V>,
        ): Promise<AggregateResult<T, M>>;
        nearObject<
            M extends
                | MetricsInput<string>
                | MetricsInput<string>[]
                | MetricsInput<keyof T & string>
                | MetricsInput<keyof T & string>[],
        >(
            id: string,
            opts?: AggregateNearOptions<M, V>,
        ): Promise<AggregateResult<T, M>>;
        nearText<
            M extends
                | MetricsInput<string>
                | MetricsInput<string>[]
                | MetricsInput<keyof T & string>
                | MetricsInput<keyof T & string>[],
        >(
            query: string | string[],
            opts?: AggregateNearOptions<M, V>,
        ): Promise<AggregateResult<T, M>>;
        nearVector<
            M extends
                | MetricsInput<string>
                | MetricsInput<string>[]
                | MetricsInput<keyof T & string>
                | MetricsInput<keyof T & string>[],
        >(
            vector: number[],
            opts?: AggregateNearOptions<M, V>,
        ): Promise<AggregateResult<T, M>>;
        overAll<
            M extends
                | MetricsInput<string>
                | MetricsInput<string>[]
                | MetricsInput<keyof T & string>
                | MetricsInput<keyof T & string>[],
        >(
            opts?: AggregateOverAllOptions<M>,
        ): Promise<AggregateResult<T, M>>;
    }

    Type Parameters

    • T
    • V
    Index

    Properties

    groupBy

    Methods

    hybrid nearImage nearObject nearText nearVector overAll

    Properties

    groupBy: AggregateGroupBy<T, V>

    This namespace contains methods perform a group by search while aggregating metrics.

    Methods

    • 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

      Parameters

      • image: string | Buffer<ArrayBufferLike>

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

      • Optionalopts: AggregateNearOptions<M, V>

        The options for the request.

      Returns Promise<AggregateResult<T, M>>

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods