Bluestep JS Documentation
    Preparing search index...

    Interface AiToolCallEvent

    One tool call the model requested: handed to onToolCall and onToolResult, listed on AiIterationState.toolCalls, and returned as AiCallResult.deferred for the calls a hook deferred. arguments is a copy; to run the call with different arguments, return {action: "run", arguments} from onToolCall. annotations is what the tool's author said the tool does, for a hook to hold a policy over.

    Example: ```javascript const asked = []; const result = B.ai.call({ message: B.net.request.parameter("q"), tools: [archiveNote], onToolCall: (call) => { asked.push(call.name + " " + JSON.stringify(call.arguments)); return call.annotations && call.annotations.destructive ? { action: "deny", reason: "destructive tools need a human" } : null; }, }); ```

    interface AiToolCallEvent {
        annotations: AiToolAnnotations;
        arguments: object;
        id: string;
        name: string;
    }
    Index
    annotations arguments id name
    annotations: AiToolAnnotations

    The advisory labels the tool was registered with — {readOnly?, destructive?, idempotent?} — or null where it carries none or is no longer registered. Never enforced; this is what an onToolCall policy reads.

    arguments: object

    The arguments the model wrote, as an object. A copy: mutating it changes nothing.

    id: string

    The provider's id for this call, which a tool result answers and resume names.

    name: string

    The tool's name, as registered.

    Settings
    Member Visibility

    On This Page
    experimental