Briyah SDK - v2.0.6
    Preparing search index...

    Interface DataField

    One queryable field.

    A field is not required to be a stored column. A host may declare a derived field — an age computed from a date of birth, a total computed from five columns — and translate it in its executor. Declaring it here is what keeps the arithmetic out of the model, which is the difference between an answer that is right and one that is plausible.

    interface DataField {
        aggregates?: DataAggregateFn[];
        description?: string;
        enumValues?: string[];
        filterable?: boolean;
        groupable?: boolean;
        label?: string;
        name: string;
        type: DataFieldType;
    }
    Index
    aggregates?: DataAggregateFn[]

    The aggregate functions allowed on this field. Omit for none — a field nothing can be summed over, like a name.

    description?: string

    What the field means, and anything an agent would otherwise assume wrongly.

    enumValues?: string[]

    For enum, the values it may hold. Rendered into the guide and enforced.

    filterable?: boolean

    May appear in filters. Default true.

    groupable?: boolean

    May appear in groupBy or be selected as a dimension. Default true.

    label?: string

    Human-facing name for the schema guide. Falls back to name.

    name: string

    The name an agent uses. Stable; it appears in prompts and saved queries.