Skip to content

Commit 1c67e77

Browse files
committed
Update documentation
1 parent 7687929 commit 1c67e77

2 files changed

Lines changed: 13 additions & 21 deletions

File tree

docs/ai-python/content/docs/reference/ai/stream.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ If the last input message has `replay=True`, `ai.stream` does not call the
7474
provider. It emits replay tool-end events from the existing assistant message
7575
so resumable agent flows can dispatch the same tool calls again.
7676

77+
`Stream.replay_message` synthesizes stream events from a complete `Message`.
78+
79+
```python
80+
async with ai.Stream.replay_message(message) as stream:
81+
async for event in stream:
82+
...
83+
```
84+
7785
## Errors
7886

7987
If the provider stream ends before a finish event, iteration raises

docs/ai-python/content/docs/reference/events.mdx

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ event-model namespace, and events are Pydantic models.
1010

1111
## Stream Events
1212

13-
Model stream events inherit from `BaseEvent`.
13+
Model stream events inherit from `ModelEvent`.
1414

1515
```python
1616
event.message
@@ -42,16 +42,13 @@ Tool events:
4242
- `BuiltinToolEnd`
4343
- `BuiltinToolResult`
4444

45-
File and hook events:
45+
File events:
4646

4747
- `FileEvent`
48-
- `HookSuspension`
49-
- `HookResolution`
5048

51-
Stream event unions:
49+
Stream event union:
5250

5351
- `Event`
54-
- `DiscriminatedEvent`
5552

5653
## Agent Events
5754

@@ -61,12 +58,11 @@ Agents can emit event values that are not raw provider stream events.
6158
- `PartialToolCallResult`: Carries values yielded by streaming tools and
6259
`yield_from`.
6360
- `HookEvent`: Carries an internal hook message and `HookPart`.
61+
- `RunBlocked`: Emitted when the run is blocked on deferred hooks.
6462

65-
Agent event unions:
63+
Agent event union:
6664

67-
- `AgentMessageEvent`
6865
- `AgentEvent`
69-
- `TerminalEvent`
7066

7167
## Aggregator
7268

@@ -84,15 +80,3 @@ class MyAggregator(ai.events.Aggregator[Item, Result, ModelInput]):
8480

8581
`snapshot()` is the rich value stored in tool results. `get_model_input()` is
8682
the value sent back to the model.
87-
88-
## replay_message_events
89-
90-
`replay_message_events` synthesizes stream events from a complete `Message`.
91-
92-
```python
93-
async for event in ai.events.replay_message_events(message):
94-
...
95-
```
96-
97-
Use it when cached, durable, or test messages need to flow through code that
98-
expects stream events.

0 commit comments

Comments
 (0)