@jambonz/sdk
    Preparing search index...

    Interface LlmVerb

    interface LlmVerb {
        id?: string;
        model?: string;
        auth?: { apiKey?: string; [key: string]: unknown };
        connectOptions?: Record<string, unknown>;
        llmOptions: Record<string, unknown>;
        mcpServers?: McpServerConfig[];
        actionHook?: ActionHook;
        eventHook?: ActionHook;
        toolHook?: ActionHook;
        events?: string[];
        handoff?: Handoff;
        hangup?: { reason?: string };
        responseTimeoutMs?: number;
        cancelOnResponseTimeout?: boolean;
        cancelOnBargeIn?: boolean;
        verb: "llm";
        vendor: string;
    }

    Hierarchy

    • LlmBaseOptions
      • LlmVerb
    Index

    Properties

    id? model? auth? connectOptions? llmOptions mcpServers? actionHook? eventHook? toolHook? events? handoff? hangup? responseTimeoutMs? cancelOnResponseTimeout? cancelOnBargeIn? verb vendor

    Properties

    id?: string
    model?: string

    Model name.

    auth?: { apiKey?: string; [key: string]: unknown }

    LLM vendor authentication.

    connectOptions?: Record<string, unknown>

    Additional connection options (e.g. custom base URLs).

    llmOptions: Record<string, unknown>

    LLM configuration including messages, temperature, tools.

    mcpServers?: McpServerConfig[]

    MCP servers for tool invocation.

    actionHook?: ActionHook

    Webhook when LLM conversation ends.

    eventHook?: ActionHook

    Webhook for real-time LLM events.

    toolHook?: ActionHook

    Webhook when LLM calls a tool.

    events?: string[]

    Event types to receive via eventHook.

    handoff?: Handoff

    Declarative transfer-to-human: injects a transfer tool and runs the packaged transfer when the model calls it.

    hangup?: { reason?: string }

    Enable the built-in hangup tool for s2s verbs. When present, the runtime injects a 'hangup' tool; when the model calls it the call ends with the reason placed in an X-Reason SIP header (LLM-supplied reason wins, falling back to hangup.reason).

    responseTimeoutMs?: number

    Opt-in per-response stall watchdog (ms) for s2s vendors that support app-driven turn-taking. Omit or set to 0 to disable (the default).

    cancelOnResponseTimeout?: boolean

    When a response stall is detected (see responseTimeoutMs), cancel the in-progress server-side response. Has no effect unless responseTimeoutMs is set.

    cancelOnBargeIn?: boolean

    On caller barge-in, cancel the in-progress server-side response (app-driven turn-taking configurations).

    verb: "llm"
    vendor: string

    LLM vendor.

    Settings

    Member Visibility

    On This Page

    Properties