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)** Diese SDKs verwenden eine einzelne `Data` Klasse/Struktur mit allen möglichen Feldern als optional/nullable. Nur die felder, die in den folgenden Tabellen aufgeführt sind, werden für jeden Ereignistyp aufgefüllt – der Rest lautet `None` / `nil`.
>
> \[!TIP]
> **(.NET)** Das .NET SDK verwendet separate, stark typierte Datenklassen pro Ereignis (z. B. `AssistantMessageDeltaData`), sodass nur die relevanten Felder für jeden Typ vorhanden sind.
>
> \[!TIP]
> **(TypeScript)** Das TypeScript SDK verwendet ein discriminated union – wenn Sie auf `event.type` passen, wird der `data` Payload automatisch auf die richtige Form eingegrenzt.
## Ereignisse des Assistenten
Diese Ereignisse verfolgen den Lebenszyklus der Antwort des Agents - vom Start der Abzweigung über die Streaming Chunks bis zur endgültigen Nachricht.
### `assistant.turn_start`
Wird ausgelöst, wenn der Agent mit der Verarbeitung eines Ablaufschritts beginnt.
| Datenfeld | Typ | Erforderlich | Description |
| ---------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------- |
| `turnId` | `string` | ✅ | Turn-Identifikator (typischerweise eine stringifizierte Turn-Nummer) |
| `interactionId` | `string` | | |
| CAPI-Interaktions-ID für Telemetriekorrelation | | | |
### `assistant.intent`
Flüchtig Kurze Beschreibung dessen, was der Agent gerade tut, aktualisiert während der Vorgang läuft.
| Datenfeld | Typ | Erforderlich | Description |
| --------- | -------- | ------------ | ------------------------------------------------ |
| `intent` | `string` | ✅ | Lesbare Absicht (z. B. "Erkunden der Codebasis") |
### `assistant.reasoning`
Schließen Sie die erweiterte Denkblockade des Modells ab. Wird nach Abschluss der Begründung ausgegeben.
| Datenfeld | Typ | Erforderlich | Description |
| ------------- | -------- | ------------ | -------------------------------------------- |
| `reasoningId` | `string` | ✅ | Eindeutiger Bezeichner für diesen Logikblock |
| `content` | `string` | ✅ | Der vollständige erweiterte Denktext |
### `assistant.reasoning_delta`
Flüchtig Inkrementeller Chunk des erweiterten Denkens des Modells, das in Echtzeit gestreamt wird.
| Datenfeld | Typ | Erforderlich | Description |
| -------------- | -------- | ------------ | ----------------------------------------------------------------- |
| `reasoningId` | `string` | ✅ | Entspricht dem entsprechenden `assistant.reasoning` Ereignis. |
| `deltaContent` | `string` | ✅ | Textabschnitt, der an den Inhalt von Gründen angefügt werden soll |
### `assistant.message`
Die vollständige Antwort des Assistenten für diesen LLM-Aufruf. Kann Toolaufrufanforderungen enthalten.
| Datenfeld | Typ | Erforderlich | Description |
| --------------------------------------------------------------------------- | --------------- | ------------ | ------------------------------------------ |
| `messageId` | `string` | ✅ | Eindeutiger Bezeichner für diese Nachricht |
| `content` | `string` | ✅ | Die Textantwort des Assistenten |
| `toolRequests` | `ToolRequest[]` | | |
| Toolaufrufe, die der Assistent tätigen möchte (siehe unten) | | | |
| `reasoningOpaque` | `string` | | |
| Verschlüsseltes erweitertes Denken (Anthropische Modelle); sitzungsgebunden | | | |
| `reasoningText` | `string` | | |
| Lesbarer Reasoning-Text aus erweitertem Denken | | | |
| `encryptedContent` | `string` | | |
| Verschlüsselte Begründungsinhalte (OpenAI-Modelle); sitzungsgebunden | | | |
| `phase` | `string` | | |
| Generationsphase (z. B. `"thinking"` vs `"response"`) | | | |
| `outputTokens` | `number` | | |
| Tatsächliche Ausgabetokenanzahl aus der API-Antwort | | | |
| `interactionId` | `string` | | |
| CAPI-Interaktions-ID für Telemetrie | | | |
| `parentToolCallId` | `string` | | |
| Festlegen, wann diese Nachricht von einem Unter-Agent stammt | | | |
\*\*
`ToolRequest` Felder:\*\*
| Feld | Typ | Erforderlich | Description |
| --------------------------------------------------------- | ------------------------ | ------------ | ---------------------------------------------- |
| `toolCallId` | `string` | ✅ | Eindeutige ID für diesen Toolaufruf |
| `name` | `string` | ✅ | Toolname (z. B., `"bash"`, `"edit"`, `"grep"`) |
| `arguments` | `object` | | |
| Analysierte Argumente für das Tool | | | |
| `type` | `"function" \| "custom"` | | |
| Anruftyp; Standardwert: `"function"` wenn nicht vorhanden | | | |
### `assistant.message_delta`
Flüchtig Inkrementeller Chunk der Text-Antwort des Assistenten, der in Echtzeit gestreamt wird.
| Datenfeld | Typ | Erforderlich | Description |
| ------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------- |
| `messageId` | `string` | ✅ | Entspricht dem entsprechenden `assistant.message` Ereignis. |
| `deltaContent` | `string` | ✅ | Textabschnitt, der an die Nachricht angefügt werden soll |
| `parentToolCallId` | `string` | | |
| Festlegen, wenn sie von einem Unter-Agent stammen | | | |
### `assistant.turn_end`
Wird ausgegeben, wenn der Agent eine Runde abschließt (alle Tool-Ausführungen abgeschlossen, endgültige Antwort geliefert).
| Datenfeld | Typ | Erforderlich | Description |
| --------- | -------- | ------------ | -------------------------------------------------------------- |
| `turnId` | `string` | ✅ | Entspricht dem entsprechenden `assistant.turn_start` Ereignis. |
### `assistant.usage`
Flüchtig Tokenverwendungs- und Kosteninformationen für einen einzelnen API-Aufruf.
| Datenfeld | Typ | Erforderlich | Description |
| ---------------------------------------------------------------------------------------- | ------------------------------- | ------------ | ------------------------------------ |
| `model` | `string` | ✅ | Modellbezeichner (z. B. `"gpt-4.1"`) |
| `inputTokens` | `number` | | |
| Verbrauchte Eingabetoken | | | |
| `outputTokens` | `number` | | |
| Erzeugte Ausgabetoken | | | |
| `cacheReadTokens` | `number` | | |
| Token aus dem Prompt-Cache lesen | | | |
| `cacheWriteTokens` | `number` | | |
| Token werden in den Prompt-Cache geschrieben | | | |
| `cost` | `number` | | |
| Kosten für den Modellmultiplikator bei der Abrechnung | | | |
| `duration` | `number` | | |
| API-Aufrufdauer in Millisekunden | | | |
| `initiator` | `string` | | |
| Was diesen Aufruf ausgelöst hat (z. B. `"sub-agent"`); fehlt für vom Benutzer initiierte | | | |
| `apiCallId` | `string` | | |
| Abschluss-ID vom Anbieter (z. B. `chatcmpl-abc123`) | | | |
| `providerCallId` | `string` | | |
| GitHub-Anforderungsablaufverfolgungs-ID (`x-github-request-id`) | | | |
| `parentToolCallId` | `string` | | |
| Festlegen, wann die Verwendung von einem Unter-Agent stammt | | | |
| `quotaSnapshots` | `Record