События потоковых сессий

Обзор

Когда streaming: true он настроен на сессию, SDK в реальном времени излучает эфемерные события (дельты, обновления прогресса) вместе с сохраненными событиями (полные сообщения, результаты инструментов). Все события имеют общую оболочку и несут полезную data нагрузку, форма которой зависит от события type.

Оболочка событий

Каждое событие сессии, независимо от типа, включает следующие поля:

Подписка на события

// 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);
});

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)

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)

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
}

session.On(func(event copilot.SessionEvent) {
    if d, ok := event.Data.(*copilot.AssistantMessageDeltaData); ok {
        fmt.Print(d.DeltaContent)
    }
})

using GitHub.Copilot;

public static class StreamingEventsExample
{
    public static async Task Example(CopilotSession session)
    {
        session.On<SessionEvent>(evt =>
        {
            if (evt is AssistantMessageDeltaEvent delta)
            {
                Console.Write(delta.Data.DeltaContent);
            }
        });
    }
}

session.On<SessionEvent>(evt =>
{
    if (evt is AssistantMessageDeltaEvent delta)
    {
        Console.Write(delta.Data.DeltaContent);
    }
});

// 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())
);

Соревнования ассистентов

Эти события отслеживают жизненный цикл реакции агента — от запуска ходов через потоковые фрагменты до финального сообщения.

assistant.turn_start

Излучается, когда агент начинает обрабатывать ход.

assistant.intent

Эфемерно. Краткое описание того, чем сейчас занимается агент, обновляется по мере работы.

assistant.reasoning

Полный расширенный размышленный блок из модели. Выпущено после завершения рассуждений.

assistant.reasoning_delta

Эфемерно. Постепенная часть расширенного мышления модели, транслируемая в реальном времени.

assistant.message

Полный ответ ассистента на этот звонок LLM. Может содержать запросы на вызов инструментов.

** ToolRequest Области:**

assistant.message_delta

Эфемерно. Постепенный фрагмент ответа ассистента в реальном времени.

assistant.turn_end

Издаётся после завершения хода агентом (выполнение всех инструментов завершено, финальный ответ получен).

assistant.usage

Эфемерно. Информация об использовании токена и стоимости для отдельного вызова API.

assistant.streaming_delta

Эфемерно. Низкоуровневый индикатор прогресса сети — общее количество байт, полученных от ответа потокового API.

События выполнения инструментов

Эти события отслеживают полный жизненный цикл каждого вызова инструмента — от запроса вызова инструмента моделью до его выполнения.

tool.execution_start

Испускается, когда инструмент начинает работать.

tool.execution_partial_result

Эфемерно. Инкрементальный вывод от запускающегося инструмента (например, потоковой выход bash).

tool.execution_progress

Эфемерно. Читаемый человеком статус прогресса из запускаемого инструмента (например, уведомления о прогрессе сервера MCP).

tool.execution_complete

Издаётся, когда инструмент завершает выполнение — успешно или с ошибкой.

** Result Области:**

tool.user_requested

Издаётся, когда пользователь явно запрашивает вызов инструмента (вместо того чтобы модель выбирает вызов инструмента).

События жизненного цикла сессии

session.idle

Эфемерно. Агент завершил всю обработку и готов к следующему сообщению. Это сигнал о полном завершении поворота.

session.error

Во время обработки сессии произошла ошибка.

session.compaction_start

Началось уплотнение контекстного окна. Полезная нагрузка данных пуста ({}).

session.compaction_complete

Уплотнение контекстного окна завершено.

session.title_changed

Эфемерно. Автоматически сгенерированное название сессии было обновлено.

session.context_changed

Рабочий каталог или контекст репозитория сессии изменились.

session.usage_info

Эфемерно. Снимок использования контекстного окна.

session.task_complete

Агент выполнил назначенную задачу.

session.shutdown

Сессия закончилась.

Разрешения и события ввода пользователя

Эти события возникают, когда агенту требуется одобрение или ввод от пользователя перед продолжением.

permission.requested

Эфемерно. Агенту требуется разрешение на выполнение действия (запуск команды, записи файла и т.д.).

Это permissionRequest дискриминационный союз на kind:

Все kind варианты также включают опциональную toolCallId связь с вызовом инструмента, который инициировал запрос.

permission.completed

Эфемерно. Запрос на разрешение был урегулирован.

user_input.requested

Эфемерно. Агент задаёт пользователю вопрос.

user_input.completed

Эфемерно. Запрос пользователя был решен.

elicitation.requested

Эфемерно. Агенту нужен структурированный ввод формы от пользователя (протокол идентификации MCP).

elicitation.completed

Эфемерно. Запрос на расследование был урегулирован.

События субагентов и навыков

subagent.started

Был вызван таможенный агент как субагент.

subagent.completed

Субагент успешно закончил.

subagent.failed

Субагент столкнулся с ошибкой.

subagent.selected

Был выбран (вывод) пользовательский агент для обработки текущего запроса.

subagent.deselected

Пользовательский агент был снят с выбора и вернулся к стандартному агенту. Полезная нагрузка данных пуста ({}).

skill.invoked

Для текущего разговора был активирован навык.

Другие события

abort

Текущий поворот был прерван.

user.message

Пользователь отправил сообщение. Записано для хронологии сессии.

system.message

В разговор вводился подсказка системы или разработчика.

external_tool.requested

Эфемерно. Агент хочет вызвать внешний инструмент (предоставленный потребителем SDK).

external_tool.completed

Эфемерно. Запрос на внешний инструмент был урегулирован.

exit_plan_mode.requested

Эфемерно. Агент составил план и хочет выйти из режима плана.

exit_plan_mode.completed

Эфемерно. Запрос на режим выхода был урегулирован.

command.queued

Эфемерно. Для выполнения была поставлена слэш-команда.

command.completed

Эфемерно. Была решена очередная команда.

Краткая справка: агентный поток поворотов

Типичный агентный ход генерирует события в следующем порядке:

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)

Все типы событий одним взглядом