@@ -48,15 +48,15 @@ shared across all event types.
48
48
``` python
49
49
class BaseEvent (ConfiguredBaseModel ):
50
50
type : EventType
51
- timestamp: Optional[ int ] = None
52
- raw_event: Optional[ Any] = None
51
+ timestamp: int | None = None
52
+ raw_event: Any = None
53
53
```
54
54
55
55
| Property | Type | Description |
56
56
| ----------- | --------------- | ----------------------------------------------------- |
57
57
| ` type ` | ` EventType ` | The type of event (discriminator field for the union) |
58
- | ` timestamp ` | ` Optional[ int] ` | Timestamp when the event was created |
59
- | ` raw_event ` | ` Optional[ Any] ` | Original event data if this event was transformed |
58
+ | ` timestamp ` | `int | None` | Timestamp when the event was created |
59
+ | ` raw_event ` | ` Any ` | Original event data if this event was transformed |
60
60
61
61
## Lifecycle Events
62
62
@@ -91,14 +91,14 @@ class RunFinishedEvent(BaseEvent):
91
91
type : Literal[EventType.RUN_FINISHED ]
92
92
thread_id: str
93
93
run_id: str
94
- result: Optional[ Any] = None
94
+ result: Any = None
95
95
```
96
96
97
97
| Property | Type | Description |
98
98
| ----------- | --------------- | ------------------------------ |
99
99
| ` thread_id ` | ` str ` | ID of the conversation thread |
100
100
| ` run_id ` | ` str ` | ID of the agent run |
101
- | ` result ` | ` Optional[ Any] ` | Result data from the agent run |
101
+ | ` result ` | ` Any ` | Result data from the agent run |
102
102
103
103
### RunErrorEvent
104
104
@@ -110,13 +110,13 @@ Signals an error during an agent run.
110
110
class RunErrorEvent (BaseEvent ):
111
111
type : Literal[EventType.RUN_ERROR ]
112
112
message: str
113
- code: Optional[ str ] = None
113
+ code: str | None = None
114
114
```
115
115
116
116
| Property | Type | Description |
117
117
| --------- | --------------- | ------------- |
118
118
| ` message ` | ` str ` | Error message |
119
- | ` code ` | ` Optional[ str] ` | Error code |
119
+ | ` code ` | `str | None` | Error code |
120
120
121
121
### StepStartedEvent
122
122
@@ -225,14 +225,14 @@ class ToolCallStartEvent(BaseEvent):
225
225
type : Literal[EventType.TOOL_CALL_START ]
226
226
tool_call_id: str
227
227
tool_call_name: str
228
- parent_message_id: Optional[ str ] = None
228
+ parent_message_id: str | None = None
229
229
```
230
230
231
231
| Property | Type | Description |
232
232
| ------------------- | --------------- | ----------------------------------- |
233
233
| ` tool_call_id ` | ` str ` | Unique identifier for the tool call |
234
234
| ` tool_call_name ` | ` str ` | Name of the tool being called |
235
- | ` parent_message_id ` | ` Optional[ str] ` | ID of the parent message |
235
+ | ` parent_message_id ` | `str | None` | ID of the parent message |
236
236
237
237
### ToolCallArgsEvent
238
238
@@ -280,15 +280,15 @@ class ToolCallResultEvent(BaseEvent):
280
280
type : Literal[EventType.TOOL_CALL_RESULT ]
281
281
tool_call_id: str
282
282
content: str
283
- role: Optional[ Literal[" tool" ]] = None
283
+ role: Literal[" tool" ] | None = None
284
284
```
285
285
286
286
| Property | Type | Description |
287
287
| -------------- | --------------------------- | ----------------------------------------------------------- |
288
288
| ` message_id ` | ` str ` | ID of the conversation message this result belongs to |
289
289
| ` tool_call_id ` | ` str ` | Matches the ID from the corresponding ToolCallStartEvent |
290
290
| ` content ` | ` str ` | The actual result/output content from the tool execution |
291
- | ` role ` | ` Optional[ Literal["tool"]] ` | Optional role identifier, typically "tool" for tool results |
291
+ | ` role ` | `Literal[ "tool"] | None` | Optional role identifier, typically "tool" for tool results |
292
292
293
293
## State Management Events
294
294
@@ -354,13 +354,13 @@ Used to pass through events from external systems.
354
354
class RawEvent (BaseEvent ):
355
355
type : Literal[EventType.RAW ]
356
356
event: Any
357
- source: Optional[ str ] = None
357
+ source: str | None = None
358
358
```
359
359
360
360
| Property | Type | Description |
361
361
| -------- | --------------- | ------------------- |
362
362
| ` event ` | ` Any ` | Original event data |
363
- | ` source ` | ` Optional[ str] ` | Source of the event |
363
+ | ` source ` | `str | None` | Source of the event |
364
364
365
365
### CustomEvent
366
366
@@ -388,25 +388,27 @@ The SDK uses Pydantic's discriminated unions for event validation:
388
388
389
389
``` python
390
390
Event = Annotated[
391
- Union[
392
- TextMessageStartEvent,
393
- TextMessageContentEvent,
394
- TextMessageEndEvent,
395
- ToolCallStartEvent,
396
- ToolCallArgsEvent,
397
- ToolCallEndEvent,
398
- ToolCallResultEvent,
399
- StateSnapshotEvent,
400
- StateDeltaEvent,
401
- MessagesSnapshotEvent,
402
- RawEvent,
403
- CustomEvent,
404
- RunStartedEvent,
405
- RunFinishedEvent,
406
- RunErrorEvent,
407
- StepStartedEvent,
408
- StepFinishedEvent,
409
- ],
391
+ TextMessageStartEvent |
392
+ TextMessageContentEvent |
393
+ TextMessageEndEvent |
394
+ TextMessageChunkEvent |
395
+ ToolCallStartEvent |
396
+ ToolCallArgsEvent |
397
+ ToolCallEndEvent |
398
+ ToolCallChunkEvent |
399
+ ToolCallResultEvent |
400
+ ThinkingStartEvent |
401
+ ThinkingEndEvent |
402
+ StateSnapshotEvent |
403
+ StateDeltaEvent |
404
+ MessagesSnapshotEvent |
405
+ RawEvent |
406
+ CustomEvent |
407
+ RunStartedEvent |
408
+ RunFinishedEvent |
409
+ RunErrorEvent |
410
+ StepStartedEvent |
411
+ StepFinishedEvent,
410
412
Field(discriminator = " type" )
411
413
]
412
414
```
0 commit comments