@ag-ui/编码器
事件编码工具 代理用户互动(AG-UI)议定书。 。 。 .
@ag-ui/encoder 处理 AG-UI 事件的内容谈判和格式编码。 它根据客户端自动选择服务器-恒星事件(JSON)和协议缓冲 Accept 标头,确保优化运输效率.
安装
npm install @ag-ui/encoder zod
pnpm add @ag-ui/encoder zod
yarn add @ag-ui/encoder zod
zod(3.25.18+或4.x)是一种同级依赖. Protobuf 编码验证
与计划相关的事件 @ag-ui/core/schemas,使用 zod 应用程序
安装而不是捆绑的副本.
特征
- 🎯 内容谈判 - 以
Accept页眉 - 📦 双重编码 - SSE(JSON)和协议缓冲支持
- ⚡ 高效二进制 - 高通量情景的长度前置原生编码
- 🔄 无缝回落 - 在不支持原生生物的情况下 将基因降解为SSE
快速实例
import { EventEncoder } from "@ag-ui/encoder";
import { EventType } from "@ag-ui/core";
const encoder = new EventEncoder({
accept: "application/vnd.ag-ui.event+proto, text/event-stream",
});
const event = {
type: EventType.TEXT_MESSAGE_CONTENT,
messageId: "msg_123",
delta: "Hello, world!",
};
// Returns protobuf-encoded binary data
const encoded = encoder.encodeBinary(event);
文档
- 概念和结构 :
docs/concepts - 完整 API 参考 :
docs/sdk/js/encoder
捐款
欢迎虫子报告和拉出请求! 请读我们的 贡献指南 先说.
许可证
《麻省理工学院2025 AG-UI议定书》