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

    Interface SqlPromptInput

    interface SqlPromptInput {
        catalogHint?: string;
        context?: readonly { question: string; sql: string }[];
        database?: string;
        dialect: DialectInfo;
        fewShots?: readonly { question: string; sql: string }[];
        glossary?: readonly { definition: string; term: string }[];
        maxRows: number;
        question: string;
        rerunPrevious?: boolean;
        schemas?: readonly string[];
        schemaText: string;
    }
    Index
    catalogHint? context? database? dialect fewShots? glossary? maxRows question rerunPrevious? schemas? schemaText
    catalogHint?: string

    A correct catalog query for this engine, offered when the question is about structure.

    context?: readonly { question: string; sql: string }[]
    database?: string

    Named so a question about system catalogs does not invent a placeholder database name.

    dialect: DialectInfo
    fewShots?: readonly { question: string; sql: string }[]
    glossary?: readonly { definition: string; term: string }[]
    maxRows: number
    question: string
    rerunPrevious?: boolean

    The question asks to re-run the previous query rather than for a new one.

    schemas?: readonly string[]
    schemaText: string

    Settings
    Member Visibility

    On This Page
    Properties