Skip to content

Commit ebfb5e4

Browse files
Add comprehensive event types table to custom visualizer documentation
Add a table overview of all event types handled by the default visualizer before diving into detailed descriptions. This provides a quick reference for developers to understand the complete event system. Co-authored-by: openhands <[email protected]>
1 parent 88c6064 commit ebfb5e4

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

sdk/guides/convo-custom-visualizer.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,19 @@ class MinimalProgressVisualizer(ConversationVisualizer):
297297

298298
## Key Event Types
299299

300-
Understanding the event system is crucial for effective custom visualizers:
300+
Understanding the event system is crucial for effective custom visualizers. Here's a comprehensive overview of all event types handled by the default visualizer:
301+
302+
| Event Type | Description | Key Properties | When It Occurs |
303+
|------------|-------------|----------------|----------------|
304+
| `SystemPromptEvent` | System-level prompts and instructions | `content`, `source` | Agent initialization, system messages |
305+
| `ActionEvent` | Agent actions and tool calls | `action`, `tool_name`, `llm_response_id` | When agent decides to take an action |
306+
| `ObservationEvent` | Results from executed actions | `observation`, `source` | After action execution completes |
307+
| `MessageEvent` | LLM messages (user/assistant) | `llm_message` (role, content) | User input, agent responses |
308+
| `AgentErrorEvent` | Error conditions and failures | `error`, `source` | When agent encounters errors |
309+
| `PauseEvent` | User-initiated pauses | `source` | When user pauses conversation |
310+
| `Condensation` | Memory condensation events | `content`, `source` | During conversation memory management |
311+
312+
### Detailed Event Descriptions
301313

302314
### ActionEvent
303315
Fired when the agent decides to use a tool or take an action.

0 commit comments

Comments
 (0)