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>[];
}

Type Parameters

T
V
C extends GenerativeConfigRuntime | undefined

Index

Properties

generated? generative? groups objects

Properties

`Optional`generated

generated?: string

Deprecated

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

`Optional`generative

generative?: GenerativeGrouped<C>

groups

groups: Record<string, GenerativeGroupByResult<T, V, C>>

The groups that were created by the query.

objects

objects: GroupByObject<T, V>[]

The objects that were found by the query.