@github/copilot-sdk 1.0.14 → 1.0.15-preview.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,7 +9,7 @@ export type JsonValue = null | boolean | number | string | JsonValue[] | {
9
9
  /**
10
10
  * Union of all session event variants emitted by the Copilot CLI runtime.
11
11
  */
12
- export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | AutoTierRecommendationEvent | AutoTierSwitchFailedEvent | ModeChangedEvent | ModeNoticeDeliveredEvent | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | CompletionReceiptEvent | FusionRouteStartedEvent | FusionRouteFailedEvent | FusionResolvedEvent | FusionCompletedEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantFusionPhaseStartedEvent | AssistantFusionPhaseActivityEvent | AssistantFusionPhaseCompletedEvent | AssistantFusionPhaseFailedEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | ModelCallFinishedEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | ToolSearchActivatedEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentConfiguredEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | PermissionCarriedForwardEvent | PermissionMessageAuthorizationEvent | PermissionMessageAuthorizationReadEvent | PermissionMessageAuthorizationDegradedEvent | PermissionAssentDetectedEvent | PermissionContextualAuthorizationEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | UIEphemeralQueryEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | AutoModeResolvedEvent | ManagedSettingsResolvedEvent | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | FactoryRunUpdatedEvent | FactoryRunStartedEvent | FactoryRunSettledEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | McpServerRemovedEvent | McpServerNeedsReconnectEvent | McpToolsListChangedEvent | McpResourcesListChangedEvent | McpPromptsListChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
12
+ export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | IndexedSearchEvent | WarningEvent | ModelChangeEvent | ModelDeselectedEvent | AutoTierRecommendationEvent | AutoTierSwitchFailedEvent | ModeChangedEvent | ModeNoticeDeliveredEvent | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | CompletionReceiptEvent | FusionRouteStartedEvent | FusionRouteFailedEvent | FusionResolvedEvent | FusionCompletedEvent | PermissionRecoveryEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantFusionPhaseStartedEvent | AssistantFusionPhaseActivityEvent | AssistantFusionPhaseCompletedEvent | AssistantFusionPhaseFailedEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | ModelCallFinishedEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | ToolSearchActivatedEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentConfiguredEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | PermissionCarriedForwardEvent | PermissionMessageAuthorizationEvent | PermissionMessageAuthorizationReadEvent | PermissionMessageAuthorizationDegradedEvent | PermissionAssentDetectedEvent | PermissionContextualAuthorizationEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | UIEphemeralQueryEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | AutoModeResolvedEvent | ManagedSettingsResolvedEvent | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | FactoryRunUpdatedEvent | FactoryRunStartedEvent | FactoryRunSettledEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | McpServerRemovedEvent | McpServerNeedsReconnectEvent | McpToolsListChangedEvent | McpResourcesListChangedEvent | McpPromptsListChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
13
13
  /**
14
14
  * Routing preference used when the session model is `auto`. `fast` is an integrator-only latency preset and is not a first-party GitHub Copilot product preference.
15
15
  */
@@ -112,6 +112,165 @@ export type AutopilotObjectiveChangedStatus =
112
112
  | "cap_reached"
113
113
  /** Objective was completed by the agent. */
114
114
  | "completed";
115
+ /**
116
+ * Transient indexed-search status and diagnostics from the live runtime service. Never persisted or used to infer activation from session history.
117
+ */
118
+ export type IndexedSearchData = {
119
+ /**
120
+ * Indexed-search event variant discriminator.
121
+ */
122
+ kind: "status";
123
+ state: IndexedSearchState;
124
+ } | {
125
+ disabledReason?: IndexedSearchDisabledReason;
126
+ /**
127
+ * Whether the repository meets the automatic indexing file-count threshold, when known.
128
+ */
129
+ eligible?: boolean;
130
+ /**
131
+ * Startup failure details. May contain sensitive user data; restricted telemetry only.
132
+ */
133
+ errorMessage?: string;
134
+ /**
135
+ * Number of text files counted in the repository.
136
+ */
137
+ fileCount?: number;
138
+ /**
139
+ * Whether indexed search was explicitly enabled through the environment.
140
+ */
141
+ forcedByEnv: boolean;
142
+ /**
143
+ * Indexed-search event variant discriminator.
144
+ */
145
+ kind: "startup";
146
+ outcome: IndexedSearchOutcome;
147
+ /**
148
+ * Wall-clock duration of startup in milliseconds.
149
+ */
150
+ startupDurationMs: number;
151
+ /**
152
+ * Whether waiting for index readiness was requested, including skipped attempts.
153
+ */
154
+ warmStart: boolean;
155
+ } | {
156
+ /**
157
+ * Server failure details. May contain sensitive user data; restricted telemetry only.
158
+ */
159
+ errorMessage?: string;
160
+ errorType: IndexedSearchErrorType;
161
+ /**
162
+ * Process exit code, when available.
163
+ */
164
+ exitCode?: number;
165
+ /**
166
+ * Indexed-search event variant discriminator.
167
+ */
168
+ kind: "server_error";
169
+ } | {
170
+ /**
171
+ * Number of added files.
172
+ */
173
+ addedFileCount?: number;
174
+ /**
175
+ * Number of modified files.
176
+ */
177
+ changedFileCount?: number;
178
+ /**
179
+ * Number of deleted files.
180
+ */
181
+ deletedFileCount?: number;
182
+ /**
183
+ * Indexed-search event variant discriminator.
184
+ */
185
+ kind: "incremental";
186
+ phase: IndexedSearchIncrementalPhase;
187
+ /**
188
+ * Total number of detected changes.
189
+ */
190
+ totalChangeCount?: number;
191
+ /**
192
+ * Total incremental indexing duration in milliseconds.
193
+ */
194
+ totalDurationMs?: number;
195
+ /**
196
+ * Index update duration in milliseconds.
197
+ */
198
+ updateDurationMs?: number;
199
+ /**
200
+ * Workspace scan duration in milliseconds.
201
+ */
202
+ walkDurationMs?: number;
203
+ };
204
+ /**
205
+ * Live indexed-search state for this session activation, never inferred from persisted history.
206
+ */
207
+ export type IndexedSearchState =
208
+ /** Indexed search is not active for this session. */
209
+ "disabled"
210
+ /** Indexed-search startup is in progress. */
211
+ | "starting"
212
+ /** The indexed-search server started successfully; its index may still be warming. */
213
+ | "enabled"
214
+ /** The indexed-search server and its index are ready. */
215
+ | "ready"
216
+ /** Indexed-search startup or the active server failed. */
217
+ | "failed";
218
+ /**
219
+ * Configuration, policy, or workspace condition that disabled indexed search.
220
+ */
221
+ export type IndexedSearchDisabledReason =
222
+ /** Indexed search was explicitly disabled by the environment. */
223
+ "use_tgrep_false"
224
+ /** Search uses the external ripgrep binary instead of bundled search. */
225
+ | "use_builtin_ripgrep_false"
226
+ /** Organization policy disables indexed search. */
227
+ | "organization"
228
+ /** Authentication has not resolved organization policy. */
229
+ | "organization_policy_auth_pending"
230
+ /** Organization policy could not be determined. */
231
+ | "organization_policy_unknown"
232
+ /** The workspace uses a virtualized or network filesystem. */
233
+ | "virtual_filesystem"
234
+ /** The workspace is inside a Windows cloud-sync root. */
235
+ | "cloud_sync_root"
236
+ /** The Windows cloud-sync safety check failed. */
237
+ | "cloud_sync_detection_failed"
238
+ /** The workspace is not available on the runtime's local filesystem. */
239
+ | "workspace_not_local";
240
+ /**
241
+ * Result of an indexed-search startup attempt.
242
+ */
243
+ export type IndexedSearchOutcome =
244
+ /** A new indexed-search server was started. */
245
+ "started"
246
+ /** The repository has too few files for automatic indexing. */
247
+ | "skipped_below_threshold"
248
+ /** No Git repository was found and indexing was not forced. */
249
+ | "skipped_no_gitroot"
250
+ /** Configuration, policy, or workspace safety disabled indexing. */
251
+ | "skipped_disabled"
252
+ /** An existing indexed-search server was reused. */
253
+ | "reused_existing"
254
+ /** The startup attempt failed. */
255
+ | "failed";
256
+ /**
257
+ * Category of an indexed-search server failure.
258
+ */
259
+ export type IndexedSearchErrorType =
260
+ /** The indexed-search server could not be spawned. */
261
+ "spawn_error"
262
+ /** The indexed-search server exited unexpectedly. */
263
+ | "unexpected_exit"
264
+ /** The indexed-search server was terminated by a signal. */
265
+ | "killed_by_signal";
266
+ /**
267
+ * Phase of an incremental indexed-search update.
268
+ */
269
+ export type IndexedSearchIncrementalPhase =
270
+ /** A workspace scan found changes to index. */
271
+ "changes_detected"
272
+ /** The incremental index update completed. */
273
+ | "updated";
115
274
  /**
116
275
  * Origin of an effective session model change.
117
276
  */
@@ -136,8 +295,16 @@ export type ModelChangeSource =
136
295
  | "plan_mode"
137
296
  /** The runtime selected the model automatically, such as rate-limit recovery or refusal fallback. */
138
297
  | "automatic"
298
+ /** The user selected the promoted model from the changeboarding card or its keyboard shortcut. */
299
+ | "changeboarding_shortcut"
139
300
  /** An SDK or RPC caller selected the model. */
140
301
  | "sdk";
302
+ /**
303
+ * Why the session no longer has an explicitly selected model.
304
+ */
305
+ export type ModelDeselectedReason =
306
+ /** A host-managed provider snapshot no longer publishes the selected model. */
307
+ "provider_withdrawn";
141
308
  /**
142
309
  * Auto preferences that Copilot API can recommend.
143
310
  */
@@ -219,6 +386,94 @@ export type CompactionTrigger =
219
386
  | "memory_pressure"
220
387
  /** Compaction requested while switching to a model with a smaller context window. */
221
388
  | "model_switch";
389
+ /**
390
+ * Category of structured task blocker
391
+ */
392
+ export type TaskBlockerKind =
393
+ /** Autopilot permission recovery requires intervention or has no safe autonomous path. */
394
+ "permission_recovery";
395
+ /**
396
+ * Runtime handling applied to a recovery attempt
397
+ */
398
+ export type PermissionRecoveryAttemptDisposition =
399
+ /** The request was denied without prompting so the agent could try an alternative. */
400
+ "deferred"
401
+ /** The request was surfaced to an interactive responder. */
402
+ | "prompted"
403
+ /** The interactive responder approved the request. */
404
+ | "approved"
405
+ /** The interactive responder denied the request or became unavailable. */
406
+ | "denied"
407
+ /** The request exhausted unattended recovery and produced a blocked outcome. */
408
+ | "blocked"
409
+ /** A tool call succeeded as an equivalent alternative. */
410
+ | "succeeded";
411
+ /**
412
+ * Controlled reason for an individual attempt disposition
413
+ */
414
+ export type PermissionRecoveryAttemptReason =
415
+ /** The attempt required permission that Assisted Permissions could not grant. */
416
+ "permission_required"
417
+ /** The request repeated an earlier attempt. */
418
+ | "repeated_attempt"
419
+ /** The request exceeded the bounded number of distinct attempts. */
420
+ | "attempts_exhausted"
421
+ /** The interactive responder approved the request. */
422
+ | "permission_approved"
423
+ /** The interactive responder denied the request. */
424
+ | "permission_denied"
425
+ /** The interactive responder became unavailable. */
426
+ | "responder_unavailable"
427
+ /** The tool call succeeded without the blocked permission. */
428
+ | "equivalent_alternative_succeeded";
429
+ /**
430
+ * Relationship of an attempt to earlier permission requests
431
+ */
432
+ export type PermissionRecoveryAttemptRelation =
433
+ /** The first denied permission request in the episode. */
434
+ "initial"
435
+ /** A request equivalent to an earlier attempt. */
436
+ | "retry"
437
+ /** A distinct request or a successful alternative tool call. */
438
+ | "alternative";
439
+ /**
440
+ * Action selected when autonomous recovery cannot continue
441
+ */
442
+ export type PermissionRecoveryOnBlocked =
443
+ /** Surface the existing permission prompt to a response-capable client. */
444
+ "ask"
445
+ /** Return a structured unsuccessful blocked outcome because no responder is available. */
446
+ | "fail";
447
+ /**
448
+ * Controlled reason for a permission-recovery episode transition
449
+ */
450
+ export type PermissionRecoveryReason =
451
+ /** An action required permission that Assisted Permissions could not grant. */
452
+ "permission_required"
453
+ /** The agent repeated an equivalent permission request instead of making progress. */
454
+ | "repeated_attempt"
455
+ /** The bounded number of distinct permission attempts was exhausted. */
456
+ | "attempts_exhausted"
457
+ /** A responder approved the escalated permission request. */
458
+ | "permission_approved"
459
+ /** A responder denied the escalated permission request. */
460
+ | "permission_denied"
461
+ /** The response-capable client became unavailable while escalation was pending. */
462
+ | "responder_unavailable"
463
+ /** A later tool call succeeded without requiring the blocked permission. */
464
+ | "equivalent_alternative_succeeded";
465
+ /**
466
+ * Lifecycle state of a permission-recovery episode
467
+ */
468
+ export type PermissionRecoveryStatus =
469
+ /** Autopilot may try a bounded equivalent alternative. */
470
+ "recovering"
471
+ /** An interactive permission response is required. */
472
+ | "awaiting_approval"
473
+ /** The episode ended through approval or a successful equivalent alternative. */
474
+ | "resolved"
475
+ /** No autonomous path remains and the task requires intervention. */
476
+ | "blocked";
222
477
  /**
223
478
  * Semantic result of evaluating a task completion request
224
479
  */
@@ -1706,6 +1961,36 @@ export interface InfoData {
1706
1961
  */
1707
1962
  url?: string;
1708
1963
  }
1964
+ /**
1965
+ * Session event "session.indexed_search". Transient indexed-search status and diagnostics from the live runtime service. Never persisted or used to infer activation from session history.
1966
+ */
1967
+ export interface IndexedSearchEvent {
1968
+ /**
1969
+ * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
1970
+ */
1971
+ agentId?: string;
1972
+ data: IndexedSearchData;
1973
+ /**
1974
+ * Always true for events that are transient and not persisted to the session event log on disk.
1975
+ */
1976
+ ephemeral: true;
1977
+ /**
1978
+ * Unique event identifier (UUID v4), generated when the event is emitted
1979
+ */
1980
+ id: string;
1981
+ /**
1982
+ * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
1983
+ */
1984
+ parentId: string | null;
1985
+ /**
1986
+ * ISO 8601 timestamp when the event was created
1987
+ */
1988
+ timestamp: string;
1989
+ /**
1990
+ * Type discriminator. Always "session.indexed_search".
1991
+ */
1992
+ type: "session.indexed_search";
1993
+ }
1709
1994
  /**
1710
1995
  * Session event "session.warning". Warning message for timeline display with categorization
1711
1996
  */
@@ -1823,6 +2108,46 @@ export interface ModelChangeData {
1823
2108
  source?: ModelChangeSource;
1824
2109
  verbosity?: Verbosity;
1825
2110
  }
2111
+ /**
2112
+ * Session event "session.model_deselected". The model the user had explicitly selected is no longer available, because the host that published it withdrew it, so the session no longer has an explicit selection. The next turn resolves a default as though the user had never chosen a model. Clients should stop presenting the previous model as selected. This event is durable because resume rebuilds the selected model from the event log; without it a resumed session would restore a model its provider no longer serves. Reasoning effort, verbosity, and other session-level preferences are deliberately unchanged, because they belong to the session rather than to the model.
2113
+ */
2114
+ export interface ModelDeselectedEvent {
2115
+ /**
2116
+ * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
2117
+ */
2118
+ agentId?: string;
2119
+ data: ModelDeselectedData;
2120
+ /**
2121
+ * When true, the event is transient and not persisted to the session event log on disk
2122
+ */
2123
+ ephemeral?: boolean;
2124
+ /**
2125
+ * Unique event identifier (UUID v4), generated when the event is emitted
2126
+ */
2127
+ id: string;
2128
+ /**
2129
+ * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
2130
+ */
2131
+ parentId: string | null;
2132
+ /**
2133
+ * ISO 8601 timestamp when the event was created
2134
+ */
2135
+ timestamp: string;
2136
+ /**
2137
+ * Type discriminator. Always "session.model_deselected".
2138
+ */
2139
+ type: "session.model_deselected";
2140
+ }
2141
+ /**
2142
+ * The model the user had explicitly selected is no longer available, because the host that published it withdrew it, so the session no longer has an explicit selection. The next turn resolves a default as though the user had never chosen a model. Clients should stop presenting the previous model as selected. This event is durable because resume rebuilds the selected model from the event log; without it a resumed session would restore a model its provider no longer serves. Reasoning effort, verbosity, and other session-level preferences are deliberately unchanged, because they belong to the session rather than to the model.
2143
+ */
2144
+ export interface ModelDeselectedData {
2145
+ /**
2146
+ * Model that was selected before the host withdrew it.
2147
+ */
2148
+ previousModel: string;
2149
+ reason: ModelDeselectedReason;
2150
+ }
1826
2151
  /**
1827
2152
  * Session event "session.auto_tier_recommendation". Live-only Auto preference recommendation from Copilot API after a successful Auto model call.
1828
2153
  */
@@ -2902,6 +3227,7 @@ export interface CompactionCompleteData {
2902
3227
  * GitHub request tracing ID (x-github-request-id header) for the compaction LLM call
2903
3228
  */
2904
3229
  requestId?: string;
3230
+ responsesReasoning?: ResponsesReasoning;
2905
3231
  /**
2906
3232
  * Copilot service request ID (x-copilot-service-request-id header) for the compaction LLM call
2907
3233
  */
@@ -2990,6 +3316,23 @@ export interface CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail {
2990
3316
  */
2991
3317
  tokenType: string;
2992
3318
  }
3319
+ /**
3320
+ * Original request-level and effective conversation reasoning effort for a Responses history boundary
3321
+ */
3322
+ export interface ResponsesReasoning {
3323
+ /**
3324
+ * Effective effort selected before this message, independent of the response-level reasoning field
3325
+ */
3326
+ effort: string;
3327
+ /**
3328
+ * Original request-level effort, retained while replaying this conversation prefix
3329
+ */
3330
+ initialEffort: string;
3331
+ /**
3332
+ * Provider model whose reasoning settings this boundary records
3333
+ */
3334
+ model: string;
3335
+ }
2993
3336
  /**
2994
3337
  * Session event "session.task_complete". Task completion notification with summary from the agent
2995
3338
  */
@@ -3024,6 +3367,7 @@ export interface TaskCompleteEvent {
3024
3367
  * Task completion notification with summary from the agent
3025
3368
  */
3026
3369
  export interface TaskCompleteData {
3370
+ blocker?: TaskBlocker;
3027
3371
  /**
3028
3372
  * Active autopilot objective ID evaluated by the completion reviewer
3029
3373
  */
@@ -3042,6 +3386,64 @@ export interface TaskCompleteData {
3042
3386
  */
3043
3387
  summary?: string;
3044
3388
  }
3389
+ /**
3390
+ * Structured reason that the task cannot continue without intervention
3391
+ */
3392
+ /** @experimental */
3393
+ export interface TaskBlocker {
3394
+ kind: TaskBlockerKind;
3395
+ permissionRecovery: PermissionRecoveryData;
3396
+ reason: PermissionRecoveryReason;
3397
+ /**
3398
+ * Whether a later user response or steering message can resume the task
3399
+ */
3400
+ resumable: boolean;
3401
+ }
3402
+ /**
3403
+ * Authoritative snapshot of an Autopilot permission-recovery episode
3404
+ */
3405
+ export interface PermissionRecoveryData {
3406
+ /**
3407
+ * Ordered privacy-safe record of permission attempts and the successful alternative, when any
3408
+ */
3409
+ attempts: PermissionRecoveryAttempt[];
3410
+ /**
3411
+ * Stable identifier shared by every transition in this recovery episode
3412
+ */
3413
+ episodeId: string;
3414
+ /**
3415
+ * Maximum number of distinct autonomous permission attempts allowed before escalation
3416
+ */
3417
+ maxAttempts: number;
3418
+ onBlocked: PermissionRecoveryOnBlocked;
3419
+ reason: PermissionRecoveryReason;
3420
+ status: PermissionRecoveryStatus;
3421
+ }
3422
+ export interface PermissionRecoveryAttempt {
3423
+ /**
3424
+ * Unique identifier for this attempt record
3425
+ */
3426
+ attemptId: string;
3427
+ disposition: PermissionRecoveryAttemptDisposition;
3428
+ /**
3429
+ * One-based position of this attempt in the episode
3430
+ */
3431
+ ordinal: number;
3432
+ /**
3433
+ * Controlled permission request kind, such as shell, path, URL, or tool
3434
+ */
3435
+ permissionKind: string;
3436
+ reason: PermissionRecoveryAttemptReason;
3437
+ relation: PermissionRecoveryAttemptRelation;
3438
+ /**
3439
+ * SHA-256 fingerprint of normalized request data; raw permission arguments are not included
3440
+ */
3441
+ requestFingerprint: string;
3442
+ /**
3443
+ * Tool-call identifier associated with this attempt, when available
3444
+ */
3445
+ toolCallId?: string;
3446
+ }
3045
3447
  /**
3046
3448
  * Session event "session.completion_receipt". Behavior-neutral record of structured runtime facts present when an agent completion decision is accepted.
3047
3449
  */
@@ -3514,6 +3916,36 @@ export interface FusionCompletedData {
3514
3916
  */
3515
3917
  turnId: string;
3516
3918
  }
3919
+ /**
3920
+ * Session event "session.permission_recovery". Authoritative snapshot of an Autopilot permission-recovery episode
3921
+ */
3922
+ export interface PermissionRecoveryEvent {
3923
+ /**
3924
+ * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
3925
+ */
3926
+ agentId?: string;
3927
+ data: PermissionRecoveryData;
3928
+ /**
3929
+ * When true, the event is transient and not persisted to the session event log on disk
3930
+ */
3931
+ ephemeral?: boolean;
3932
+ /**
3933
+ * Unique event identifier (UUID v4), generated when the event is emitted
3934
+ */
3935
+ id: string;
3936
+ /**
3937
+ * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
3938
+ */
3939
+ parentId: string | null;
3940
+ /**
3941
+ * ISO 8601 timestamp when the event was created
3942
+ */
3943
+ timestamp: string;
3944
+ /**
3945
+ * Type discriminator. Always "session.permission_recovery".
3946
+ */
3947
+ type: "session.permission_recovery";
3948
+ }
3517
3949
  /**
3518
3950
  * Session event "user.message". Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs.
3519
3951
  */
@@ -3578,6 +4010,7 @@ export interface UserMessageData {
3578
4010
  * Parent agent task ID for background telemetry correlated to this user turn
3579
4011
  */
3580
4012
  parentAgentTaskId?: string;
4013
+ responsesReasoning?: ResponsesReasoning;
3581
4014
  /**
3582
4015
  * Origin of this message, used for timeline filtering and attribution (e.g., `skill-pdf` for hidden skill injection or `agent-<agent-id>` for an inter-agent prompt)
3583
4016
  */
@@ -5809,6 +6242,10 @@ export interface ToolExecutionStartData {
5809
6242
  * Name of the tool being executed
5810
6243
  */
5811
6244
  toolName: string;
6245
+ /**
6246
+ * Human-readable display title for the tool, when the selected tool descriptor has a non-empty title.
6247
+ */
6248
+ toolTitle?: string;
5812
6249
  /**
5813
6250
  * Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event
5814
6251
  */
@@ -6640,6 +7077,10 @@ export interface SkillInvokedData {
6640
7077
  * Whether model invocation is disabled for this skill
6641
7078
  */
6642
7079
  disableModelInvocation?: boolean;
7080
+ /**
7081
+ * Projected chat-message count when the skill was invoked. New writers persist this so replay does not need to reconstruct superseded history; readers derive it for legacy events when absent.
7082
+ */
7083
+ invokedAtTurn?: number;
6643
7084
  /**
6644
7085
  * Model identifier active when the skill was invoked, when known
6645
7086
  */
@@ -7328,6 +7769,10 @@ export interface SystemMessageData {
7328
7769
  * The system or developer prompt text sent as model input
7329
7770
  */
7330
7771
  content: string;
7772
+ /**
7773
+ * Optional ordered structured blocks corresponding to content, retained for prompt-cache layout restoration.
7774
+ */
7775
+ contentBlocks?: SystemMessageContentBlock[];
7331
7776
  /**
7332
7777
  * Logical interaction identifier for the model run receiving this prompt
7333
7778
  */
@@ -7339,12 +7784,29 @@ export interface SystemMessageData {
7339
7784
  name?: string;
7340
7785
  role: SystemMessageRole;
7341
7786
  }
7787
+ /**
7788
+ * One persisted structured system-message block and its cache intent
7789
+ */
7790
+ export interface SystemMessageContentBlock {
7791
+ /**
7792
+ * Explicit prompt-cache intent. True places a breakpoint after this block, false suppresses one, and absence preserves the provider's legacy default.
7793
+ */
7794
+ cacheBreakpoint?: boolean;
7795
+ /**
7796
+ * Text content for this system-message block.
7797
+ */
7798
+ content: string;
7799
+ /**
7800
+ * Diagnostic classification indicating whether the block is stable across equivalent sessions.
7801
+ */
7802
+ isStatic?: boolean;
7803
+ }
7342
7804
  /**
7343
7805
  * Metadata about the prompt template and its construction
7344
7806
  */
7345
7807
  export interface SystemMessageMetadata {
7346
7808
  /**
7347
- * Version identifier of the prompt template used
7809
+ * Version identifier of the prompt template or structured prompt layout used
7348
7810
  */
7349
7811
  promptVersion?: string;
7350
7812
  /**
@@ -7393,6 +7855,7 @@ export interface SystemNotificationData {
7393
7855
  */
7394
7856
  content: string;
7395
7857
  kind: SystemNotification;
7858
+ responsesReasoning?: ResponsesReasoning;
7396
7859
  }
7397
7860
  /**
7398
7861
  * System notification metadata for a background agent that completed or failed, including agent ID, type, status, description, and prompt.
@@ -7632,8 +8095,13 @@ export interface PermissionRequestedEvent {
7632
8095
  */
7633
8096
  export interface PermissionRequestedData {
7634
8097
  agentMode?: SessionMode;
8098
+ permissionMode?: PermissionMode;
7635
8099
  permissionRequest: PermissionRequest;
7636
8100
  promptRequest?: PermissionPromptRequest;
8101
+ /**
8102
+ * Permission-recovery episode that authorized this request to surface for interactive attention
8103
+ */
8104
+ recoveryEpisodeId?: string;
7637
8105
  /**
7638
8106
  * Unique identifier for this permission request; used to respond via session.respondToPermission()
7639
8107
  */
@@ -7974,6 +8442,7 @@ export interface PermissionRequestMemory {
7974
8442
  */
7975
8443
  /** @experimental */
7976
8444
  export interface PermissionAssistedApproval {
8445
+ evaluation?: PermissionApprovalEvaluation;
7977
8446
  failureReason?: AssistedApprovalJudgeFailureReason;
7978
8447
  /**
7979
8448
  * Model id that produced the recommendation, when the judge was consulted and reported one. Absent for `excluded` (the judge was not consulted) and for failures that occurred before a model was selected.
@@ -7985,6 +8454,95 @@ export interface PermissionAssistedApproval {
7985
8454
  reason?: string;
7986
8455
  recommendation: AssistedApprovalRecommendation;
7987
8456
  }
8457
+ /**
8458
+ * Bounded runtime attribution, independent of free-text rationale. Telemetry revalidates this vocabulary before standard collection.
8459
+ */
8460
+ export interface PermissionApprovalEvaluation {
8461
+ /**
8462
+ * Stage that produced this attribution.
8463
+ */
8464
+ evaluationStage: "unknown"
8465
+ /** The request resolved before assisted-approval evaluation. */
8466
+ | "not_reached"
8467
+ /** A runtime gate skipped the judge. */
8468
+ | "pre_judge"
8469
+ /** The judge interface produced the evaluation. */
8470
+ | "judge"
8471
+ /** A cached recommendation or another request's outcome was reused. */
8472
+ | "reuse";
8473
+ /**
8474
+ * Whether the request invoked the judge interface. A cached recommendation retains the original attempt fact. Omitted means unknown, including inherited outcomes.
8475
+ */
8476
+ judgeAttempted?: boolean;
8477
+ /**
8478
+ * Status of the local judge interface, not proof of a model network call.
8479
+ */
8480
+ judgeStatus: "unknown"
8481
+ /** This evaluation did not invoke the judge interface. */
8482
+ | "not_called"
8483
+ /** The judge interface returned a usable verdict. */
8484
+ | "completed"
8485
+ /** The judge interface returned an error. */
8486
+ | "failed"
8487
+ /** This evaluation reused a cached recommendation. */
8488
+ | "cached"
8489
+ /** This request inherited another decision without local judge attribution. */
8490
+ | "inherited";
8491
+ /**
8492
+ * Machine-readable runtime gate reason, never a command, path or human rationale.
8493
+ */
8494
+ reasonCode: "unknown"
8495
+ /** The request resolved before assisted-approval evaluation. */
8496
+ | "not-reached"
8497
+ /** Assisted approval was inactive for this request. */
8498
+ | "inactive"
8499
+ /** The judge was skipped because authorization extraction could not safely establish a complete recent history. */
8500
+ | "authorization-history-incomplete"
8501
+ /** Managed policy required a human decision. */
8502
+ | "managed-approval-required"
8503
+ /** The request asked to bypass sandbox restrictions. */
8504
+ | "sandbox-bypass"
8505
+ /** An action field exceeded the judge input limit. */
8506
+ | "action-too-long"
8507
+ /** The script path was not authorized for inspection. */
8508
+ | "path-not-authorized"
8509
+ /** The script working directory was invalid. */
8510
+ | "invalid-working-directory"
8511
+ /** The script snapshot could not be read. */
8512
+ | "unreadable"
8513
+ /** The script path was not a regular file. */
8514
+ | "not-regular-file"
8515
+ /** The script snapshot exceeded the size limit. */
8516
+ | "too-large"
8517
+ /** The script snapshot was not UTF-8. */
8518
+ | "non-utf8"
8519
+ /** The script interpreter could not be inspected. */
8520
+ | "interpreter-unavailable"
8521
+ /** The interpreter snapshot exceeded the size limit. */
8522
+ | "interpreter-too-large"
8523
+ /** The shell environment could not be reviewed. */
8524
+ | "shell-environment-unreviewable"
8525
+ /** A script path could not be represented for review. */
8526
+ | "unrepresentable-path"
8527
+ /** An interpreter wrapped a script that could not be reviewed. */
8528
+ | "interpreter-wrapped-script"
8529
+ /** The script invocation could not be reviewed. */
8530
+ | "unreviewable-script-invocation"
8531
+ /** The script argument binding could not be reviewed. */
8532
+ | "argument-binding-unreviewable"
8533
+ /** The script review metadata was malformed. */
8534
+ | "malformed-script-action-review"
8535
+ /** The script snapshot manifest was malformed. */
8536
+ | "malformed-script-action-manifest"
8537
+ /** Script review was unavailable. */
8538
+ | "unavailable"
8539
+ /** The judge interface returned a usable verdict. */
8540
+ | "judge-verdict"
8541
+ /** The judge interface returned an error. */
8542
+ | "judge-error"
8543
+ /** The request inherited an outcome from another decision. */
8544
+ | "inherited";
8545
+ }
7988
8546
  /**
7989
8547
  * Custom tool invocation permission request
7990
8548
  */
@@ -8728,12 +9286,17 @@ export interface PermissionCompletedEvent {
8728
9286
  * Permission request completion notification signaling UI dismissal
8729
9287
  */
8730
9288
  export interface PermissionCompletedData {
9289
+ blocker?: TaskBlocker;
8731
9290
  /**
8732
9291
  * Who decided this permission request. Absent on completions recorded before this field existed, which consumers must treat as "not a human decision" rather than assuming one. Authorization records are minted only for `human_response`; an assisted-approval verdict, a host policy, an unattended fallback, and a hook resolution all produce the same `result` a person does, so this is the only field that distinguishes them.
8733
9292
  *
8734
9293
  * @experimental
8735
9294
  */
8736
9295
  decisionSource?: PermissionDecisionSource;
9296
+ /**
9297
+ * Permission-recovery episode settled by this response, when the request was escalated by Autopilot
9298
+ */
9299
+ recoveryEpisodeId?: string;
8737
9300
  /**
8738
9301
  * Request ID of the resolved permission request; clients should dismiss any UI for this request
8739
9302
  */