IFClite TypeScript API
    Preparing search index...

    Type Alias ToolTurnOutcome<Route>

    ToolTurnOutcome:
        | { kind: "completed"; receipt: UsageReceipt<Route>; turn: ToolTurn }
        | { kind: "cancelled"; receipt: UsageReceipt<Route> }
        | { kind: "timeout"; receipt: UsageReceipt<Route> }
        | { kind: "error"; message: string; receipt: UsageReceipt<Route> }
        | { kind: "refused"; reason: "budget-exhausted" }

    Type Parameters

    • Route extends string = string

    Type Declaration

    • { kind: "completed"; receipt: UsageReceipt<Route>; turn: ToolTurn }

      The provider answered; read turn.stopReason (a model refusal is an answer too).

    • { kind: "cancelled"; receipt: UsageReceipt<Route> }
    • { kind: "timeout"; receipt: UsageReceipt<Route> }
    • { kind: "error"; message: string; receipt: UsageReceipt<Route> }
    • { kind: "refused"; reason: "budget-exhausted" }

      Nothing was sent: the root budget has no request or output left.

    Settings
    Member Visibility