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

    Interface AskSqlConfig

    interface AskSqlConfig {
        allowDataInPrompt?: boolean;
        connectors: readonly Connector[];
        fewShots?: FewShotStore;
        glossary?: readonly GlossaryEntry[];
        history?: HistoryStore;
        llm?: LlmSettings;
        model: ModelLike;
        onEvent?: (event: EngineEvent) => void;
        policy?: Partial<GuardPolicy>;
        prompts?: PromptSettings;
        pruner?: PrunerSettings;
    }
    Index
    allowDataInPrompt?: boolean

    Schema-only prompting is the default; opting in allows sampled cell values. Never enable for regulated data.

    connectors: readonly Connector[]
    fewShots?: FewShotStore

    Few-shot store for the approve-to-learn feedback loop.

    glossary?: readonly GlossaryEntry[]

    Business glossary merged into every prompt.

    history?: HistoryStore
    model: ModelLike
    onEvent?: (event: EngineEvent) => void
    policy?: Partial<GuardPolicy>
    prompts?: PromptSettings

    Host overrides for the generated prompts.