weaviate-client
    Preparing search index...

    Type Alias GenerativeGroupByReturn<T, V, C>

    The return of a query method in the collection.generate namespace where the groupBy argument was specified.

    type GenerativeGroupByReturn<
        T,
        V,
        C extends GenerativeConfigRuntime | undefined,
    > = {
        generated?: string;
        generative?: GenerativeGrouped<C>;
        groups: Record<string, GenerativeGroupByResult<T, V, C>>;
        objects: GroupByObject<T, V>[];
        queryProfile?: QueryProfile;
    }

    Type Parameters

    Index

    Properties

    generated? generative? groups objects queryProfile?

    Properties

    generated?: string

    (use generative.text instead) The LLM-generated output applicable to this query as a whole.

    generative?: GenerativeGrouped<C>
    groups: Record<string, GenerativeGroupByResult<T, V, C>>

    The groups that were created by the query.

    objects: GroupByObject<T, V>[]

    The objects that were found by the query.

    queryProfile?: QueryProfile

    The metadata about the query execution. This contains different datastructures depending on the search type, e.g. vector vs keyword.

    Settings

    Member Visibility

    On This Page

    Properties