MAIDR JavaScript API
    Preparing search index...

    Interface LlmRequest

    Request payload for LLM API calls including message, instructions, and authentication.

    interface LlmRequest {
        message: string;
        customInstruction: string;
        expertise: "custom" | "basic" | "intermediate" | "advanced";
        apiKey?: string;
        email?: string;
        clientToken?: string;
        version?: LlmVersion;
        snapshot?: ChatSnapshot;
        history?: ChatTurn[];
    }
    Index

    Properties

    message customInstruction expertise apiKey? email? clientToken? version? snapshot? history?

    Properties

    message: string
    customInstruction: string
    expertise: "custom" | "basic" | "intermediate" | "advanced"
    apiKey?: string

    Provider credential. For cloud providers this is the API key; for Ollama it is the base URL of the local server (no key is required).

    email?: string
    clientToken?: string
    version?: LlmVersion

    Model version selected by the user, overriding the provider default.

    snapshot?: ChatSnapshot

    The plot as it stood when the question was triggered. Captured once per message and shared by every provider answering it; captured on demand when absent.

    history?: ChatTurn[]

    Earlier questions to this provider and its answers, oldest first. Text only: the plot image and the chart data are sent once, with the current question.

    Settings

    Member Visibility

    On This Page

    Properties