Skip to content

Commit ad67361

Browse files
examonCopilot
andauthored
docs: correct the Python and Go event data model tip (#2160)
Correct the streaming-events documentation and its docs-style example to describe the per-event payload types used by Python and Go. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f6fea8d commit ad67361

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

.github/instructions/docs-style.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ When a callout applies to a specific language, put the qualifier as bold text in
4949

5050
```markdown
5151
> [!TIP]
52-
> **(Python / Go)** These SDKs use a single `Data` class/struct with all fields optional.
52+
> **(Python / Go)** These SDKs use separate, per-event data types.
5353
```
5454

5555
## Lists

docs/features/streaming-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ session.on(AssistantMessageDeltaEvent.class, event ->
210210
</details>
211211

212212
> [!TIP]
213-
> **(Python / Go)** These SDKs use a single `Data` class/struct with all possible fields as optional/nullable. Only the fields listed in the tables below are populated for each event type—the rest will be `None` / `nil`.
213+
> **(Python / Go)** These SDKs use separate, per-event data types (for example, `AssistantMessageDeltaData`), so only the relevant fields exist on each type.
214214
>
215215
> [!TIP]
216216
> **(.NET)** The .NET SDK uses separate, strongly-typed data classes per event (e.g., `AssistantMessageDeltaData`), so only the relevant fields exist on each type.

0 commit comments

Comments
 (0)