- 使用现成的聊天运行时,而不是自己连接
stream.messages - 自定义服务器端点,可以在已部署图形旁边添加特定于提供商的逻辑
- 从受限组件注册表渲染结构化生成式 UI
有关 CopilotKit 特定的 API、UI 模式和运行时配置,请参阅 CopilotKit 文档。
工作原理
从高层次来看,CopilotKit 位于您的 React 应用和 LangGraph 部署之间。前端将对话状态发送到与图形 API 并行挂载的自定义/api/copilotkit 路由,该路由将请求转发到 LangGraph,响应返回时包含助手消息和组件注册表可以渲染的任何结构化 UI 负载。
- 照常部署图形,使用 LangSmith 或使用 LangGraph 开发服务器。
- 使用 HTTP 应用扩展部署,在图形 API 旁边挂载 CopilotKit 路由。
- 在前端包装
CopilotKit并将其指向自定义运行时 URL。 - 注册动态 UI 组件并在渲染时将助手响应解析为这些组件。
安装
后端端点:使用自定义端点扩展 LangGraph 部署
关键思想是 LangGraph 部署不仅服务于图形。它还可以加载 HTTP 应用,让您可以在部署本身旁边挂载额外的路由。 在langgraph.json 中,将 http.app 指向您的自定义应用入口点:
FastAPI 应用并通过 CopilotKit 的 AG-UI 桥接暴露 LangGraph 代理:
main.py
useAgentContext(...) 中的 output_schema 转发到模型的structured output 配置。
src/middleware.py
- LangGraph 仍然拥有图形执行和持久化
- CopilotKit 拥有面向聊天的运行时契约
- 您的自定义端点在一次部署中将它们粘合在一起
构建前端应用结构
在前端,将您的应用包装在CopilotKit 中并将其指向自定义运行时 URL:
runtimeUrl="/api/copilotkit"将聊天发送到您的自定义后端路由,而不是直接发送到原始 LangGraph APIuseAgentContext(...)将 UI schema 发送到代理,以便模型知道它应该产生什么structured output 格式
注册动态组件
组件注册表位于useChatKit() 中。这是您定义代理可以发出的组件集的地方,例如卡片、行、列、图表、代码块和按钮。
将助手消息渲染为动态 UI
助手响应到达后,自定义消息渲染器决定如何显示它。在此示例中:- 助手消息根据 UI 工具包 schema 解析为结构化 JSON
- 有效的结构化输出渲染为真正的 React 组件
- 用户消息渲染为普通聊天气泡
- CopilotKit 处理聊天状态和传输
- 自定义渲染器决定助手负载如何成为 UI
- Hashbrown 将验证的结构化数据转换为具体的 React 元素
最佳实践
- 保持自定义端点精简: 仅使用它来使 CopilotKit 适应您的图形部署,而不是复制图形内部已有的业务逻辑
- 显式发送 schema: 每次页面挂载时,
useAgentContext应该描述 UI 契约 - 注册受限的组件集: 仅公开您实际希望模型使用的组件和 props
- 将渲染视为解析步骤: 在渲染之前根据 schema 解析助手内容
- 保持用户消息简单: 只有助手消息需要结构化渲染器;用户消息可以保持普通聊天气泡

