JSON Modo de transmisión de eventos
pi --mode json "Your prompt"Genera todos los eventos de la sesión como JSON líneas a stdout. Útil para integrar pi en otras herramientas o interfaces de usuario personalizadas.
Tipos de eventos
Los eventos de cable utilizan JsonAgentSessionEvent. coincide
AgentSessionEvent
excepto que las actualizaciones de mensajes en streaming omiten instantáneas acumulativas:
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 emite todas las colas de dirección y seguimiento pendientes cada vez que cambian. compaction_start y compaction_end cubren la compactación tanto manual como automática.
Otros eventos base provienen 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 };Tipos de mensajes
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)
Formato de salida
Cada línea es un objeto JSON. La primera línea es el encabezado de la sesión:
{"type":"session","version":3,"id":"uuid","timestamp":"...","cwd":"/path"}Seguido de los acontecimientos a medida que ocurren:
{"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 los registros son solo delta. Omiten tanto el campo acumulativo message como
assistantMessageEvent.partial para mantener lineal el tamaño de la transmisión. Utilice contentIndex y delta
para reunir argumentos de texto en vivo, pensamiento o llamada de herramientas si es necesario. message_end contiene
el mensaje final autorizado.
Ejemplo
pi --mode json "List files" 2>/dev/null | jq -c 'select(.type == "message_end")'