You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Fix model name inconsistency in documentation
* Fix callback event documentation inaccuracies
Correct the documentation to accurately reflect which callback events
are supported by each streaming type:
- Object: on_start, on_complete, on_update
- List: on_start, on_complete, on_append
- String: on_start, on_complete, on_append
- Atom: on_start, on_complete
Previously, documentation incorrectly suggested all types support
on_append, on_update, and on_complete uniformly.
* fix: preserve the original sentence
Copy file name to clipboardExpand all lines: docs/api/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The parser module contains streaming-aware data types and the core parser for pr
16
16
17
17
### Key Features
18
18
19
-
-**Event Callbacks**: All streaming types support `on_start`, `on_append`, and `on_complete` callbacks
19
+
-**Event Callbacks**: All streaming types support `on_start` and `on_complete` callbacks. Additionally, `Object` supports `on_update`, while `List`and `String` support `on_append`
20
20
-**Type Safety**: Full type hints and generic support for compile-time checking
21
21
-**Pydantic Integration**: Convert streaming models to Pydantic models via `to_pydantic()`
0 commit comments