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)** Esses SDKs usam um único `Data` classe/struct com todos os campos possíveis como opcionais/anuláveis. Somente os campos listados nas tabelas abaixo são preenchidos para cada tipo de evento– o restante será `None` / `nil`.
>
> \[!TIP]
> **(.NET)** O SDK do .NET usa classes de dados separadas e fortemente tipados por evento (por exemplo, `AssistantMessageDeltaData`), portanto, somente os campos relevantes existem em cada tipo.
>
> \[!TIP]
> **(TypeScript)** O SDK do TypeScript usa uma união discriminada — quando você faz a correspondência com `event.type`, o payload `data` é automaticamente refinado para o formato correto.
## Eventos do assistente
Esses eventos acompanham o ciclo de vida de resposta do agente, desde o início da vez, passando pelos fragmentos de streaming até a mensagem final.
### `assistant.turn_start`
Emitido quando o agente começa a processar uma rodada.
| Campo de dados | Tipo | Obrigatório | Description |
| -------------------------------------------------- | -------- | ----------- | ------------------------------------------------------------------------------- |
| `turnId` | `string` | ✅ | Identificador de turno (normalmente um número de turno em cadeia de caracteres) |
| `interactionId` | `string` | | |
| ID de interação CAPI para correlação de telemetria | | | |
### `assistant.intent`
Efêmero. Breve descrição do que o agente está fazendo no momento, atualizada conforme funciona.
| Campo de dados | Tipo | Obrigatório | Description |
| -------------- | -------- | ----------- | ------------------------------------------------------------------------- |
| `intent` | `string` | ✅ | Intenção legível por humanos (por exemplo, "Explorando a base de código") |
### `assistant.reasoning`
Conclua o bloco de pensamento estendido do modelo. Emitido após a conclusão do raciocínio.
| Campo de dados | Tipo | Obrigatório | Description |
| -------------- | -------- | ----------- | ----------------------------------------------------- |
| `reasoningId` | `string` | ✅ | Identificador exclusivo para esse bloco de raciocínio |
| `content` | `string` | ✅ | O texto de pensamento estendido completo |
### `assistant.reasoning_delta`
Efêmero. Bloco incremental do pensamento estendido do modelo, transmitido em tempo real.
| Campo de dados | Tipo | Obrigatório | Description |
| -------------- | -------- | ----------- | ----------------------------------------------------------- |
| `reasoningId` | `string` | ✅ | Corresponde ao evento correspondente `assistant.reasoning` |
| `deltaContent` | `string` | ✅ | Parte de texto a ser acrescentada ao conteúdo de raciocínio |
### `assistant.message`
Resposta completa do assistente para esta chamada LLM. Pode incluir solicitações de invocação de ferramentas.
| Campo de dados | Tipo | Obrigatório | Description |
| --------------------------------------------------------------------------- | --------------- | ----------- | ------------------------------------------ |
| `messageId` | `string` | ✅ | Identificador exclusivo para esta mensagem |
| `content` | `string` | ✅ | Resposta de texto do assistente |
| `toolRequests` | `ToolRequest[]` | | |
| Chamadas de ferramenta que o assistente deseja fazer (veja abaixo) | | | |
| `reasoningOpaque` | `string` | | |
| Pensamento estendido criptografado (modelos antrópicos); associado à sessão | | | |
| `reasoningText` | `string` | | |
| Texto claro de raciocínio a partir de pensamento aprofundado | | | |
| `encryptedContent` | `string` | | |
| Conteúdo de raciocínio criptografado (modelos OpenAI); associado à sessão | | | |
| `phase` | `string` | | |
| Fase de geração (por exemplo, `"thinking"` vs `"response"`) | | | |
| `outputTokens` | `number` | | |
| Contagem real de tokens de saída na resposta da API | | | |
| `interactionId` | `string` | | |
| ID de interação CAPI para telemetria | | | |
| `parentToolCallId` | `string` | | |
| Definir quando essa mensagem se origina de um subagente | | | |
\*\*
`ToolRequest` Campos:\*\*
| Campo | Tipo | Obrigatório | Description |
| ----------------------------------------------------------------- | ------------------------ | ----------- | --------------------------------------------------------------- |
| `toolCallId` | `string` | ✅ | Identificação única para esta chamada de método |
| `name` | `string` | ✅ | Nome da ferramenta (por exemplo, , `"bash"`, `"edit"`) `"grep"` |
| `arguments` | `object` | | |
| Argumentos analisados para a ferramenta | | | |
| `type` | `"function" \| "custom"` | | |
| Tipo de chamada; é definido como `"function"` caso esteja ausente | | | |
### `assistant.message_delta`
Efêmero. Porção incremental da resposta de texto do assistente, transmitida em tempo real.
| Campo de dados | Tipo | Obrigatório | Description |
| ----------------------------------------- | -------- | ----------- | -------------------------------------------------------- |
| `messageId` | `string` | ✅ | Corresponde ao evento correspondente `assistant.message` |
| `deltaContent` | `string` | ✅ | Parte de texto a ser acrescentada à mensagem |
| `parentToolCallId` | `string` | | |
| Defina quando se originar de um subagente | | | |
### `assistant.turn_end`
Emitido quando o agente conclui um turno (todas as execuções de ferramentas são concluídas, resposta final fornecida).
| Campo de dados | Tipo | Obrigatório | Description |
| -------------- | -------- | ----------- | ----------------------------------------------------------- |
| `turnId` | `string` | ✅ | Corresponde ao evento correspondente `assistant.turn_start` |
### `assistant.usage`
Efêmero. Informações de uso e custo de token para uma chamada de API individual.
| Campo de dados | Tipo | Obrigatório | Description |
| ----------------------------------------------------------------------------------------------------- | ------------------------------- | ----------- | -------------------------------------------------- |
| `model` | `string` | ✅ | Identificador de modelo (por exemplo, `"gpt-4.1"`) |
| `inputTokens` | `number` | | |
| Tokens de entrada consumidos | | | |
| `outputTokens` | `number` | | |
| Tokens de saída produzidos | | | |
| `cacheReadTokens` | `number` | | |
| Tokens lidos do cache de prompt | | | |
| `cacheWriteTokens` | `number` | | |
| Tokens gravados no cache de prompt | | | |
| `cost` | `number` | | |
| Custo do multiplicador de modelo para cobrança | | | |
| `duration` | `number` | | |
| Duração da chamada à API em milissegundos | | | |
| `initiator` | `string` | | |
| O que acionou esta chamada (por exemplo, `"sub-agent"`); ausente para chamadas iniciadas pelo usuário | | | |
| `apiCallId` | `string` | | |
| ID de conclusão do provedor (por exemplo, `chatcmpl-abc123`) | | | |
| `providerCallId` | `string` | | |
| ID de rastreamento da solicitação do GitHub (`x-github-request-id`) | | | |
| `parentToolCallId` | `string` | | |
| Definir quando o uso se origina de um subagente | | | |
| `quotaSnapshots` | `Record