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

    Interface ChatEvent

    interface ChatEvent {
        autoLimited?: boolean;
        code?: string;
        collection?: string;
        explanation?: string;
        retryable?: boolean;
        sql?: string;
        stage?: string;
        text?: string;
        type: "stage" | "token" | "sql" | "error" | "done";
        userMessage?: string;
    }
    Index
    autoLimited? code? collection? explanation? retryable? sql? stage? text? type userMessage?
    autoLimited?: boolean
    code?: string
    collection?: string

    MongoDB only: the collection the pipeline runs against, required to execute it.

    explanation?: string
    retryable?: boolean
    sql?: string
    stage?: string

    Optional Readonlytext

    text?: string
    type: "stage" | "token" | "sql" | "error" | "done"
    userMessage?: string

    Settings
    Member Visibility

    On This Page
    Properties