Process agent responses, tool calls and results in real-time through streaming or handlers.
Stream
enum. Here, we return only content updates:
Stream.ALL
: All events (equivalent to stream=True
)Stream.CONTENT
: Agent content and content deltasStream.TOOLS
: All tool eventsStream.COMPLETION_TOOLS
: Completion tool events (like marking a task successful or failed)Stream.AGENT_TOOLS
: Tools used by agents for any purpose other than completing a taskStream.TASK_EVENTS
: Task lifecycle events (starting, completion, failure, etc)|
operator:
on_<event-name>
methods for each event type. For a complete list of available methods, see the Event Details section below.
AsyncHandler
:
TaskStart
: A task has begun executionTaskSuccess
: A task completed successfully (includes the final result)TaskFailure
: A task failed (includes the error reason)TaskSkipped
: A task was skippedOrchestratorStart
/End
: Workflow orchestration starting/endingAgentTurnStart
/End
: An agent’s turn starting/endingOrchestratorError
: An error occurred during orchestrationMethod | Event Type | Description |
---|---|---|
on_event(event) | Any | Called for every event, before any specific handler |
on_agent_message(event) | AgentMessage | Raw LLM output containing both content and tool calls |
on_agent_message_delta(event) | AgentMessageDelta | Incremental updates to raw LLM output |
on_agent_content(event) | AgentContent | Unstructured text output from an agent |
on_agent_content_delta(event) | AgentContentDelta | Incremental updates to agent content |
on_agent_tool_call(event) | AgentToolCall | Tool being called by an agent |
on_agent_tool_call_delta(event) | AgentToolCallDelta | Incremental updates to a tool call |
on_tool_result(event) | ToolResult | Result returned from a tool |
on_orchestrator_start(event) | OrchestratorStart | Workflow orchestration starting |
on_orchestrator_end(event) | OrchestratorEnd | Workflow orchestration completed |
on_agent_turn_start(event) | AgentTurnStart | An agent beginning their turn |
on_agent_turn_end(event) | AgentTurnEnd | An agent completing their turn |
on_orchestrator_error(event) | OrchestratorError | Error during orchestration |
on_agent_message
on_agent_content
on_agent_tool_call