Files
aiagent/docs/user-manual.md

365 lines
12 KiB
Markdown
Raw Normal View History

# 📖 天工智能体平台 — 用户使用手册
> **User Manual** — 面向终端用户的完整操作指南
本文档涵盖天工智能体平台全部核心功能的使用说明,适合所有用户阅读。
---
## 一、平台概览
天工智能体平台是一个 AI Agent 搭建与工作流编排平台,支持:
- **可视化工作流设计**:拖拽节点,连线编排,无需编码
- **智能 Agent 创建**:配置 LLM + 工具 + 记忆,打造专属数字员工
- **知识库 RAG**:上传文档,智能检索增强回答
- **飞书 Bot 集成**6 个飞书 Bot 实时交互
- **模板市场**11 个行业模板一键创建 Agent
### 浏览器要求
| 浏览器 | 版本 |
|--------|------|
| Chrome | 90+ |
| Edge | 90+ |
| Firefox | 88+ |
| Safari | 14+ |
---
## 二、快速入门
### 2.1 登录
1. 访问前端地址(默认 `http://localhost:8038`
2. 输入默认账号:`admin` / `123456`
3. 登录后进入主控台
### 2.2 界面导览
```
┌──────────────────────────────────────────────────┐
│ 侧边栏 │ 主内容区 │
│ ├ 主控台 │ │
│ ├ Agent 管理 │ (根据左侧菜单显示对应页面) │
│ ├ 工作流管理 │ │
│ ├ 知识库 │ │
│ ├ 执行记录 │ │
│ ├ 模板市场 │ │
│ ├ 监控告警 │ │
│ ├ 系统日志 │ │
│ └ 用户设置 │ │
└──────────────────────────────────────────────────┘
```
### 2.3 创建第一个 Agent5 分钟体验)
**方式一:模板市场一键创建(推荐)**
1. 进入「模板市场」
2. 选择一个模板(如"智能客服"
3. 点击「一键创建 Agent」
4. 系统自动生成 Agent 和工作流,立即可用
**方式二:从零开始**
1. 进入「Agent 管理」→ 点击「新建 Agent」
2. 填写:名称、描述、选择 LLM 模型
3. 进入工作流设计器,拖拽节点搭建流程
4. 点击「部署」发布
---
## 三、Agent 管理
### 3.1 Agent 列表
进入「Agent 管理」,查看所有已创建的 Agent
| 信息 | 说明 |
|------|------|
| 名称 | Agent 唯一标识 |
| 状态 | 草稿 / 已发布 / 运行中 / 已停止 |
| 模型 | 使用的 LLMGPT-4o / DeepSeek / Claude 等) |
| 创建时间 | 首次创建日期 |
| 操作 | 编辑 / 使用 / 部署 / 停止 / 删除 |
### 3.2 创建 Agent
点击「新建 Agent」配置以下参数
**基础设置**
- **名称**:给 Agent 一个有意义的名称
- **描述**:说明 Agent 的用途和能力(影响路由决策)
- **头像**:可选上传
**模型配置**
- **LLM 模型**选择底层大模型GPT-4o / DeepSeek-V3 / Claude Opus 等)
- **Temperature**控制输出随机性0=精确, 1=创意)
- **Max Tokens**:单次最大输出长度
- **系统提示词**:定义 Agent 的角色和行为规范
**工具配置**
- **启用工具**:勾选 Agent 可调用的工具(如 file_write、web_search、http_request 等)
- **需审批工具**:默认包含 11 个危险工具deploy_push、send_email、git_push 等),执行前需人工审批
**高级设置**
- **启用记忆**:开启后 Agent 在对话间保持上下文
- **记忆范围**:个人 / 团队
- **定时任务**:设置 Agent 自动执行的 Cron 表达式
- **回退模型**:当主模型不可用时自动切换备选模型
### 3.3 部署与使用
1. 在工作流设计器完成编排后,点击「部署」
2. 状态变为「已发布」,出现「使用」按钮
3. 点击「使用」进入对话界面
4. 在聊天框输入需求Agent 自动执行工作流并返回结果
### 3.4 状态说明
| 状态 | 说明 | 可执行 |
|------|------|:------:|
| 草稿 (draft) | 编辑中,尚未部署 | 仅所有者可测试 |
| 已发布 (published) | 已部署,可对外使用 | ✅ |
| 运行中 (running) | 正在执行任务 | ✅ |
| 已停止 (stopped) | 手动停止 | ❌ |
---
## 四、工作流设计器
### 4.1 界面布局
```
┌─────────────────────────────────────────────────┐
│ 工具栏:[添加节点] [撤销] [重做] [缩放] [保存] │
├──────────────────────┬──────────────────────────┤
│ 画布区 │ 节点配置面板(右侧) │
│ │ │
│ ┌───┐ ┌───┐ │ 选中节点后显示配置项: │
│ │触发│──→│LLM│ │ - 提示词模板 │
│ └───┘ └───┘ │ - 工具选择 │
│ │ │ - 输出处理 │
│ ↓ │ - 重试策略 │
│ ┌───┐ │ │
│ │输出│ │ │
│ └───┘ │ │
└──────────────────────┴──────────────────────────┘
```
### 4.2 节点类型
| 节点类型 | 图标 | 功能说明 |
|----------|:----:|----------|
| 触发器 (trigger) | ▶️ | 工作流入口,接收用户输入 |
| LLM 节点 | 🧠 | 调用大模型进行推理/生成 |
| 工具节点 | 🔧 | 调用特定工具执行操作 |
| 条件分支 | 🔀 | 根据条件走不同分支 |
| 循环节点 | 🔄 | 遍历数组或重复执行 |
| 子工作流 | 📦 | 嵌套调用另一个工作流 |
| 评估器 | ✅ | 输出质量验证,不合格可路由回源头 |
| 编排器 | 🎯 | 多 Agent 编排(串行/并行/辩论/流水线/DAG |
| 输出节点 | 📤 | 工作流终点,整理最终输出 |
### 4.3 常用操作
| 操作 | 快捷键 / 方式 |
|------|--------------|
| 添加节点 | 从左侧面板拖拽 或 右键画布 |
| 连接节点 | 从节点输出端拖线到目标输入端 |
| 删除连线 | 选中连线按 Delete |
| 移动画布 | 鼠标中键拖拽 或 空格+拖拽 |
| 缩放画布 | Ctrl + 滚轮 |
| 保存 | Ctrl + S |
| 撤销 | Ctrl + Z |
| 重做 | Ctrl + Shift + Z |
### 4.4 节点配置详解
**LLM 节点**
- **系统提示词**:定义 LLM 的角色(必填)
- **用户提示词模板**:用 `{{变量名}}` 引用上游输出
- **Temperature**:可覆盖 Agent 级设置
- **输出格式**:纯文本 / JSON / Markdown
**工具节点**
- **选择工具**:从 56 个内置工具中选择
- **参数绑定**:将上游输出映射到工具参数
- **超时时间**:工具执行最大等待时间(秒)
**条件分支**
- **条件表达式**:支持 Jinja2 模板语法
- **多分支**:可配置多个条件路径
- **默认分支**:无匹配时的兜底路径
**重试配置**(所有节点通用)
- **最大重试次数**:失败后重试 N 次
- **重试间隔**:每次重试的等待秒数
- **错误处理**retry重试/ notify通知/ stop停止
---
## 五、知识库
### 5.1 上传文档
1. 进入「知识库」→ 点击「上传文档」
2. 支持格式PDF、TXT、Markdown、Word、Excel、HTML
3. 上传后自动切片并生成向量嵌入
4. 可在 Agent 配置中关联知识库
### 5.2 知识检索
- Agent 在执行任务时自动检索关联知识库
- 检索方式:语义相似度匹配
- 知识进化Celery 定时任务每小时自动从对话中提取新知识入库
### 5.3 知识仪表盘
- **文档数量**:总文档数及增长趋势
- **知识条目**:自动提取的知识点数量
- **引用次数**:知识被 Agent 检索的次数排行
- **类别分布**:知识按类别统计
---
## 六、模板市场
### 6.1 浏览模板
进入「模板市场」查看 11 个行业模板:
| 模板名称 | 适用场景 |
|----------|----------|
| 智能客服 | 自动回答客户问题,支持知识库 RAG |
| 研发日报 | 自动汇总 Git 提交,生成日报 |
| PR Review | 自动审查代码 PR给出改进建议 |
| 面试调度 | 自动安排面试时间,发送通知 |
| 竞品监控 | 定期抓取竞品信息,生成分析报告 |
| 测试报告 | 分析测试结果,生成质量报告 |
| 入职引导 | 新员工问答助手,帮助快速上手 |
| 风险预警 | 监控数据异常,自动告警 |
### 6.2 使用模板
1. 浏览模板详情(功能说明、工作流预览)
2. 可自定义参数名称、Temperature、启用的工具
3. 点击「一键创建」→ 自动生成 Agent + 工作流
4. 进入工作流设计器微调(如需)
---
## 七、对话与协作
### 7.1 Agent Chat
在 Agent 设计器右侧面板直接对话:
- **文本输入**输入需求Enter 发送Shift+Enter 换行
- **实时响应**Agent 逐步执行工作流,实时显示进度
- **多轮对话**Agent 保持上下文,支持追问
- **语音输入**:移动端支持语音输入(点击麦克风图标)
- **语音播报**Agent 回复支持 TTS 朗读
### 7.2 飞书 Bot
平台提供 6 个飞书 Bot在飞书中直接与 Agent 对话:
- **天工**:主力 Bot
- **橙子**:辅助 Bot
- **苏瑶**:指定场景 Bot
- **甜甜苏瑶3号**:扩展场景 Bot
- **灵犀**:学习助手
- **人参果**AI 学习助手KG+RAG 版)
配置方式参见《飞书智能体配置手册》。
### 7.3 移动端
访问 `/mobile-chat` 路径可使用移动端优化版聊天界面,支持:
- 响应式布局,适配手机屏幕
- 语音输入/播报
- PWA 安装到桌面
- 浏览器推送通知
---
## 八、执行与监控
### 8.1 执行记录
进入「执行记录」→ 查看所有 Agent/工作流的执行历史:
- **状态**:运行中 / 已完成 / 失败
- **耗时**:总执行时间
- **节点详情**:每个节点的输入/输出/耗时
- **错误信息**:失败原因及堆栈
### 8.2 监控面板
进入「监控告警」→ 查看系统运行状态:
- **请求量**API 调用统计
- **错误率**:失败占比
- **响应时间**:平均/ P50 / P99 延迟
- **Agent 活跃度**:各 Agent 使用频率
### 8.3 告警规则
进入「告警规则」→ 配置告警条件:
- **指标**:错误率、响应时间、执行失败次数
- **阈值**:超过多少触发告警
- **通知方式**:站内通知 / 飞书消息
- **静默期**:重复告警的最小间隔
---
## 九、用户设置
### 9.1 个人资料
- 修改用户名、邮箱
- 修改密码
- 上传头像
### 9.2 API Key 管理
可在个人设置中配置自己的 LLM API Key优先使用个人 Key未配置时回退到系统全局 Key
### 9.3 飞书绑定
进入「飞书绑定」→ 将平台账号与飞书账号关联,实现飞书内单点登录和使用。
---
## 十、附录
### A. 术语表
| 术语 | 说明 |
|------|------|
| Agent | 具备 LLM + 工具 + 记忆的 AI 智能体 |
| 工作流 (Workflow) | 由多个节点组成的有向无环图 (DAG) |
| 节点 (Node) | 工作流中的基本执行单元 |
| RAG | 检索增强生成,从知识库中检索信息增强回答 |
| LLM | 大语言模型(如 GPT-4、DeepSeek |
| HITL | 人在回路,危险操作需人工审批 |
| Celery | 异步任务队列,负责 Agent/工作流执行 |
| ReAct | Reasoning + ActingAgent 的推理-行动循环 |
### B. 快捷键汇总
| 快捷键 | 功能 |
|--------|------|
| Ctrl + S | 保存工作流 |
| Ctrl + Z | 撤销 |
| Ctrl + Shift + Z | 重做 |
| Ctrl + 滚轮 | 缩放画布 |
| Delete | 删除选中节点/连线 |
| Enter | 发送消息 |
| Shift + Enter | 消息换行 |
---
> 最后更新2026-06-14 | 适用版本 v1.0+