SuperAPI AI 工具集

ag-ui-protocol

通用与其它

查看项目

更新于 10-16 08:49

技能介绍

用途:AG-UI 标准化长时间运行的智能体后端与面向用户的前端之间的事件流。它针对的是「我的应用如何展示智能体在做什么、与其共享状态、并允许用户打断」,而非工具卡片渲染格式;当作者自己掌控前端时使用 AG-UI,若前端是他人聊天宿主则用 MCP Apps,两者可组合。

主要能力:核心接口为 run(input: RunAgentInput) -> Observable<BaseEvent>。RunAgentInput 携带线程与运行标识、消息历史、可用工具、上下文与转发属性;每个 BaseEvent 含 type、可选的 timestamp 与 rawEvent,rawEvent 在作为翻译层时保留原始框架事件便于调试。事件分类包括:生命周期(RunStarted、RunFinished、RunError、StepStarted、StepFinished,其中 parentRunId 用于子智能体嵌套);文本消息(TextMessageStart/Content/End 及紧凑形式 TextMessageChunk);工具调用(ToolCallStart/Args/End/Result 及 ToolCallChunk,Args 为分片 JSON,需在 End 前视为不完整);状态(StateSnapshot 完整快照、StateDelta 为 RFC 6902 JSON Patch、MessagesSnapshot 完整历史,建议连接时及失步后用快照,其间用增量);活动(ActivitySnapshot、ActivityDelta,用于进度与状态展示);推理(ReasoningStart/End、ReasoningMessageStart/Content/End/Chunk 及 ReasoningEncryptedValue,后者须原样回传、不可解析);特殊事件(Raw、Custom 扩展点、草案 MetaEvent)。协议提供实时流、可取消与恢复、共享状态、生成式 UI、人在环中断与智能体引导等能力。

使用方式:服务端 Python 使用 ag_ui.core 与 ag_ui.encoder,需把请求的 Accept 头传入 EventEncoder 以选择 SSE 或二进制协议;TypeScript 使用 @ag-ui/core 与 @ag-ui/client 的 AbstractAgent、HttpAgent。顺序契约固定为 RunStarted → 内容事件 → RunFinished 或 RunError,缺少终止事件会让前端一直等待。前端 CopilotKit 原生支持 AG-UI;此外还有 Kotlin、Go、Dart、Java、Rust 等 SDK 及 LangGraph、CrewAI 等框架集成。

限制与说明:资料未提供收费、价格或平台信息;具体接入细节需参考原始文档。