@godspideai/cognate-ag-ui (英语)
AG-UI 1.0 互操作性适配器:将 Cognate 运行的可持久事件流作为SSE上的 schema-valid AG-UI 事件进行项目,并将 AG-UI 的动作(消息、工具结果、批准、取消)映射到运行时间 RuntimeService 与运输认证呼叫器.
何时使用此软件包 : a 一个 乌干达 客户端( 或任何说 AG- UI 事件语法的 SSE 消费者) 应驱动您的 Cognate 代理 。 它是可选的边界——原生的Cognate执行和UI工作没有它的改变,Cognate的内部事件从未被改写为AG-UI的别名. 关于A2A特工,请看 @godspeedai/cognate-a2a。 。 。 .
安装
bun add @godspeedai/cognate-ag-ui
要求数 阿宝 1.4.0. 取决于 @ag-ui/core, (中文(简体) ), @ag-ui/encoder,以及服务类型 @godspeedai/cognate-runtime-api; 配对 @godspeedai/cognate-runtime-bun 对于运行时间本身.
快开始
import { createAgUiHandler } from "@godspeedai/cognate-ag-ui";
import { createRuntime } from "@godspeedai/cognate-runtime-bun";
const runtime = await createRuntime({
store: "./app.sqlite",
agents: [/* your AgentDefinitions */],
policy,
actions,
});
const handler = createAgUiHandler({
service: runtime.service,
defaultAgent: "agent.copilot", // agent started for new user messages
authenticate: (headers) => myBearerAuth(headers), // Caller | undefined
});
Bun.serve({ port: 3000, fetch: handler });
一个客户端 POST 一个AG-UI RunAgentInput 并读取SSE流:
const response = await fetch("http://127.0.0.1:3000/", {
method: "POST",
headers: { "content-type": "application/json", authorization: "Bearer alice", accept: "text/event-stream" },
body: JSON.stringify({
threadId: "t-1",
runId: "r-1",
messages: [{ id: "m1", role: "user", content: "I was double charged" }],
tools: [],
context: [],
state: {},
forwardedProps: {},
}),
});
// response.body streams AG-UI events: RUN_STARTED, TEXT_MESSAGE_*, STATE_*, RUN_FINISHED, ...
未认证的请求获得 HTTP 401; a ServiceError 从入境行动到 RUN_ERROR 带有服务错误代码的事件.
入境行动
处理器从最后一个用户/工具消息读取意向以及从 forwardedProps.cognate数字 :
| 投入 | 采取的行动 |
|---|---|
最后一个消息与 role: "user" | 开始运行 forwardedProps.cognate.agent (或 defaultAgent; 消息文本和 context 成为运行中的输入; 非空 state 种子共享状态 |
最后一个消息与 role: "tool" | 解决前端可操作性或远程出价续作 toolCallId 与解析 content |
forwardedProps.cognate.resolve | 解决续作continuationId, (中文(简体) ), action "resume"编号 :"cancel", (中文(简体) ), input选项 expectedVersion(中文(简体) ) |
forwardedProps.cognate.cancel | 取消线程当前运行 |
forwardedProps.cognate.cursor | 从持久事件位置恢复 SSE 流 |
所有运行开始为一个 AG-UI 线程共享关联 id, 所以即使服务器重启后, 解析/ 取消/ 重新连接到线程最近的运行 。 未知或已过期的光标触发一个完整的再同步( S)RUN_STARTED, (中文(简体) ), MESSAGES_SNAPSHOT, (中文(简体) ), STATE_SNAPSHOT,然后是新的事件。 断开 HTTP 流不会取消持久运行 .
继续绘图
- 前端能力延续( U)
type: "frontend:<capability>"项目作为TOOL_CALL_START编号 :ARGS编号 :END与toolCallId设置为继用 id; 客户端的role: "tool"消息解决了它. - A 类
human_approval继续项目CUSTOM已命名的事件cognate.continuation,使一个通用客户端能够通过forwardedProps.cognate.resolve。 。 。 . - 没有忠实的AG-UI代表项目的续作
CUSTOMcognate.unsupported_interaction和运行RUN_FINISHED报告status: "waiting_unsupported"改为"waiting"。 。 。 . - 工艺品(AG-UI 1.0无文物活动)项目
CUSTOMcognate.artifact。 。 。 .
事件报道
matrix 全部记录 31 AG-UI 1.0 EventType 数值,每行一行:输出(RUN_STARTED编号 :RUN_FINISHED编号 :RUN_ERROR, (中文(简体) ), TEXT_MESSAGE_*, (中文(简体) ), TOOL_CALL_*, (中文(简体) ), STATE_SNAPSHOT编号 :STATE_DELTA, (中文(简体) ), MESSAGES_SNAPSHOT, (中文(简体) ), CUSTOM和科格纳特尚不能生产的 _CHUNK 手势, ACTIVITY_*, (中文(简体) ), RAW, (中文(简体) ), STEP_*, (中文(简体) ), REASONING_*, (中文(简体) ), SUBAGENT_*),每个都有原因. ignoredFrameworkEvents 列出有意不投影的Cognate事件类型.
为了直接使用, createProjector({ threadId, runId }) 将命令的持久事件折叠成 AG-UI 事件(push附加时 snapshot()编号 :stateOnly() 用于重新连接),以及 threadCorrelationId(threadId) 给出关联 id 组合一条线程.
限制
- 一个适配器,一个真理的方向:持久相干事件是源;AG-UI输出是投影. AG-UI 客户端除通过外不发送任何记录
RuntimeService行动. - 模式文本流经
TEXT_MESSAGE_*;没有推理/思考通道,亚剂筑巢,或原始事件传递. TOOL_CALL_ARGS(a) 有效载荷被去除后,即成为{}。 。 。 .
相关软件包
@godspeedai/cognate-react财务报告和审定财务报表@godspeedai/cognate-ui-astryx——无头反应约束和参考UI对同一份客户合同.@godspeedai/cognate-a2a——A2A协议适配器.@godspeedai/cognate-profile-copilot——基于此端点的由构成的交互式聊天应用程序.@godspeedai/cognateSDK伞.
许可证
阿帕奇 - 2.0