ART Framework API Docs
    Preparing search index...

    Interface ToolResult

    Represents the structured result of a tool execution.

    ToolResult

    interface ToolResult {
        callId: string;
        error?: string;
        metadata?: {
            sources?: { sourceName: string; url?: string; [key: string]: any }[];
            suspensionId?: string;
            [key: string]: any;
        };
        output?: any;
        status: "suspended"
        | "success"
        | "error";
        toolName: string;
    }
    Index

    Properties

    callId error? metadata? output? status toolName

    Properties

    callId: string

    The unique identifier of the corresponding ParsedToolCall that initiated this execution attempt.

    error?: string

    A descriptive error message if the execution failed (status is 'error').

    metadata?: {
        sources?: { sourceName: string; url?: string; [key: string]: any }[];
        suspensionId?: string;
        [key: string]: any;
    }

    Optional metadata about the execution (e.g., duration, cost, logs).

    output?: any

    The data returned by the tool upon successful execution. Structure may be validated against outputSchema.

    status: "suspended" | "success" | "error"

    Indicates whether the tool execution succeeded, failed, or was suspended.

    toolName: string

    The name of the tool that was executed.

    Settings

    Member Visibility

    On This Page

    Properties