跳转到主要内容
文档构建工作流AI 助手

使用 AI 助手编排

Slash 命令、Workflow Diff、10 级撤销栈 —— 在自然语言下完成工作流的创建、修改、重构。

Braidrun 的 AI 助手不是一个外挂工具条 —— 它直接理解当前页面的 YAML、DAG、运行状态,能改 workflow、能触发执行、能安装 skill、能切语言。下面是上手与日常用法。

在哪里打开

  • 右下角浮动按钮(所有主页面可用)
  • 快捷键 Alt + G

抽屉内是一个流式对话面板,支持 Markdown / 代码高亮(12 种语言)和 slash 命令。

可以让它做什么

  • 创建 / 修改 / 验证 / 执行 workflow
  • 创建、启用、停用 schedule
  • 刷新或安装 skill
  • 切换界面语言
  • 回答 "这个系统支持什么 / 某个配置怎么写 / 某个 API 怎么用" 这类系统性问题

Slash 命令

text
/execute               # run the current workflow (alias: /run)
/validate              # validate YAML without running
/export                # download workflow YAML
/new                   # start a fresh workflow
/undo                  # roll back the last assistant change (up to 10)
/help                  # list all slash commands

在输入框里以 "/" 开头即可触发。slash 命令优先级高于自由文本,而且直接调用平台接口、不经过模型 —— 不占用 AI 助手的每日配额。在编辑器 / 工作流列表等页面,输入框上方还会出现对应的快捷按钮。

Diff 预览与撤销栈

所有对 workflow / schedule / credential 等资源的变更都会先给你 Diff 预览:

  • 新增的步骤 / 字段标绿
  • 修改的字段标黄
  • 删除的步骤 / 字段标红

确认后可随时用 /undo 回退,最多保留最近 10 步修改。会话本身也可以一键导出为 Markdown。

与编辑器的联动

  • 在编辑器里让助手搭建 / 修改工作流时,画布会按操作顺序逐步呈现每一处改动:新增节点、连线一步一步出现,你能看着工作流长出来;改动依然要你点保存才落库。
  • 编辑器的诊断问题面板可以把单条或全部问题「交给 AI 修复」,步骤属性面板也有入口带着当前步骤的上下文直接打开助手 —— 不用自己复制粘贴 YAML。
  • 助手改的每一步也会进编辑器自己的撤销 / 重做历史,Ctrl / Cmd + Z 可以逐步回退。

编辑器各区域的完整说明见 可视化编辑器

准备:配置你的 AI 助手

第一次用之前先去 账号设置 → AI 助手 开启并选择模型 provider(例如 OpenRouter、OpenAI、Anthropic、DeepSeek),或在 Claude Code / Codex 区域配置订阅模型。真正的 secret 放在 凭据管理 → 我的凭据 维护,运行时会按当前账号自动解析。管理员不需要为普通用户预先配置 AI 助手。

与 workflow 顶层 globalAgent 的区别

/api/workflows/assistant/chat/api/global-agent/chat 使用的是当前登录用户自己的 AI 助手配置。它不是 workflow 顶层 globalAgent 字段的直接执行入口。

Claude Code / Codex 模型

如果你希望 AI 助手调用 Claude Code 或 Codex,请在「账号设置 → AI 助手 → Claude Code / Codex」里选择认证方式:

  • Claude Code:可使用 Anthropic API Key,也可使用 Claude 订阅 Token(provider=claude_code_oauth)。
  • Codex:可使用 OpenAI API Key,也可使用 Codex 订阅 auth.json(provider=codex_subscription)。
  • 订阅模式不会把 token/auth.json 写进 AI 助手配置;只会从你的个人凭据或团队凭据读取。

文档知识库

要让 AI 助手回答系统文档问题(例如 "manual_approval 的 timeout 默认多少"),去 设置 → 平台持久化存储 → AI 助手文档知识库 确认它已经启用。默认会索引内置 guides、项目主文档和精选 reference docs,并默认启用启动时自动构建;同一页面可以查看状态并手动点击 "重建知识库"。

"思考过程" 流式(Reasoning Streaming)

当所选模型支持 reasoning(Claude Sonnet 4.5 / 4.6 / 4.7、DeepSeek-R1、GPT-o1 / o3 系列、Gemini Thinking 等),AI 助手抽屉会先显示一个折叠的"AI 助手的思考过程"卡片,模型先把推理摘要流到这里,再生成最终回答:

  • reasoning_delta 事件被客户端折叠,不会刷屏(避免每帧重渲染)
  • 完整推理只在 reasoning_complete 时以 thinking 子分类渲染
  • 点击思考卡片可以展开 / 收起;默认收起,避免占据视野
  • 思考内容也会跟随 /undo 一起被记到撤销栈里,方便复盘

不支持 reasoning 的模型不会显示任何额外卡片,行为与之前一致。

长期记忆(Long-Term Memory)

AI 助手默认每个会话独立。如果你希望它"记住"你的偏好("我喜欢中文回答 + 简短 markdown"、"我的 ASA 工作流总是凌晨跑"),可以在 AI 助手配置里开启 Long-Term Memory:

  • 开启后用户消息和助手回复会被向量化存入跨会话的 ltm:<user_id>:* 命名空间
  • 下一轮对话开始时,会自动检索 top-K 相关记忆作为上下文注入
  • AI 助手侧边栏右上角有"清除长期记忆"按钮,POST /api/global-agent/memory/clear 一键清空当前用户的所有 namespace;适合换设备 / 切团队时使用
默认记忆范围

默认记忆仅覆盖当前运行环境,重启或多实例部署时可能不会共享。需要跨实例长期记忆时,请在平台运行配置中启用托管状态存储,或由管理员接入自定义存储适配。

小提示

  • 如果你希望 AI 生成 YAML:显式要求它输出 snake_case YAML
  • 分支流:优先让它生成 classifier + condition 的结构
  • 大段改动:用自然语言描述意图,然后让它拆成多步 Diff
  • 结合 调试器 :把 AI 改完的 workflow 先启用 debug 跑一次 dry-run 再上线
  • 选支持 reasoning 的模型时,能直接看到"思考过程",调试 prompt 设计很有用