ADK for TypeScript: API Reference
    Preparing search index...

    Interface UserInputRequest

    A single request for user input carried by an event.

    interface UserInputRequest {
        authConfig?: AuthConfig;
        author?: string;
        functionCallName: string;
        interruptId: string;
        kind: UserInputKind;
        message?: string;
        payload?: unknown;
        responseSchema?: unknown;
        toolName?: string;
    }

    Properties

    authConfig?: AuthConfig

    credential only: the auth config to complete.

    author?: string

    The node or agent that raised the request.

    functionCallName: string

    The name to answer with, alongside interruptId.

    interruptId: string

    The id that answers this request: reply with a functionResponse carrying this same id (and functionCallName).

    kind: UserInputKind
    message?: string

    Human-readable prompt for the user. Populated for every kind: the RequestInput message, the credential prompt, or the tool-confirmation hint. Absent when the raiser supplied none.

    payload?: unknown

    Structured data attached to the request (RequestInput.payload).

    responseSchema?: unknown

    JSON schema the reply is expected to satisfy, when declared.

    toolName?: string

    confirmation only: the tool awaiting approval.

    Properties