Pi の設定、拡張、プラットフォーム設定、API リファレンス。

JSON イベントストリームモード

pi --mode json "Your prompt"

すべてのセッション イベントを JSON 行から stdout として出力します。 pi を他のツールまたはカスタム UI に統合するのに役立ちます。

イベントの種類

ワイヤーイベントは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_startcompaction_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 はストリーム サイズを線形に保ちます。 contentIndexdelta を使用します 必要に応じて、ライブ テキスト、思考、またはツール呼び出しの引数を組み立てます。 message_end が含まれています 最後の権威あるメッセージ。

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