Настройка, расширение, параметры платформы и справочник API для Pi.

JSON Режим потока событий

pi --mode json "Your prompt"

Выводит все события сеанса в виде строк от JSON до stdout. Полезно для интеграции pi в другие инструменты или пользовательские интерфейсы.

Типы событий

В событиях Wire используется JsonAgentSessionEvent. Это соответствует AgentSessionEvent за исключением того, что в потоковых обновлениях сообщений не учитываются накопительные снимки:

type WithoutPartial<T> = T extends { partial: unknown } ? Omit<T, "partial"> : T;

type JsonAgentSessionEvent =
  | Exclude<AgentSessionEvent, { type: "message_update" }>
  | {
      type: "message_update";
      assistantMessageEvent: WithoutPartial<AssistantMessageEvent>;
    };

queue_update выдает все ожидающие очереди управления и отслеживания при каждом их изменении. compaction_start и compaction_end охватывают как ручное, так и автоматическое уплотнение.

Другие базовые события происходят из AgentEvent:

type AgentEvent =
  // Agent lifecycle
  | { type: "agent_start" }
  | { type: "agent_end"; messages: AgentMessage[] }
  // Turn lifecycle
  | { type: "turn_start" }
  | { type: "turn_end"; message: AgentMessage; toolResults: ToolResultMessage[] }
  // Message lifecycle
  | { type: "message_start"; message: AgentMessage }
  | { type: "message_update"; message: AgentMessage; assistantMessageEvent: AssistantMessageEvent }
  | { type: "message_end"; message: AgentMessage }
  // Tool execution
  | { type: "tool_execution_start"; toolCallId: string; toolName: string; args: any }
  | { type: "tool_execution_update"; toolCallId: string; toolName: string; args: any; partialResult: any }
  | { type: "tool_execution_end"; toolCallId: string; toolName: string; result: any; isError: boolean };

Типы сообщений

Базовые сообщения от packages/ai/src/types.ts:

  • UserMessage (строка 134)
  • AssistantMessage (строка 140)
  • ToolResultMessage (строка 152)

Расширенные сообщения от packages/coding-agent/src/core/messages.ts:

  • BashExecutionMessage (строка 29)
  • CustomMessage (строка 46)
  • BranchSummaryMessage (строка 55)
  • CompactionSummaryMessage (строка 62)

Выходной формат

Каждая строка представляет собой объект JSON. Первая строка — это заголовок сеанса:

{"type":"session","version":3,"id":"uuid","timestamp":"...","cwd":"/path"}

Далее следуют события по мере их возникновения:

{"type":"agent_start"}
{"type":"turn_start"}
{"type":"message_start","message":{"role":"assistant","content":[],...}}
{"type":"message_update","assistantMessageEvent":{"type":"text_delta","contentIndex":0,"delta":"Hello"}}
{"type":"message_end","message":{...}}
{"type":"turn_end","message":{...},"toolResults":[]}
{"type":"agent_end","messages":[...]}

message_update записи содержат только дельту. Они опускают как совокупное поле message, так и assistantMessageEvent.partial, чтобы сохранить линейный размер потока. Используйте contentIndex и delta. собрать живой текст, размышления или аргументы, если это необходимо. message_end содержит последнее авторитетное сообщение.

Пример

pi --mode json "List files" 2>/dev/null | jq -c 'select(.type == "message_end")'