Skip to content

Commit 173b44a

Browse files
authored
docs: fix ReasoningMessageStartEvent role from "assistant" to "reasoning" (#1416)
The docs incorrectly documented the role field as "assistant" but both the TypeScript and Python SDKs use "reasoning". Fixes #1329.
1 parent 7802d72 commit 173b44a

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/concepts/events.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,7 @@ displayed to users (e.g., a summary or partial chain-of-thought).
610610
| Property | Description |
611611
| ----------- | --------------------------------------------- |
612612
| `messageId` | Unique identifier of the message |
613-
| `role` | Role of the reasoning message (`"assistant"`) |
613+
| `role` | Role of the reasoning message (`"reasoning"`) |
614614

615615
### ReasoningMessageContent
616616

docs/concepts/reasoning.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ yield {
149149
yield {
150150
type: "REASONING_MESSAGE_START",
151151
messageId: "msg-123",
152-
role: "assistant",
152+
role: "reasoning",
153153
}
154154

155155
yield {
@@ -205,7 +205,7 @@ yield {
205205
yield {
206206
type: "REASONING_MESSAGE_START",
207207
messageId: "msg-456",
208-
role: "assistant",
208+
role: "reasoning",
209209
}
210210

211211
yield {

docs/sdk/js/core/events.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -429,14 +429,14 @@ the message history.
429429
type ReasoningMessageStartEvent = BaseEvent & {
430430
type: EventType.REASONING_MESSAGE_START
431431
messageId: string
432-
role: "assistant"
432+
role: "reasoning"
433433
}
434434
```
435435
436-
| Property | Type | Description |
437-
| ----------- | ------------- | --------------------------------- |
438-
| `messageId` | `string` | Unique identifier for the message |
439-
| `role` | `"assistant"` | Role is always "assistant" |
436+
| Property | Type | Description |
437+
| ----------- | ------------- | ---------------------------------- |
438+
| `messageId` | `string` | Unique identifier for the message |
439+
| `role` | `"reasoning"` | Role is always "reasoning" |
440440
441441
### ReasoningMessageContentEvent
442442

docs/sdk/python/core/events.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -470,13 +470,13 @@ the message history.
470470
class ReasoningMessageStartEvent(BaseEvent):
471471
type: Literal[EventType.REASONING_MESSAGE_START]
472472
message_id: str
473-
role: Literal["assistant"]
473+
role: Literal["reasoning"]
474474
```
475475

476-
| Property | Type | Description |
477-
| ------------ | ---------------------- | --------------------------------- |
478-
| `message_id` | `str` | Unique identifier for the message |
479-
| `role` | `Literal["assistant"]` | Role is always "assistant" |
476+
| Property | Type | Description |
477+
| ------------ | ----------------------- | --------------------------------- |
478+
| `message_id` | `str` | Unique identifier for the message |
479+
| `role` | `Literal["reasoning"]` | Role is always "reasoning" |
480480

481481
### ReasoningMessageContentEvent
482482

0 commit comments

Comments
 (0)