Saltearse al contenido

Modo de flujo de eventos JSON

Ventana de terminal
pi --mode json "Your prompt"

Emite todos los eventos de sesión como líneas JSON a stdout. Útil para integrar pi en otras herramientas o UIs personalizadas.

Los eventos están definidos en AgentSessionEvent:

type AgentSessionEvent =
| AgentEvent
| { type: "queue_update"; steering: readonly string[]; followUp: readonly string[] }
| { type: "compaction_start"; reason: "manual" | "threshold" | "overflow" }
| { type: "compaction_end"; reason: "manual" | "threshold" | "overflow"; result: CompactionResult | undefined; aborted: boolean; willRetry: boolean; errorMessage?: string }
| { type: "auto_retry_start"; attempt: number; maxAttempts: number; delayMs: number; errorMessage: string }
| { type: "auto_retry_end"; success: boolean; attempt: number; finalError?: string };

queue_update emite las colas completas de steering y follow-up pendientes cada vez que cambian. compaction_start y compaction_end cubren tanto la compactación manual como la automática.

Eventos base de 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 };

Mensajes base de packages/ai/src/types.ts:

  • UserMessage (línea 134)
  • AssistantMessage (línea 140)
  • ToolResultMessage (línea 152)

Mensajes extendidos de packages/coding-agent/src/core/messages.ts:

  • BashExecutionMessage (línea 29)
  • CustomMessage (línea 46)
  • BranchSummaryMessage (línea 55)
  • CompactionSummaryMessage (línea 62)

Cada línea es un objeto JSON. La primera línea es la cabecera de sesión:

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

Seguida de eventos a medida que ocurren:

{"type":"agent_start"}
{"type":"turn_start"}
{"type":"message_start","message":{"role":"assistant","content":[],...}}
{"type":"message_update","message":{...},"assistantMessageEvent":{"type":"text_delta","delta":"Hello",...}}
{"type":"message_end","message":{...}}
{"type":"turn_end","message":{...},"toolResults":[]}
{"type":"agent_end","messages":[...]}
Ventana de terminal
pi --mode json "List files" 2>/dev/null | jq -c 'select(.type == "message_end")'