Type Alias GenerativeReturn<T, V, C>

The return of a query method in the collection.generate namespace.

type GenerativeReturn<T, V, C extends GenerativeConfigRuntime | undefined> = {
    generated?: string;
    generative?: GenerativeGrouped<C>;
    objects: GenerativeObject<T, V, C>[];
    queryProfile?: QueryProfile;
}

Type Parameters

T
V
C extends GenerativeConfigRuntime | undefined

Index

Properties

generated? generative? objects queryProfile?

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>

objects

objects: GenerativeObject<T, V, C>[]

The objects that were found by the query.

`Optional`queryProfile

queryProfile?: QueryProfile

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