CopilotKit 提供了一个完整的 React 聊天运行时,当您希望智能体返回结构化 UI 负载而非仅返回纯文本时,它与 LangGraph 的配合尤为出色。在此模式下,您的 LangGraph 部署同时服务图形 API 和一个自定义的 CopilotKit 端点,而前端则将助手消息解析为动态的 React 组件。 在服务器端,copilotkit 包提供了 CopilotKitMiddleware,使得 LangGraph 图形、LangChain 智能体或 Deep Agent 能够遵循 Agent UI (AG-UI) 线路协议,将工具和消息事件流式传输到聊天 UI,并读写共享的 CopilotKit 状态切片,同时提供辅助函数以便在您的图形前端挂载一个与 CopilotKit 兼容的 HTTP 端点。 当您需要以下功能时,这种方法非常有用:
  • 一个现成的聊天运行时,而不是自己手动接线 stream.messages
  • 一个自定义的服务器端点,可以在部署的图形旁边添加特定于提供商的行为
  • 从受限组件注册表渲染的结构化生成式 UI
CopilotKit for LangGraph 文档还介绍了基于同一中间件和客户端的 生成式 UI、人在回路中 (HITL) 和共享状态。
有关 CopilotKit 特定的 API、UI 模式和运行时配置,请参阅 CopilotKit 文档。有关 Deep Agent 的演练,请参阅 CopilotKit 文档中的 Deep Agents and CopilotKit。

工作原理

从高层次看,CopilotKit 位于您的 React 应用和 LangGraph 部署之间。前端将对话状态发送到挂载在图形 API 旁边的自定义 /api/copilotkit 路由,该路由将请求转发给 LangGraph,而响应则会返回助手消息以及您的组件注册表可以渲染的任何结构化 UI 负载。
  1. 照常部署图形:使用 LangSmith 或 LangGraph 开发服务器。
  2. 使用 HTTP 应用扩展部署:在图形 API 旁边挂载一个 CopilotKit 路由。
  3. 将前端包装在 CopilotKit 中:并将其指向该自定义运行时 URL。
  4. 注册动态 UI 组件:并在渲染时将助手响应解析为这些组件。

安装

后端端点:
前端应用:

使用自定义端点扩展 LangGraph 部署

核心思想是 LangGraph 部署不仅仅服务图形。它还可以加载一个 HTTP 应用,这使您能够在部署本身旁边挂载额外的路由。 在 langgraph.json 中,将 http.app 指向您的自定义应用入口点:
然后创建 Hono 应用并注册 CopilotKit 路由:
app.ts
这个自定义应用是关键的扩展点:它在不替换底层 LangGraph 部署的情况下,挂载了一个支持 CopilotKit 的运行时。 在该路由内部,创建一个 CopilotRuntime,并使用 LangGraphAgent 将其指回部署的图形:
copilotkit.ts
路由适配器只是 TypeScript 设置的一半。您的 LangChain 智能体还需要一个中间件来读取转发的 output_schema 并将其转换为模型要遵循的结构化 responseFormat:
agent.ts
正是这个中间件使得前端的 useAgentContext({ description: "output_schema", ... }) 发挥作用。CopilotKit 运行时转发了该架构,而智能体将其转换为模型必须遵循的结构化输出契约。 结果是清晰的关注点分离:
  • LangGraph 仍然负责图形执行和持久化
  • CopilotKit 负责面向聊天的运行时契约
  • 您的自定义端点将它们粘合在一次部署中
遵循 CopilotKit 文档中关于 Node CopilotRuntime 中的 LangGraphHttpAgent 或 LangGraphAgent 的说明;Python 端的图形和中间件仍然定义工具行为和智能体逻辑。 :::

构建前端应用

在前端,将您的应用包装在 CopilotKit 中,并将其指向自定义运行时 URL:
这里有两个重要部分:
  • runtimeUrl="/api/copilotkit" 将聊天发送到您的自定义后端路由,而不是直接发送到原始的 LangGraph API
  • useAgentContext(...) 将 UI 架构发送给智能体,以便模型知道应该产生什么结构化输出格式

注册动态组件

组件注册表位于 useChatKit() 中。在此您定义允许智能体发出的组件集合,例如卡片、行、列、图表、代码块和按钮。
这个注册表成为了智能体与 UI 之间的契约。模型不是在生成任意的 JSX,而是在生成必须根据您暴露的组件和属性进行验证的结构化数据。

将助手消息渲染为动态 UI

一旦助手响应到达,自定义消息渲染器将决定如何显示它。在此示例中:
  • 助手消息根据 UI 套件架构被解析为结构化 JSON
  • 有效的结构化输出被渲染为真实的 React 组件
  • 用户消息被渲染为普通的聊天气泡
这种渲染器模式使得集成感觉很原生:
  • CopilotKit 处理聊天状态和传输
  • 自定义渲染器决定助手负载如何成为 UI
  • Hashbrown 将经过验证的结构化数据转换为具体的 React 元素

资源

最佳实践

  • 保持自定义端点轻量: 用它来将 CopilotKit 适配到您的图形部署,而不是复制图形内部已有的业务逻辑
  • 显式发送架构: useAgentContext 应在每次页面挂载时描述 UI 契约
  • 注册受限的组件集: 只暴露您确实希望模型使用的组件和属性
  • 将渲染视为解析步骤: 在渲染助手内容之前,根据您的架构对其进行解析
  • 保持用户消息为纯文本: 只有助手消息需要结构化渲染器;用户消息可以保持为普通的聊天气泡