第八部分,协议与框架开发

JSON Event Stream 数据模型

解析 Agent、Turn、Message、Tool、Queue、Compaction 和 Retry 事件,构建可靠消费者。

事件类型

JSON 模式第一行是 Session header,随后输出 agent_start、turn、message、tool execution 和 agent_end 等事件。Pi 还增加 queue、compaction、retry 与 summarization retry 事件。

message_update 是增量事件,不应直接作为最终消息持久化。message_end 才代表完整消息。

  • 使用 type 字段分派。
  • 未知事件保持向前兼容。
  • 按 toolCallId 关联工具事件。
  • 处理中断时的部分消息。
  • 记录 Session id 与版本。

消费与存储

UI 可以消费 text_delta 获得即时反馈,后台系统应在 message_end 和 agent_end 更新最终状态。

事件日志可能包含代码和工具结果,必须执行访问控制、脱敏和保留期限。

官方资料

本页由 xueai 根据 Pi 官方资料用中文重新组织和讲解。Pi 更新频繁,命令、包名和接口以官方最新文档为准。

Pi 源代码和官方文档采用 MIT License。Copyright (c) 2025 Mario Zechner。本站保留原版权与许可声明,完整文本见 MIT License