英文原文正文为项目原始 README(英文),本站后续会翻译为中文,当前仅剔除图片与无关章节并统一排版。
Copilot套件
文档 · 示例 · CopilotKit 智能 · Discord
构建代理原生应用 —— 支持任何框架,任何界面。
为 React、Angular、Vue、React Native 以及 Slack 和 Microsoft Teams 提供生成式用户界面、共享状态和人类参与的工作流。
在投入生产时添加CopilotKit 智能:具有生成式用户界面的丰富线程、用户记忆,以及能够从实际使用中自动学习的代理。
什么是 CopilotKit?
CopilotKit 是一个一流的 SDK,用于构建全栈智能应用程序、生成式用户界面和聊天应用程序。
最初作为一个 React 库,现在已成为连接您的代理和用户之间的水平层:同一个代理可以为您的网页应用、移动应用,以及您的团队在 Slack 或 Microsoft Teams 的工作空间提供支持。
我们是AG-UI 协议 背后的公司——该协议已被 Google、LangChain、AWS、Microsoft、Mastra、PydanticAI 等采纳!
快速开始
与您的编码代理进行设置
使用您的编码代理将 CopilotKit 添加到您的应用程序中。它将检查您的项目并指导集成。
给您的编码代理以下提示:
Help me get started with CopilotKit. From the root of my project, run this
command and follow the instructions:
npx --yes copilotkit@latest onboard start
想使用我们的代理技能吗?
已经在使用 CopilotKit 或刚完成设置?添加我们的 代理技能 来帮助你的编码代理构建功能并调试问题。
npx copilotkit@latest skills install
开始一个新项目
在它自己的目录中搭建一个项目。它不会修改你已经拥有的应用。
npx copilotkit@latest create
https://github.com/user-attachments/assets/7372b27b-8def-40fb-a11d-1f6585f556ad
你可以构建的内容
https://github.com/user-attachments/assets/72b7b4f3-b6e7-460c-a932-5746fe3c8db3
功能:
- 聊天界面 – 完全可自定义的聊天界面,支持消息流、工具调用和智能代理响应。
- 后端工具渲染 – 使智能代理可以调用后端工具,并在客户端直接呈现 UI 组件。
- 生成式 UI – 允许智能代理根据用户意图和代理状态在运行时动态生成和更新 UI 组件。
- 共享状态 – 同步状态层,智能代理和 UI 组件可以实时读取和写入。
- 人机协作 – 让智能代理在执行中暂停以请求用户输入、确认或编辑,然后再继续。
- 丰富会话 – 对话可以在重新加载、不同设备和会话中保持,生成式 UI 保持完整。
- 自动学习 – 智能代理从实际使用中改进:已完成的会话成为已审查的技能,无需微调流程。
🪁 CopilotKit 智能
CopilotKit 智能 为您的智能代理增加了丰富会话、生成式 UI、用户记忆、产品分析、检查和自动学习。它可与现有的 CopilotKit 应用和代理框架配合使用。可使用我们的托管平台或部署在您自己的基础设施中。
- 丰富会话 – 会话可在重新加载、不同设备和会话中保留,消息、生成式 UI 和实时运行都按原样恢复。
- 用户记忆 – 在会话间保留的持久事实和偏好,通过语义而非关键词进行调用。
- 自动学习 – 已完成的会话成为有证据支持的洞察和经过审核的、可复用的技能,由您自行发布。无需微调流程。
- 产品分析 – 查看智能代理的行为和用户的价值点,使用相同的交互数据。
- 自托管 – 在您自己的 Kubernetes 集群、VPC 或数据边界内使用相同的平台。
查看 智能概览 了解每个计划包含的内容。
它是如何工作的
CopilotKit 将您的用户界面、代理和工具连接到单一的交互循环中。
这使得:
- 代理可以向用户询问输入
- 工具可以渲染用户界面
- 跨步骤和会话的有状态工作流程
- 一个代理,可部署在网页、移动和聊天平台上
🧩 与你的技术栈兼容
一个代理后端。每个前端。
| 平台 | 状态 | 开始使用 |
|---|---|---|
| ⚛️ React / Next.js | ✅ GA | 快速入门 |
| 🅰️ Angular | ✅ 支持 | 源代码 & 快速入门 |
| 💚 Vue | ✅ 支持 | 源代码 - 快速入门即将推出 |
| 📱 React Native | ✅ 支持 | 快速入门 |
| 💬 Slack / Microsoft Teams | ✅ 支持 | 频道 · 快速入门 |
| 💬 Discord / WhatsApp / Telegram | ✅ 频道 SDK 适配器(托管连接即将推出) | 频道 |
| 🔜 Google 聊天 / iMessage / 短信 | 🟡 路线图中 | 频道 |
你的代理逻辑保持不变 — AG-UI 处理底层协议,CopilotKit 为每个框架和频道处理 UI 层。
💬 渠道:一个代理,每个聊天应用
Channels SDK 将你已经构建的代理直接集成到用户常用的聊天应用中——相同的工具、相同的共享状态、相同的人类干预,无需重写 (了解更多)。
- Slack – 将代理作为一等 Slack 应用:在频道中处理线程、工具调用以及人类审批。
- Microsoft Teams – 将代理化工作流带入企业环境,你的组织已经在这里使用。
⭐️ useAgent 钩子
useAgent 钩子直接在 AG-UI 上工作,让你对代理连接进行完全的程序化控制。
// Programmatically access and control your agents
const { agent } = useAgent({ agentId: "my_agent" });
// Render and update your agent's state
return <div>
<h1>{agent.state.city}</h1>
<button onClick={() => agent.setState({ city: "NYC" })}>
Set City
</button>
</div>
查看 useAgent 文档 了解更多信息。
https://github.com/user-attachments/assets/67928406-8abc-49a1-a851-98018b52174f
生成式用户界面
生成式用户界面(Generative UI)是 CopilotKit 的核心模式之一,它允许代理在其工作流程中动态渲染用户界面。
https://github.com/user-attachments/assets/3cfacac0-4ffd-457a-96f9-d7951e4ab7b6
比较三种类型
探索:
🖥️ AG-UI:代理–用户交互协议
将代理工作流程连接到面向用户的应用程序,与代理栈中的深度合作伙伴及第一方集成——包括 LangChain、CrewAI、Mastra、PydanticAI 等。
启动一个新的 AG-UI 代理应用程序:
npx create-ag-ui-app my-agent-app
🤝 社区
- 更新内容
有问题或需要帮助?
加入我们的 Discord →
阅读文档 →
尝试 CopilotKit 智能 →及时了解我们的最新发布!
🙋🏽♂️ 贡献
感谢您有兴趣为 CopilotKit 做出贡献!💜
我们重视所有的贡献,无论是通过代码、文档、创建演示应用,还是仅仅传播消息。
这里有一些有用的资源可以帮助您入门:
- 关于代码贡献,请参阅 CONTRIBUTING.md。
- 关于文档相关的贡献,请查看 文档贡献指南。
- 想要贡献但不确定如何开始?加入我们的 Discord,我们会帮助您!
📄 许可
本存储库的源代码可根据 MIT 许可证 使用。