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

    Interface DataSet

    One queryable collection of records.

    interface DataSet {
        defaultLimit?: number;
        description: string;
        fields: DataField[];
        label?: string;
        maxLimit?: number;
        name: string;
        notes?: string[];
    }
    Index
    defaultLimit?: number

    Rows returned when a query names no limit. Defaults to DEFAULT_ROW_LIMIT.

    description: string

    One or two sentences: what one row is, and what the set covers.

    fields: DataField[]
    label?: string

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

    maxLimit?: number

    The most rows this set will ever return, whatever a query asks for.

    name: string

    The name an agent uses.

    notes?: string[]

    Things an agent must know to read an answer correctly, rendered verbatim into the schema guide. This is the place to say what a set silently excludes, which of two plausible definitions a metric uses, and — just as importantly — what it is not related to, so an agent refuses a question instead of inventing a way to answer it.