Konfiguration, Anpassung, Plattform-Einrichtung und API-Referenzen für Pi.

JSON Ereignis-Stream-Modus

pi --mode json "Your prompt"

Gibt alle Sitzungsereignisse als JSON-Zeilen bis stdout aus. Nützlich für die Integration von Pi in andere Tools oder benutzerdefinierte Benutzeroberflächen.

Ereignistypen

Wire-Ereignisse verwenden JsonAgentSessionEvent. Es passt AgentSessionEvent mit der Ausnahme, dass Streaming-Nachrichtenaktualisierungen kumulative Snapshots auslassen:

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 gibt bei jeder Änderung die vollständigen ausstehenden Lenkungs- und Folgewarteschlangen aus. compaction_start und compaction_end decken sowohl die manuelle als auch die automatische Verdichtung ab.

Andere Basisereignisse stammen aus 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 };

Nachrichtentypen

Basisnachrichten von packages/ai/src/types.ts:

  • UserMessage (Zeile 134)
  • AssistantMessage (Zeile 140)
  • ToolResultMessage (Zeile 152)

Erweiterte Nachrichten von packages/coding-agent/src/core/messages.ts:

  • BashExecutionMessage (Zeile 29)
  • CustomMessage (Zeile 46)
  • BranchSummaryMessage (Zeile 55)
  • CompactionSummaryMessage (Zeile 62)

Ausgabeformat

Jede Zeile ist ein JSON-Objekt. Die erste Zeile ist der Sitzungsheader:

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

Gefolgt von den Ereignissen, sobald sie eintreten:

{"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 Datensätze sind nur Delta-Datensätze. Sie lassen sowohl das kumulative message-Feld als auch weg assistantMessageEvent.partial, um die Streamgröße linear zu halten. Verwenden Sie contentIndex und delta um bei Bedarf Live-Text, Denk- oder Tool-Call-Argumente zusammenzustellen. message_end enthält die endgültige maßgebliche Botschaft.

Beispiel

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