TypeScript
```typescript
// 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
```python
from copilot import CopilotClient
from copilot.generated.session_events import SessionEventType
client = CopilotClient()
session = None # assume session is created elsewhere
def handle(event):
if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:
print(event.data.delta_content, end="", flush=True)
# session.on(handle)
```
```python
from copilot.generated.session_events import SessionEventType
def handle(event):
if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:
print(event.data.delta_content, end="", flush=True)
session.on(handle)
```
Go
```golang
package main
import (
"context"
"fmt"
copilot "github.com/github/copilot-sdk/go"
"github.com/github/copilot-sdk/go/rpc"
)
func main() {
ctx := context.Background()
client := copilot.NewClient(nil)
session, _ := client.CreateSession(ctx, &copilot.SessionConfig{
Model: "gpt-4.1",
Streaming: copilot.Bool(true),
OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (rpc.PermissionDecision, error) {
return &rpc.PermissionDecisionApproveOnce{}, nil
},
})
session.On(func(event copilot.SessionEvent) {
if d, ok := event.Data.(*copilot.AssistantMessageDeltaData); ok {
fmt.Print(d.DeltaContent)
}
})
_ = session
}
```
```golang
session.On(func(event copilot.SessionEvent) {
if d, ok := event.Data.(*copilot.AssistantMessageDeltaData); ok {
fmt.Print(d.DeltaContent)
}
})
```
.NET
```csharp
using GitHub.Copilot;
public static class StreamingEventsExample
{
public static async Task Example(CopilotSession session)
{
session.On
(evt =>
{
if (evt is AssistantMessageDeltaEvent delta)
{
Console.Write(delta.Data.DeltaContent);
}
});
}
}
```
```csharp
session.On(evt =>
{
if (evt is AssistantMessageDeltaEvent delta)
{
Console.Write(delta.Data.DeltaContent);
}
});
```
Java
```java
// All events
session.on(event -> System.out.println(event.getType()));
// Specific event type — data is narrowed to the matching class
session.on(AssistantMessageDeltaEvent.class, event ->
System.out.print(event.getData().deltaContent())
);
```
> \[!TIP]
> **(Python/Go)** これらの SDK では、1 つの `Data` クラス/構造体が使用され、使用可能なすべてのフィールドが省略可能または null 許容として使用されます。 次の表に示すフィールドのみがイベントの種類ごとに設定されます。残りは `None` / `nil`されます。
>
> \[!TIP]
> **(.NET)** .NET SDK では、イベントごとに個別の厳密に型指定されたデータ クラス (`AssistantMessageDeltaData` など) が使用されるため、各型に関連するフィールドのみが存在します。
>
> \[!TIP]
> **(TypeScript)** TypeScript SDK では判別共用体が使用されます。 `event.type`で一致すると、 `data` ペイロードは自動的に正しい図形に絞り込まれます。
## アシスタント イベント
これらのイベントは、ターン スタートからストリーミング チャンク、最後のメッセージまで、エージェントの応答ライフサイクルを追跡します。
### `assistant.turn_start`
エージェントがターンの処理を開始したときに出力されます。
| データ フィールド | タイプ | 必須 | Description |
| -------------------------- | -------- | -- | ------------------------- |
| `turnId` | `string` | ✅ | ターン識別子 (通常は、文字列化されたターン番号) |
| `interactionId` | `string` | | |
| テレメトリ相関用の CAPI インタラクション ID | | | |
### `assistant.intent`
儚い。 エージェントが現在行っていることの簡単な説明。動作に応じて更新されます。
| データ フィールド | タイプ | 必須 | Description |
| --------- | -------- | -- | --------------------------- |
| `intent` | `string` | ✅ | 人間が判読できる意図 (例: "コードベースの探索") |
### `assistant.reasoning`
モデルから拡張思考ブロックを完成させます。 推論が完了した後に出力されます。
| データ フィールド | タイプ | 必須 | Description |
| ------------- | -------- | -- | -------------- |
| `reasoningId` | `string` | ✅ | この推論ブロックの一意識別子 |
| `content` | `string` | ✅ | 完全な拡張思考テキスト |
### `assistant.reasoning_delta`
儚い。 リアルタイムでストリーミングされる、モデルの拡張思考の増分チャンク。
| データ フィールド | タイプ | 必須 | Description |
| -------------- | -------- | -- | ------------------------------------- |
| `reasoningId` | `string` | ✅ | 対応する `assistant.reasoning` イベントと一致します |
| `deltaContent` | `string` | ✅ | 推論コンテンツに追加するテキストの一部 |
### `assistant.message`
この LLM 呼び出しに対するアシスタントの完全な応答。 ツール呼び出し要求を含めることができます。
| データ フィールド | タイプ | 必須 | Description |
| ---------------------------------------- | --------------- | -- | --------------- |
| `messageId` | `string` | ✅ | このメッセージのユニーク識別子 |
| `content` | `string` | ✅ | アシスタントのテキスト応答 |
| `toolRequests` | `ToolRequest[]` | | |
| アシスタントが行いたいと思うツール呼び出し (下記参照) | | | |
| `reasoningOpaque` | `string` | | |
| 暗号化された拡張思考（アントロピックモデル）、セッションにバインドされた | | | |
| `reasoningText` | `string` | | |
| 拡張思考から読み取り可能な推論テキスト | | | |
| `encryptedContent` | `string` | | |
| 暗号化された推論コンテンツ (OpenAI モデル);session-bound | | | |
| `phase` | `string` | | |
| 生成フェーズ (例: `"thinking"` と `"response"`) | | | |
| `outputTokens` | `number` | | |
| API 応答からの実際の出力トークン数 | | | |
| `interactionId` | `string` | | |
| テレメトリ用の CAPI インタラクション ID | | | |
| `parentToolCallId` | `string` | | |
| このメッセージがサブエージェントから送信されたときに設定する | | | |
\*\*
`ToolRequest` フィールド：\*\*
| フィールド | タイプ | 必須 | Description |
| -------------------------------------- | ------------------------ | -- | -------------------------------------- |
| `toolCallId` | `string` | ✅ | このツール呼び出しの一意の ID |
| `name` | `string` | ✅ | ツール名 (例: `"bash"`、 `"edit"`、 `"grep"`) |
| `arguments` | `object` | | |
| ツールの解析された引数 | | | |
| `type` | `"function" \| "custom"` | | |
| 呼び出しの種類。存在しない場合は`"function"`が既定値となります。 | | | |
### `assistant.message_delta`
儚い。 リアルタイムでストリーミングされる、アシスタントのテキスト応答の増分チャンク。
| データ フィールド | タイプ | 必須 | Description |
| ------------------- | -------- | -- | ----------------------------------- |
| `messageId` | `string` | ✅ | 対応する `assistant.message` イベントと一致します |
| `deltaContent` | `string` | ✅ | メッセージに追加するテキスト チャンク |
| `parentToolCallId` | `string` | | |
| サブエージェントからの発信時に設定する | | | |
### `assistant.turn_end`
エージェントがターンを完了したときに生成されます (すべてのツールの実行が完了し、最終的な応答が配信されます)。
| データ フィールド | タイプ | 必須 | Description |
| --------- | -------- | -- | -------------------------------------- |
| `turnId` | `string` | ✅ | 対応する `assistant.turn_start` イベントと一致します |
### `assistant.usage`
儚い。 個々の API 呼び出しのトークンの使用状況とコストに関する情報。
| データ フィールド | タイプ | 必須 | Description |
| ---------------------------------------------------- | -------------------------------------------------------------------------- | -- | ----------------------- |
| `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`) | | | |
| `apiEndpoint` | `"/chat/completions" \| "/v1/messages" \| "/responses" \| "ws:/responses"` | | |
| モデル呼び出しに使用される API エンドポイント。は、可観測性とコストの属性に役立ちます。 | | | |
| `ws:/responses` は、応答 API の Websocket バリアントです | | | |
| `providerCallId` | `string` | | |
| GitHub要求トレース ID (`x-github-request-id`) | | | |
| `parentToolCallId` | `string` | | |
| サブエージェントから使用を開始するタイミングを設定する | | | |
| `quotaSnapshots` | `Record