文档参考术语表

术语表

平台所有专有名词、缩写、英中对照。读其他文档时有疑惑就回来查一下。

平台所有专有名词、缩写、常见英中对照。按首字母排序，阅读其他文档时有疑惑就回来查一下。

A

agent_based: 一种步骤类型。一个 orchestrator Agent 阅读任务描述，动态决定把子任务派给哪个 worker Agent。适合任务多分支、每个分支都需要 LLM 判断的场景。
Agent: 封装了一次 LLM 会话及其可用工具的实体。Braidrun 里 Agent 由 preset 声明，按需 overrides。它本身不是 step —— step 的某些类型（single / group_chat / classifier 等）会引用 Agent。
API Key: LLM provider 发的鉴权密钥。平台里作为 Credential 存储，永远加密，永远不出现在日志。
Artifact（产物）: step 运行期间生成的文件（Markdown、Excel、图像、JSON 等）。存到平台的产物目录，可在 execution 详情页下载。
审计日志 / Audit Log: 平台内所有"用户动作 + 系统事件"的结构化日志。管理员后台可查，默认保留无限期。

断点 / Breakpoint: 调试器中可设置的暂停位置，共 9 类：步骤前、步骤后、步骤出错、状态机状态、群聊轮次、迭代项、agent_based 派发、子工作流入口、子工作流出口。断点可附加条件表达式，命中后 execution 暂停，可检视 + 编辑变量。
BYOK: Bring Your Own Key。用户自带 LLM Provider 的 API Key，token 成本计到用户自己账户，不占平台额度。

classifier: 一种步骤类型。LLM 对输入打一个类别标签，输出可通过 {{classifier.category}} 供后续 step 用作路由条件。
code: 一种步骤类型。Python / Bash / TypeScript 脚本在隔离沙箱中执行，确定性 > LLM 的场景首选。
Condition: step 级别的布尔表达式。为 false 时 step 被标为 SKIPPED，跳过执行。下游可以用 {{steps.x.status}} 检测是否跳过。
Credential（凭据）: AES-256-GCM 加密存储的外部密钥。按用户 / 团队 / 系统三级命名空间解析。永远不出现在日志或 YAML 导出。
cron: 定时触发器的一种。接受标准 5 段 cron 表达式（分时日月周）。每个调度条目带独立的时区设置；多实例部署下由分布式锁保证同一时刻只触发一次。

DAG: Directed Acyclic Graph。平台的可视化建模视图。每个节点是一个 step，边表示执行顺序 / 数据依赖。与 YAML 字节级双向同步。
DTO: Data Transfer Object。JSON API 的载荷格式，用 camelCase；对应的 YAML 用 snake_case。平台运行时自动双向转换。
Dry-run: 执行时的一种选项。走数据流、填变量、跑非副作用步骤（LLM / 真发消息）被跳过。用于验证 DAG 连通性。

执行 / Execution: 一个 workflow 的一次具体运行实例。状态机：PENDING → RUNNING → (COMPLETED / FAILED / CANCELLED / INTERRUPTED / TIMED_OUT)。
extract: step 字段。用 JSONPath 从 step 的原始输出里挑出若干字段，存到 .data 子节点，供下游精确引用。

FeatureGate: 按订阅 plan（Free / Pro / Team / Enterprise）控制功能可用性与资源配额的服务。决定你能建几个 workflow、几条调度、能不能用 debugger。
group_chat: 一种步骤类型。多个 Agent 按轮次发言，互相参考上下文。适合头脑风暴、批判性评审。

HMAC: Webhook 触发的兼容认证方式。外部调用方用共享密钥对 raw body 算 HMAC-SHA256，以 sha256=<hex> 格式放进 X-Webhook-Signature 头。新接入建议直接用带 WEBHOOK_TRIGGER 范围的 API Key。
idempotent: step 字段。承诺"同样输入 → 同样输出、无副作用"。开启 auto-resume 时，已完成的 idempotent step 可跳过重做。

manual_approval: 一种步骤类型（也可作为任意步骤的增强）。执行流程卡在这里等管理员批准 / 拒绝。可配通知 channel 与 approvers 列表。
MCP: Model Context Protocol。跨工具的标准协议。Braidrun 可以作为 MCP Client 消费外部 MCP Server 的工具，也能以 MCP Server 模式对外暴露自己的能力。
模块 / Module: 实现了 WorkflowModuleContract 的 workflow。可以通过 sub_workflow step 被其他 workflow 作为黑盒调用。市场里有 120+ 个可安装的模块。
数据迁移: 平台升级时自动执行的数据结构迁移流程；跨实例用分布式锁保证只有一个节点执行。

Preset: Agent 模板。把"模型 + 默认工具集 + system prompt + max_iterations + 策略"一起打包成命名模板。平台内置 universal / coder / researcher / writer / planner / reviewer 等。
Provider: LLM 服务商。OpenAI / Anthropic / DeepSeek / Kimi / OpenRouter 等。一个 provider 可绑定多把 API Key（凭据）。

RAG: Retrieval-Augmented Generation。Agent 工具集的一类，对内置知识库做向量检索。平台把检索结果自动塞进 Agent 的 context。
Recovery Policy: 自动续跑的策略选项：ABORT（不续） / RESUME_FROM_LAST_INCOMPLETE（从被中断那步续） / RESUME_FROM_START（从头再跑）。
Round-trip（双向同步）: YAML → DAG → YAML 完整保持字节级等价。不丢注释、顺序、格式。

single: 一种步骤类型。单个 Agent + 一条 task 描述。最轻量的 LLM 调用原语。
Sandbox（沙箱）: code step 的执行环境。生产下使用一次性隔离沙箱，最小权限 / 只读根 / 出站网络。
Schedule: 把某个 workflow 定时触发的条目。支持 cron / interval / one-time 三类。每条 Schedule 可预设输入参数 + 时区。
Skill: 可被 Agent 调用的工具。内置的 rag / web / file / shell，或用户自定义从 MCP server 注册进来的工具。
SSE: Server-Sent Events。execution 的实时事件流协议，浏览器 EventSource 直接订阅。每个事件是一行结构化 JSON。
Step: workflow 的最小执行单元。每个 step 只能选 1 种主模式（single / group_chat / agent_based / code / classifier / state_machine / sub_workflow / manual_approval），可叠加 condition / retry / extract / aggregate / idempotent / on_success / on_failure 等增强。
state_machine: 一种步骤类型。内嵌多个 state + 状态转移条件，适合多轮反复或工作流内含小流程。
sub_workflow: 一种步骤类型。调用另一个 workflow（或内置 module）作为黑盒。带契约校验、环路检测、变量隔离。

Variable Reference: {{...}} 语法。可引用 var:* / steps.id.* / classifier.* / credentials.* 四种源。
Webhook: 由外部系统 POST 触发工作流执行的 endpoint。以 API Key 认证为主，HMAC 签名作为兼容方式。请求体顶层字段默认自动映射为 workflow 变量，也可用 variableMapping 显式指定。
Workflow: 一组按 DAG 组织的 step 的集合。可由手动 / cron / webhook / API 触发。用 YAML 持久化存储。

YAML: 平台的工作流持久化格式。字段走 snake_case（与 DTO 的 camelCase 自动映射）。可以在 CLI（braidrun-agent）里直接跑，同一份 YAML 在 Web UI 里也能编辑。