Skip to content

Commit ec168a3

Browse files
authored
docs: correct the ephemeral labels on four persisted session events (#2172)
docs/features/streaming-events.md marks permission.requested, permission.completed, external_tool.requested and external_tool.completed as "Ephemeral.", which that file defines as not persisted to the session event log and not replayed on session resume. All four are persisted: sessions record them in the event log, and they are still present in a resumed session's history. The labels were accurate when the guide was written in #717. #1177 regenerated the event types so that none of these four still declares a required `ephemeral: true`, but the prose was not updated with them. Remove the classification from the four event sections, the two permission entries in the turn-flow diagram, and the four summary-table rows, matching the convention the file already uses for persisted events, which carry no marker. Co-authored-by: examon <examon@users.noreply.github.com>
1 parent 6b6f631 commit ec168a3

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/features/streaming-events.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ These events are emitted when the agent needs approval or input from the user be
661661

662662
### `permission.requested`
663663

664-
Ephemeral. The agent needs permission to perform an action (run a command, write a file, etc.).
664+
The agent needs permission to perform an action (run a command, write a file, etc.).
665665

666666
| Data Field | Type | Required | Description |
667667
|------------|------|----------|-------------|
@@ -684,7 +684,7 @@ All `kind` variants also include an optional `toolCallId` linking back to the to
684684

685685
### `permission.completed`
686686

687-
Ephemeral. A permission request was resolved.
687+
A permission request was resolved.
688688

689689
| Data Field | Type | Required | Description |
690690
|------------|------|----------|-------------|
@@ -835,7 +835,7 @@ A system or developer prompt was injected into the conversation.
835835

836836
### `external_tool.requested`
837837

838-
Ephemeral. The agent wants to invoke an external tool (one provided by the SDK consumer).
838+
The agent wants to invoke an external tool (one provided by the SDK consumer).
839839

840840
| Data Field | Type | Required | Description |
841841
|------------|------|----------|-------------|
@@ -847,7 +847,7 @@ Ephemeral. The agent wants to invoke an external tool (one provided by the SDK c
847847

848848
### `external_tool.completed`
849849

850-
Ephemeral. An external tool request was resolved.
850+
An external tool request was resolved.
851851

852852
| Data Field | Type | Required | Description |
853853
|------------|------|----------|-------------|
@@ -925,8 +925,8 @@ assistant.turn_start → Turn begins
925925
├── assistant.usage → Token usage for this API call (ephemeral)
926926
927927
├── [If tools were requested:]
928-
│ ├── permission.requested → Needs user approval (ephemeral)
929-
│ ├── permission.completed → Approval result (ephemeral)
928+
│ ├── permission.requested → Needs user approval
929+
│ ├── permission.completed → Approval result
930930
│ ├── tool.execution_start → Tool begins
931931
│ ├── tool.execution_partial_result → Streaming tool output (ephemeral, repeated)
932932
│ ├── tool.execution_progress → Progress updates (ephemeral, repeated)
@@ -969,8 +969,8 @@ This table lists key `data` payload fields. Common envelope fields are documente
969969
| `session.usage_checkpoint` | | Session | `totalNanoAiu`, `totalPremiumRequests?` |
970970
| `session.task_complete` | | Session | `summary?` |
971971
| `session.shutdown` | | Session | `shutdownType`, `codeChanges`, `modelMetrics` |
972-
| `permission.requested` | | Permission | `requestId`, `permissionRequest` |
973-
| `permission.completed` | | Permission | `requestId`, `result.kind` |
972+
| `permission.requested` | | Permission | `requestId`, `permissionRequest` |
973+
| `permission.completed` | | Permission | `requestId`, `result.kind` |
974974
| `user_input.requested` || User Input | `requestId`, `question`, `choices?` |
975975
| `user_input.completed` || User Input | `requestId` |
976976
| `elicitation.requested` || User Input | `requestId`, `message`, `requestedSchema` |
@@ -984,8 +984,8 @@ This table lists key `data` payload fields. Common envelope fields are documente
984984
| `abort` | | Control | `reason` |
985985
| `user.message` | | User | `content`, `attachments?`, `agentMode?` |
986986
| `system.message` | | System | `content`, `role` |
987-
| `external_tool.requested` | | External Tool | `requestId`, `toolName`, `arguments?` |
988-
| `external_tool.completed` | | External Tool | `requestId` |
987+
| `external_tool.requested` | | External Tool | `requestId`, `toolName`, `arguments?` |
988+
| `external_tool.completed` | | External Tool | `requestId` |
989989
| `command.queued` || Command | `requestId`, `command` |
990990
| `command.completed` || Command | `requestId` |
991991
| `session_limits_exhausted.requested` || Session | `requestId`, `maxAiCredits`, `usedAiCredits` |

0 commit comments

Comments
 (0)