Copilot SDK のストリーミングイベント

メモ

          Copilot SDK は現在 テクニカル プレビューです。 機能と可用性は変更される場合があります。

          Copilot エージェントが実行するすべてのアクション (思考、コードの記述、ツールの実行) は、サブスクライブできる**セッション イベント**として生成されます。 この記事は、各イベントの種類に対するフィールド レベルの参照であるため、予想されるデータを正確に把握できます。

セッションでstreaming: trueが設定されると、SDK は、一時的なイベント (デルタ、進行状況の更新) をリアルタイムで、永続的なイベント (完全なメッセージ、ツールの結果) と共に出力します。すべてのイベントは共通のエンベロープを共有し、その形状がイベント dataに依存するtypeペイロードを運びます。完全なイベントフローのシーケンス図については、 github/copilot-sdk リポジトリを参照してください。

概念	説明

          **エフェメラル イベント** | 過渡;はリアルタイムでストリーミングされますが、セッション ログには保持 **されません** 。 セッションの再開時に再生されません。 |

イベントエンベロープ

種類に関係なく、すべてのセッションイベントには次のフィールドが含まれます。

フィールド	タイプ	説明
`id`

          `string` (UUID v4) | 一意のイベント識別子 |

イベントに登録する

// All events
session.on((event) => {
    console.log(event.type, event.data);
});

// Specific event type — data is narrowed automatically
session.on("assistant.message_delta", (event) => {
    process.stdout.write(event.data.deltaContent);
});

Python、Go、.NET の例については、 github/copilot-sdk リポジトリを参照してください。

ヒント

          **Python/Go:** これらの SDK では、1 つの `Data` クラス/構造体が使用され、使用可能なすべてのフィールドが省略可能または null 許容として使用されます。 次の表に示すフィールドのみがイベントの種類ごとに設定されます。残りは `None` / `nil`されます。

          **。ネット：** .NET SDK では、イベントごとに個別の厳密に型指定されたデータ クラス (たとえば、 `AssistantMessageDeltaData`) が使用されるため、各型に関連するフィールドのみが存在します。

          **Typescript：** TypeScript SDK では判別共用体が使用されます。 `event.type`で一致すると、 `data` ペイロードは自動的に正しい図形に絞り込まれます。

アシスタントイベント

これらのイベントは、ターンスタートからストリーミングチャンク、最後のメッセージまで、エージェントの応答ライフサイクルを追跡します。

`assistant.turn_start`

エージェントがターンの処理を開始したときに出力されます。

データフィールド	タイプ	必須	説明
`turnId`	`string`	✅	ターン識別子 (通常は、文字列化されたターン番号)
`interactionId`	`string`
テレメトリの相関関係の相互作用識別子

`assistant.intent`

儚い。エージェントが現在行っていることの簡単な説明。動作に応じて更新されます。

データフィールド	タイプ	必須	説明
`intent`	`string`	✅	人間が判読できる意図 ("コードベースの探索" など)

`assistant.reasoning`

モデルから拡張思考ブロックを完成させます。推論が完了した後に出力されます。

データフィールド	タイプ	必須	説明
`reasoningId`	`string`	✅	この理論ブロックの一意識別子
`content`	`string`	✅	完全な拡張思考テキスト

`assistant.reasoning_delta`

儚い。モデルの拡張思考がリアルタイムで段階的に配信されます。

データフィールド	タイプ	必須	説明
`reasoningId`	`string`	✅	対応する `assistant.reasoning` イベントと一致します
`deltaContent`	`string`	✅	推論コンテンツに追加するテキストの一部

`assistant.message`

この LLM 呼び出しに対するアシスタントの完全な応答。ツール呼び出し要求を含めることができます。

データフィールド	タイプ	必須	説明
`messageId`	`string`	✅	このメッセージのユニーク識別子
`content`	`string`	✅	アシスタントのテキスト応答
`toolRequests`	`ToolRequest[]`
アシスタントが行いたいと思うツール呼び出し (下記参照)
`reasoningOpaque`	`string`
暗号化された拡張思考（アントロピックモデル）、セッションにバインドされた
`reasoningText`	`string`
拡張思考から読み取り可能な推論テキスト
`encryptedContent`	`string`
暗号化された推論コンテンツ (OpenAI モデル);session-bound
`phase`	`string`
生成フェーズ (たとえば、 `"thinking"` と `"response"`)
`outputTokens`	`number`
API 応答からの実際の出力トークン数
`interactionId`	`string`
テレメトリの相互作用識別子
`parentToolCallId`	`string`
このメッセージがサブエージェントから送信されたときに設定する

          **
          `ToolRequest` フィールド：**

フィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	このツール呼び出しの一意の ID
`name`	`string`	✅	ツール名 ( `"bash"`、 `"edit"`、 `"grep"`など)
`arguments`	`object`
ツールの解析された引数
`type`	`"function" \| "custom"`
呼び出しの種類。存在しない場合は`"function"`が既定値となります。

`assistant.message_delta`

儚い。アシスタントのテキスト応答の逐次的に送信される部分。リアルタイムでストリーミング。

データフィールド	タイプ	必須	説明
`messageId`	`string`	✅	対応する `assistant.message` イベントと一致します
`deltaContent`	`string`	✅	メッセージに追加するテキストチャンク
`parentToolCallId`	`string`
サブエージェントからの発信時に設定する

`assistant.turn_end`

エージェントがターンを完了したときに生成されます (すべてのツールの実行が完了し、最終的な応答が配信されます)。

データフィールド	タイプ	必須	説明
`turnId`	`string`	✅	対応する `assistant.turn_start` イベントと一致します

`assistant.usage`

儚い。個々の API 呼び出しのトークンの使用状況とコストに関する情報。

データフィールド	タイプ	必須	説明
`model`	`string`	✅	モデル識別子 (たとえば、 `"gpt-4.1"`)
`inputTokens`	`number`
使用された入力トークン
`outputTokens`	`number`
生成された出力トークン
`cacheReadTokens`	`number`
プロンプトキャッシュから読み取られたトークン
`cacheWriteTokens`	`number`
プロンプトキャッシュに書き込まれたトークン
`cost`	`number`
請求のためのモデル乗算コスト
`duration`	`number`
API 呼び出し時間 (ミリ秒単位)
`initiator`	`string`
この呼び出しをトリガーした内容 (たとえば、 `"sub-agent"`)、ユーザーが開始した場合は存在しません
`apiCallId`	`string`
プロバイダーからの完了 ID (たとえば、 `chatcmpl-abc123`)
`providerCallId`	`string`

          GitHub 要求トレース ID (`x-github-request-id`) |

`assistant.streaming_delta`

儚い。低レベルのネットワーク進行状況インジケーター - ストリーミング API 応答から受信した合計バイト数。

データフィールド	タイプ	必須	説明
`totalResponseSizeBytes`	`number`	✅	これまでに受信した累積バイト数

ツールの実行イベント

これらのイベントは、ツール呼び出しを要求するモデルから実行から完了までの、各ツール呼び出しの完全なライフサイクルを追跡します。

`tool.execution_start`

ツールの実行が開始されたときに出力されます。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	この呼び出しツールの一意の識別子
`toolName`	`string`	✅	ツールの名前 ( `"bash"`、 `"edit"`、 `"grep"`など)
`arguments`	`object`
ツールに渡される解析された引数
`mcpServerName`	`string`
MCP サーバー名 (ツールが MCP サーバーによって提供される場合)
`mcpToolName`	`string`
MCP サーバー上の元のツール名
`parentToolCallId`	`string`
サブエージェントによって呼び出されたときに設定する

`tool.execution_partial_result`

儚い。実行中のツールからの増分出力 (たとえば、bash 出力のストリーミング)。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	対応する`tool.execution_start`に一致します
`partialOutput`	`string`	✅	増分出力チャンク

`tool.execution_progress`

儚い。実行中のツール (MCP サーバーの進行状況通知など) から人間が判読できる進行状況の状態。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	対応する`tool.execution_start`に一致します
`progressMessage`	`string`	✅	進捗状況メッセージ

`tool.execution_complete`

ツールの実行が正常に終了したとき、またはエラーが発生したときに生成されます。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	対応する`tool.execution_start`に一致します
`success`	`boolean`	✅	実行が成功したかどうか
`model`	`string`
このツール呼び出しを生成したモデル
`interactionId`	`string`
相互作用識別子
`isUserRequested`	`boolean`

          `true` ユーザーがこのツール呼び出しを明示的に要求したとき |

| result | Result | | 成功した場合の発表 (下記参照) | | error | { message, code? } | | 障害発生時に存在する | | toolTelemetry | object | | ツール固有のテレメトリ | | parentToolCallId | string | | サブエージェントによって呼び出されたときに設定する |

          **
          `Result` フィールド：**

フィールド	タイプ	必須	説明
`content`	`string`	✅	LLM に送信される簡潔な結果 (トークン効率のために切り捨てられる可能性があります)
`detailedContent`	`string`
差分などの完全なコンテンツを保持する、表示の完全な結果
`contents`	`ContentBlock[]`
構造化コンテンツブロック (テキスト、ターミナル、イメージ、オーディオ、リソース)

`tool.user_requested`

ユーザーが明示的にツールの呼び出しを要求したときに生成されます (呼び出しを選択したモデルではなく)。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	ツールの呼び出しに関する一意の識別子
`toolName`	`string`	✅	ユーザーが呼び出すツールの名前
`arguments`	`object`
呼び出しの引数

セッションライフサイクルイベント

`session.idle`

儚い。エージェントはすべての処理を完了し、次のメッセージの準備が整いました。これはターンが完全に完了したことを示すシグナルです。

データフィールド	タイプ	必須	説明
`backgroundTasks`	`BackgroundTasks`
エージェントがアイドル状態になると、バックグラウンドのエージェントやシェルが引き続き動作します。

`session.error`

セッション処理中にエラーが発生しました。

データフィールド	タイプ	必須	説明
`errorType`	`string`	✅	エラーカテゴリ ( `"authentication"`、 `"quota"`、 `"rate_limit"`など)
`message`	`string`	✅	人間が読みやすいエラーメッセージ
`stack`	`string`
エラースタックトレース
`statusCode`	`number`
アップストリーム要求からの HTTP 状態コード
`providerCallId`	`string`

          GitHub サーバー側ログ連携のリクエストトレース ID |

`session.compaction_start`

コンテキストウィンドウの圧縮が開始されました。データペイロードが空 ({})。

`session.compaction_complete`

コンテキストウィンドウの圧縮が完了しました。

データフィールド	タイプ	必須	説明
`success`	`boolean`	✅	圧縮に成功したかどうか
`error`	`string`
圧縮に失敗した場合のエラーメッセージ
`preCompactionTokens`	`number`
圧縮前のトークン
`postCompactionTokens`	`number`
圧縮後のトークン
`preCompactionMessagesLength`	`number`
圧縮前のメッセージ数
`messagesRemoved`	`number`
削除されたメッセージ
`tokensRemoved`	`number`
トークンが削除されました
`summaryContent`	`string`
LLM によって生成されたコンパクトな履歴の概要
`checkpointNumber`	`number`
復旧用に作成されたチェックポイントスナップショット番号
`checkpointPath`	`string`
チェックポイントが格納されたファイルパス
`compactionTokensUsed`	`{ input, output, cachedInput }`
圧縮 LLM 呼び出しのトークンの使用
`requestId`	`string`

          GitHub 圧縮呼び出しの要求トレース ID |

`session.title_changed`

一時的なセッションの自動生成されたタイトルが更新されました。

データフィールド	タイプ	必須	説明
`title`	`string`	✅	新しいセッションタイトル

`session.context_changed`

セッションの作業ディレクトリまたはリポジトリコンテキストが変更されました。

データフィールド	タイプ	必須	説明
`cwd`	`string`	✅	現在の作業ディレクトリ
`gitRoot`	`string`
Git リポジトリのルート
`repository`	`string`

          `"owner/name"`形式のリポジトリ |

`session.usage_info`

儚い。コンテキストウィンドウ使用率スナップショット。

データフィールド	タイプ	必須	説明
`tokenLimit`	`number`	✅	モデルのコンテキストウィンドウの最大トークン数
`currentTokens`	`number`	✅	コンテキストウィンドウ内の現在のトークン
`messagesLength`	`number`	✅	会話の現在のメッセージ数

`session.task_complete`

エージェントは、割り当てられたタスクを完了しました。

データフィールド	タイプ	必須	説明
`summary`	`string`
完了したタスクの概要

`session.shutdown`

セッションが終了しました。

データフィールド	タイプ	必須	説明
`shutdownType`	`"routine" \| "error"`	✅	通常のシャットダウンまたはクラッシュ
`errorReason`	`string`

          `shutdownType` が `"error"` である場合のエラー説明 |

| totalPremiumRequests | number | ✅ | 使用された Premium API 要求の合計数 | | totalApiDurationMs | number | ✅ | API 呼び出しの累積時間 (ミリ秒単位) | | sessionStartTime | number | ✅ | セッションの開始時の Unix タイムスタンプ (ミリ秒) | | codeChanges | { linesAdded, linesRemoved, filesModified } | ✅ | コード変更メトリックの集計 | | modelMetrics | Record<string, ModelMetric> | ✅ | モデルごとの使用状況の内訳 | | currentModel | string | | シャットダウン時に選択されたモデル |

アクセス許可とユーザー入力イベント

これらのイベントは、エージェントが続行する前にユーザーからの承認または入力を必要とする場合に生成されます。

`permission.requested`

一時的。エージェントには、アクション (コマンドの実行、ファイルの書き込みなど) を実行するためのアクセス許可が必要です。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	これを使用して、次の方法で応答します。 `session.respondToPermission()`
`permissionRequest`	`PermissionRequest`	✅	要求されているアクセス許可の詳細

          `permissionRequest`は、`kind`の判別共用体です。

`kind`	主要なフィールド	説明
`"shell"`

          `fullCommandText`、 `intention`、 `commands[]`、 `possiblePaths[]` | シェル コマンドを実行する |

すべての kind バリアントには、要求をトリガーしたツール呼び出しにリンクバックするオプションの toolCallId も含まれています。

`permission.completed`

一時的。アクセス許可要求が解決されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	対応する`permission.requested`に一致します
`result.kind`	`string`	✅	次のいずれか: `"approved"`、 `"denied-by-rules"`、 `"denied-interactively-by-user"`、 `"denied-no-approval-rule-and-could-not-request-from-user"`、 `"denied-by-content-exclusion-policy"`

`user_input.requested`

儚い。エージェントがユーザーに質問しています。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	これを使用して、次の方法で応答します。 `session.respondToUserInput()`
`question`	`string`	✅	ユーザーに提示する質問
`choices`	`string[]`
ユーザーの定義済みの選択肢
`allowFreeform`	`boolean`
自由形式のテキスト入力が許可されるかどうか

`user_input.completed`

儚いユーザー入力要求が解決されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	対応する`user_input.requested`と一致します

`elicitation.requested`

一時的エージェントには、ユーザーからの構造化されたフォーム入力 (MCP 引き出しプロトコル) が必要です。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	これを使用して、次の方法で応答します。 `session.respondToElicitation()`
`message`	`string`	✅	必要な情報の説明
`mode`	`"form"`
現在、引き出しモードは`"form"`のみです。
`requestedSchema`	`{ type: "object", properties, required? }`	✅	フォームフィールドを記述する JSON スキーマ

`elicitation.completed`

儚い。引き出し要請が解決されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	対応する `elicitation.requested`

サブエージェントとスキルイベント

`subagent.started`

カスタムエージェントがサブエージェントとして呼び出されました。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	このサブエージェントを生成した親ツール呼び出し
`agentName`	`string`	✅	サブエージェントの内部名
`agentDisplayName`	`string`	✅	人間が判読できる表示名
`agentDescription`	`string`	✅	サブエージェントの機能の説明

`subagent.completed`

サブエージェントが正常に完了しました。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	対応する `subagent.started` に一致しています
`agentName`	`string`	✅	内部名
`agentDisplayName`	`string`	✅	表示名

`subagent.failed`

サブエージェントでエラーが発生しました。

データフィールド	タイプ	必須	説明
`toolCallId`	`string`	✅	対応する `subagent.started`
`agentName`	`string`	✅	内部名
`agentDisplayName`	`string`	✅	表示名
`error`	`string`	✅	エラーメッセージ

`subagent.selected`

現在の要求を処理するために、カスタムエージェントが選択 (推論) されました。

データフィールド	タイプ	必須	説明
`agentName`	`string`	✅	選択したエージェントの内部名
`agentDisplayName`	`string`	✅	表示名
`tools`	`string[] \| null`	✅	このエージェントで使用可能なツール名。すべてのツールには`null`

`subagent.deselected`

カスタムエージェントの選択が解除され、既定のエージェントに戻りました。応答ペイロードは空になります ({})。

`skill.invoked`

現在の会話に対してスキルがアクティブ化されました。

データフィールド	タイプ	必須	説明
`name`	`string`	✅	スキル名
`path`	`string`	✅	SKILL.md 定義へのファイルパス
`content`	`string`	✅	会話にすべてのスキルコンテンツが挿入されました。
`allowedTools`	`string[]`
このスキルがアクティブな間に自動承認されたツール
`pluginName`	`string`
スキルの元のプラグイン
`pluginVersion`	`string`
プラグインのバージョン

その他のイベント

`abort`

現在のターンは中止されました。

データフィールド	タイプ	必須	説明
`reason`	`string`	✅	ターンが中止された理由 (たとえば、 `"user initiated"`)

`user.message`

ユーザーがメッセージを送信しました。セッションタイムライン用に記録されます。

データフィールド	タイプ	必須	説明
`content`	`string`	✅	ユーザーのメッセージテキスト
`transformedContent`	`string`
前処理後に変換されたバージョン
`attachments`	`Attachment[]`
ファイル、ディレクトリ、選択、BLOB または GitHub の参照添付ファイル
`source`	`string`
メッセージソース識別子
`agentMode`	`string`
エージェントモード: `"interactive"`、 `"plan"`、 `"autopilot"`、または `"shell"`
`interactionId`	`string`
相互作用識別子

`system.message`

システムまたは開発者のプロンプトが会話に挿入されました。

データフィールド	タイプ	必須	説明
`content`	`string`	✅	プロンプトの内容
`role`	`"system" \| "developer"`	✅	メッセージ役割
`name`	`string`
ソース識別子
`metadata`	`{ promptVersion?, variables? }`
プロンプトテンプレートのメタデータ

`external_tool.requested`

儚い。エージェントは、外部ツール (SDK コンシューマーによって提供されるツール) を呼び出したいと考えています。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	これを使用して、次の方法で応答します。 `session.respondToExternalTool()`
`sessionId`	`string`	✅	この要求が属するセッション
`toolCallId`	`string`	✅	この呼び出しのツール呼び出し ID
`toolName`	`string`	✅	外部ツールの名前
`arguments`	`object`
ツールの引数

`external_tool.completed`

儚い外部ツール要求が解決されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	対応する`external_tool.requested`と一致します。

`exit_plan_mode.requested`

儚いエージェントによってプランが作成され、プランモードを終了する必要があります。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	これを使用して、次の方法で応答します。 `session.respondToExitPlanMode()`
`summary`	`string`	✅	プランの概要
`planContent`	`string`	✅	プランファイルの全内容
`actions`	`string[]`	✅	使用可能なユーザーアクション (承認、編集、拒否など)
`recommendedAction`	`string`	✅	推奨されるアクション

`exit_plan_mode.completed`

儚い。終了プランモード要求が解決されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	対応する`exit_plan_mode.requested`と一致する

`command.queued`

一時的スラッシュコマンドがキューに登録され、実行されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	これを使用して、次の方法で応答します。 `session.respondToQueuedCommand()`
`command`	`string`	✅	スラッシュコマンドテキスト (たとえば、 `/help`、 `/clear`)

`command.completed`

一時的キューに登録されたコマンドが解決されました。

データフィールド	タイプ	必須	説明
`requestId`	`string`	✅	対応する `command.queued` に一致する

クイックリファレンス: エージェンティックターンフロー

一般的なエージェントターンでは、次の順序でイベントが出力されます。

assistant.turn_start          → Turn begins
├── assistant.intent          → What the agent plans to do (ephemeral)
├── assistant.reasoning_delta → Streaming thinking chunks (ephemeral, repeated)
├── assistant.reasoning       → Complete thinking block
├── assistant.message_delta   → Streaming response chunks (ephemeral, repeated)
├── assistant.message         → Complete response (may include toolRequests)
├── assistant.usage           → Token usage for this API call (ephemeral)
│
├── [If tools were requested:]
│   ├── permission.requested  → Needs user approval (ephemeral)
│   ├── permission.completed  → Approval result (ephemeral)
│   ├── tool.execution_start  → Tool begins
│   ├── tool.execution_partial_result  → Streaming tool output (ephemeral, repeated)
│   ├── tool.execution_progress        → Progress updates (ephemeral, repeated)
│   ├── tool.execution_complete        → Tool finished
│   │
│   └── [Agent loops: more reasoning → message → tool calls...]
│
assistant.turn_end            → Turn complete
session.idle                  → Ready for next message (ephemeral)

すべてのイベントの種類の概要

イベントの種類	エフェメラル	カテゴリ	キーデータフィールド
`assistant.turn_start`
助手

          `turnId`、`interactionId?` |

Copilot SDK のストリーミング イベント

この機能を使用できるユーザーについて

この記事で

Copilot SDK のストリーミングイベント