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 将所有可能的字段用作可选/可为 null 的单个 `Data` 类/结构。 只有下表中列出的字段会针对每个事件类型进行填充，其余字段会保持为`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 模型）：会话绑定 | | | |
| `phase` | `string` | | |
| 生成阶段（例如， `"thinking"` vs `"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