ART Framework API Docs
    Preparing search index...

    Interface BlockingToolSuspendedResult

    Extended ToolResult for blocking tools that return 'suspended' status.

    When a blocking tool returns 'suspended', it should include the feedbackSchema so the UI knows what to render.

    interface BlockingToolSuspendedResult {
        callId: string;
        feedbackSchema?: HITLFeedbackSchema;
        metadata?: { suspensionId: string; [key: string]: unknown };
        output?: {
            details?: Record<string, unknown>;
            message: string;
            previewData?: unknown;
        };
        status: "suspended";
        toolName: string;
    }
    Index

    Properties

    callId feedbackSchema? metadata? output? status toolName

    Properties

    callId: string
    feedbackSchema?: HITLFeedbackSchema

    The feedback schema for the UI to render. If not provided, the framework uses the tool's schema config.

    metadata?: { suspensionId: string; [key: string]: unknown }

    Metadata including the suspensionId.

    output?: {
        details?: Record<string, unknown>;
        message: string;
        previewData?: unknown;
    }

    Display content to show in the suspension UI.

    status: "suspended"
    toolName: string

    Settings

    Member Visibility

    On This Page

    Properties