AskSQL API Reference (core v0.10.0)
    Preparing search index...

    Interface SchemaAnswer

    interface SchemaAnswer {
        answer: string;
        grounded: boolean;
        isSchemaChange: boolean;
        proposedSql?: string;
        tables: readonly string[];
        unknownReferences: readonly string[];
    }
    Index
    answer: string
    grounded: boolean

    True unless the answer named a table/column not present in the schema.

    isSchemaChange: boolean

    The question asked to add/change/remove schema objects, so unknownReferences are proposals AskSQL never runs, not errors.

    proposedSql?: string

    The read-only query this answer suggested, if it suggested one. Carry it into the next turn's context so "run that query" means the query the user just read. Absent for a write proposal.

    tables: readonly string[]

    Catalog tables given to the model as grounding (schema-qualified where applicable).

    unknownReferences: readonly string[]

    Identifier-shaped names in the answer absent from the schema. For a schema-change request these are proposed new names; otherwise they are hallucinations.