ExAthena.Streaming (ExAthena v0.4.1)

Copy Markdown View Source

Canonical streaming event types and the broadcaster helper.

Providers emit events as tokens arrive. The ExAthena facade forwards them to the user-supplied callback. Phase 2 (agent loop) also consumes these events to build up tool-call requests and decide when to stop.

Summary

Functions

Emit a terminal error event.

Emit a terminal stop event.

Emit a text-delta event.

Emit a tool-call argument delta.

Emit a final tool-call event with the complete ToolCall.

Emit a start-of-tool-call event with a partial ToolCall.

Emit a usage-accounting event.

Functions

error(callback, err)

Emit a terminal error event.

stop(callback, reason)

Emit a terminal stop event.

text_delta(callback, text)

Emit a text-delta event.

tool_call_delta(callback, index, delta)

Emit a tool-call argument delta.

tool_call_end(callback, index, tool_call)

Emit a final tool-call event with the complete ToolCall.

tool_call_start(callback, index, partial)

Emit a start-of-tool-call event with a partial ToolCall.

usage(callback, usage)

Emit a usage-accounting event.