跳轉到主要內容
文件參考術語表

術語表

平台所有專有名詞、縮寫、英中對照。讀其他文件時有疑惑就回來查一下。

平臺所有專有名詞、縮寫、常見英中對照。按首字母排序,閱讀其他文檔時有疑惑就回來查一下。

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
平臺內所有"用戶動作 + 系統事件"的結構化日誌。管理員後臺可查,默認保留無限期。

B

斷點 / Breakpoint
偵錯器中可設定的暫停位置,共 9 類:步驟前、步驟後、步驟出錯、狀態機狀態、群聊輪次、迭代項、agent_based 派發、子工作流入口、子工作流出口。中斷點可附加條件運算式,命中後 execution 暫停,可檢視 + 編輯變數。
BYOK
Bring Your Own Key。用戶自帶 LLM Provider 的 API Key,token 成本計到用戶自己賬戶,不佔平臺額度。

C

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 運算式(分 時 日 月 週)。每個排程項目帶獨立的時區設定;多執行個體部署下由分散式鎖保證同一時刻只觸發一次。

D

DAG
Directed Acyclic Graph。平臺的可視化建模視圖。每個節點是一個 step,邊表示執行順序 / 數據依賴。與 YAML 字節級雙向同步。
DTO
Data Transfer Object。JSON API 的載荷格式,用 camelCase;對應的 YAML 用 snake_case。平臺運行時自動雙向轉換。
Dry-run
執行時的一種選項。走數據流、填變量、跑非副作用步驟(LLM / 真發消息)被跳過。用於驗證 DAG 連通性。

E

執行 / Execution
一個 workflow 的一次具體運行實例。狀態機:PENDING → RUNNING → (COMPLETED / FAILED / CANCELLED / INTERRUPTED / TIMED_OUT)。
extract
step 字段。用 JSONPath 從 step 的原始輸出裡挑出若干字段,存到 .data 子節點,供下游精確引用。

F-G

FeatureGate
按訂閱 plan(Free / Pro / Team / Enterprise)控制功能可用性與資源配額的服務。決定你能建幾個 workflow、幾條調度、能不能用 debugger。
group_chat
一種步驟類型。多個 Agent 按輪次發言,互相參考上下文。適合頭腦風暴、批判性評審。

H-I

HMAC
Webhook 触发的兼容认证方式。外部调用方用共享密钥对 raw body 算 HMAC-SHA256,以 sha256=<hex> 格式放进 X-Webhook-Signature 头。新接入建议直接用带 WEBHOOK_TRIGGER 范围的 API Key。
idempotent
step 字段。承諾"同樣輸入 → 同樣輸出、無副作用"。開啟 auto-resume 時,已完成的 idempotent step 可跳過重做。

M

manual_approval
一種步驟類型(也可作為任意步驟的增強)。執行流程卡在這裡等管理員批准 / 拒絕。可配通知 channel 與 approvers 列表。
MCP
Model Context Protocol。跨工具的標準協議。Braidrun 可以作為 MCP Client 消費外部 MCP Server 的工具,也能以 MCP Server 模式對外暴露自己的能力。
模塊 / Module
實作了 WorkflowModuleContract 的 workflow。可以透過 sub_workflow step 被其他 workflow 當成黑盒呼叫。市集裡有 120+ 個可安裝的模組。
資料遷移
平台升級時自動執行的資料結構遷移流程;跨實例以分散式鎖定保證只有一個節點執行。

P

Preset
Agent 模板。把"模型 + 默認工具集 + system prompt + max_iterations + 策略"一起打包成命名模板。平臺內置 universal / coder / researcher / writer / planner / reviewer 等。
Provider
LLM 服務商。OpenAI / Anthropic / DeepSeek / Kimi / OpenRouter 等。一個 provider 可綁定多把 API Key(憑據)。

R

RAG
Retrieval-Augmented Generation。Agent 工具集的一類,對內置知識庫做向量檢索。平臺把檢索結果自動塞進 Agent 的 context。
Recovery Policy
自動續跑的策略選項:ABORT(不續) / RESUME_FROM_LAST_INCOMPLETE(從被中斷那步續) / RESUME_FROM_START(從頭再跑)。
Round-trip(雙向同步)
YAML → DAG → YAML 完整保持字節級等價。不丟註釋、順序、格式。

S

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)作為黑盒。帶契約校驗、環路檢測、變量隔離。

T-U

Team
一組用戶的集合。共享憑據命名空間、共享調度額度。Team Admin 可管理成員 + 憑據。
Tool
Agent 可以在 LLM 推理過程中調用的函數。內置 + MCP 擴展。
TPM
Tokens Per Minute。LLM provider 的限流指標。平臺內部有 TPM 自限,避免打爆上游。

V-W

Variable Reference
{{...}} 語法。可引用 var:* / steps.id.* / classifier.* / credentials.* 四種源。
Webhook
由外部系統 POST 觸發工作流執行的 endpoint。以 API Key 認證為主,HMAC 簽章作為相容方式。請求主體頂層欄位預設自動對應為 workflow 變數,也可用 variableMapping 顯式指定。
Workflow
一組按 DAG 組織的 step 的集合。可由手動 / cron / webhook / API 觸發。用 YAML 持久化存儲。

Y

YAML
平臺的工作流持久化格式。字段走 snake_case(與 DTO 的 camelCase 自動映射)。可以在 CLI(braidrun-agent)裡直接跑,同一份 YAML 在 Web UI 裡也能編輯。