詞彙表¶
本術語表定義 Headquarter.ai 文件中使用的關鍵術語和概念。
英文術語與畫面中文標籤對照
本平台繁體中文介面多以中文標籤顯示,文件為對照原始概念而保留英文詞條。常見對照:Workflow →「工作流程」、Action →「動作」(編輯器右上選單)、Next State →「下一個狀態」、Configuration Panel →「設定面板」(內部名 Workflow State Form)、Execution Settings →「執行設定」(為「設定」分頁中的可展開區塊,非頂部分頁)、Error Handling →「錯誤處理」(頂部分頁)、Catch →「捕捉」、Retry →「重試」、Input/Output Schema →「輸入結構/輸出結構」、Run Application →「執行應用程式」、Note →「附註」。少數按鈕(如「Test Action」)在平台上維持英文顯示。各詞條下方另有個別說明。
核心概念¶
Workflow¶
由連接的 Action 組成的有向圖,定義一個自動化流程。Workflow 接受輸入,透過一系列 Action 處理,並產生輸出。每個 workflow 都有一個 Start 節點(進入點)和一個 End 節點(離開點)。
Action¶
Workflow 中的單一工作單元。Action 執行特定操作,例如呼叫 LLM、查詢資料庫或轉換資料。每個 Action 都有設定選項,並透過 Next State 連接到其他 Action。
State¶
在執行期間流經 workflow 的資料上下文。每個 Action 都可以讀取和寫入 state。State 資料可透過 JSONPath 運算式存取(例如 $.fieldName)。
Resource¶
外部服務或功能的可重用設定。Resource 只需定義一次,可在多個 workflow 中使用。例如 LLM 連線、資料庫 connector 和 retriever。
Workflow 元件¶
Start 節點¶
Workflow 的進入點。定義 Input Schema - workflow 被呼叫時接受的資料結構。
End 節點¶
Workflow 的離開點。定義 Output Schema - workflow 完成時回傳的資料結構。
Input Schema¶
定義 workflow 或 Action 接受的輸入欄位和資料類型。Schema 支援 String、Number、Boolean、Array 和 Object 等類型。
Output Schema¶
定義 workflow 或 Action 回傳的輸出欄位和資料類型。用於過濾和結構化最終結果。
Next State(下一個狀態)¶
決定當前 Action 完成後執行哪個 Action 的設定,畫面上顯示為「下一個狀態」。可以指向單一 Action 或多個 Action(用於平行執行)。
Execution Settings(執行設定)¶
節點設定面板「設定」分頁中的一個可展開區塊(與「進階任務設定」並列),不是頂部分頁。實際包含「上傳輸出至外部記憶體」、「在任務開始階段開啟即時輸出串流」、「在任務結束階段開啟即時輸出串流」(兩個分開的勾選框)、「錯誤時中止」等選項,不含逾時欄位,也不含重試設定(重試在「錯誤處理」分頁,見 Retry)。
資料處理¶
JSONPath¶
用於瀏覽 JSON 資料結構的查詢語言。在 Headquarter.ai 中用於引用 workflow state 中的值。語法:$.path.to.field。
常見模式:
$.question- 存取頂層欄位$.action_name.result- 存取 Action 的輸出$.items[0]- 存取陣列的第一個元素$.user.profile.name- 存取巢狀欄位
External Memory¶
處理超過正常 state 限制的大型資料的機制。資料儲存在外部並透過 URI 引用。適用於處理大型文件或 API 回應。
State Memory Output Selector¶
指定 Action 輸出中應保留在 workflow state 中哪些欄位的設定,有助於管理 state 大小並減少資料傳輸(最佳實踐頁中亦簡稱為「Output Selector」)。它對應工作流程定義 JSON 中的 state_memory_output_selector 欄位;目前節點設定面板沒有一個字面叫此名稱的欄位,主要透過工作流程定義來指定。
Action 類型¶
LLM Action¶
呼叫大型語言模型,根據設定的訊息(提示詞)產生文字。支援 system、user 和 assistant 訊息角色。
Structured LLM Action¶
回傳符合定義的 Output Schema 的結構化資料的 LLM Action。使用 JSON 模式或 function calling 確保一致的輸出格式。
Lambda Action¶
在 workflow 中執行自訂 Python 程式碼。用於資料轉換、條件邏輯和自訂處理。
Retriever Action¶
根據搜尋查詢在 knowledge base 中尋找相關文件。回傳排序後的文件區塊,用於 RAG workflow。
MCP Action¶
呼叫 MCP(Model Context Protocol)server 公開的工具。實現與外部工具和服務的整合。
Pass Action¶
不修改 state 直接傳遞的控制流 Action。適用於彙整平行分支或明確路由。
Resource 類型¶
LLM Resource¶
連接大型語言模型供應商的設定。包括供應商選擇、模型名稱、API 憑證和預設參數。
Connector Resource¶
連接外部資料來源(如資料庫 MySQL、OpenSearch)或 API 的設定。儲存連線字串和驗證資訊。
Retriever Resource¶
文件檢索的設定,包括搜尋策略、embedding 模型和連接的 knowledge base。
Knowledge Base Resource¶
可使用 retriever 搜尋的索引文件集合。支援各種文件格式和分塊策略。
Embedding Model Resource¶
將文字轉換為向量嵌入的模型設定。由 retriever 用於語意搜尋。
MCP Server Resource¶
連接提供外部工具和功能的 MCP server 的設定。
Template Resource¶
具有變數佔位符的可重用文字範本。用於標準化 workflow 中的提示詞和訊息。
RAG(檢索增強生成)¶
RAG¶
一種透過先從 knowledge base 檢索相關資訊,然後將該資訊作為 LLM 上下文來增強 LLM 回應的技術。
Retrieval¶
根據查詢從 knowledge base 尋找並回傳相關文件的過程。
Grounding¶
確保 LLM 回應基於檢索到的事實資訊而非生成的知識的做法。
Document¶
在 knowledge base 中索引的內容片段。文件通常被分割成較小的 chunk 以實現更精確的檢索。
Chunk¶
文件的片段,通常是幾個段落或一個章節。Chunk 是檢索操作回傳的單位。
Ranker¶
根據與查詢的相關性重新排序檢索到的文件的元件。透過優先顯示最相關的結果來提高檢索品質。
執行¶
Workflow Execution¶
使用特定輸入的單次 workflow 執行。每次執行都有唯一的 ID 並追蹤狀態、時間和結果。
Synchronous Execution¶
等待完成後才回傳的 workflow 呼叫。呼叫者會阻塞直到結果可用。
Asynchronous Execution¶
立即回傳執行 ID 的 workflow 呼叫。結果可以稍後使用 Describe Workflow Execution 檢索。
Execution Status(執行狀態)¶
Workflow 執行的當前狀態。平台介面上的「狀態」值以中文顯示,對照如下:
- 執行中(RUNNING)- 執行中
- 成功(SUCCEEDED)- 成功完成
- 失敗(FAILED)- 執行失敗
- 逾時(TIMED_OUT)- 超過時間限制
Retry(重試)¶
失敗 Action 的自動重新執行。設定位置在節點設定面板的「錯誤處理」分頁 →「重試」→「新增重試器」(不在「執行設定」),包括重試次數(Max Retry Count)、間隔(Retry Interval)和退避率(Backoff Rate)選項。
Timeout¶
Action 或 workflow 完成的最大允許時間。超過此限制會導致 TIMED_OUT 狀態。
整合¶
MCP(Model Context Protocol)¶
將 AI 模型連接到外部工具、資料來源和服務的協定。提供工具發現和執行的標準化介面。
Tool¶
MCP server 公開的功能,可從 workflow 呼叫。工具有定義的輸入和輸出。
API¶
應用程式介面。在 Headquarter.ai 中,通常指透過 HTTPS API Action 呼叫的外部 HTTP 服務。
Webhook¶
由外部事件觸發的 HTTP 回呼。可用於從外部系統啟動 workflow 執行。
UI 術語¶
Canvas(畫布)¶
透過放置和連接 Action 節點來設計 workflow 的視覺化編輯器,畫面上稱為「畫布」。
Configuration Panel(設定面板)¶
選取節點時自右側出現的面板,顯示該 Action 的所有可設定選項(內部無障礙名稱為 Workflow State Form)。面板上方有「設定/輸入與輸出/錯誤處理」三個分頁。(「執行設定」不是分頁,而是「設定」分頁裡的一個可展開區塊,見 Execution Settings。)
Test Action¶
允許單獨測試單一 Action 而無需執行整個 workflow 的功能。位於設定面板右上角,此按鈕在平台上維持英文「Test Action」顯示。
Run Application(執行應用程式)¶
手動執行 workflow 並使用自訂輸入、查看結果的功能。它不是一個獨立介面,而是工作流程「動作」選單中的項目/詳細頁上的按鈕,畫面上顯示為中文「執行應用程式」(點擊後會在新分頁開啟執行畫面)。
動作(Actions 選單)¶
工作流程編輯器右上角的選單按鈕,顯示為「動作」。展開後包含「更新」「執行應用程式」「下載定義」「設定排程」等項目(請勿與工作流程中的工作單元 Action 混淆)。
更新 / 草稿已儲存¶
「更新」是「動作」選單中的項目,把目前編輯內容正式儲存生效。編輯過程中畫面會自動顯示「草稿已儲存」,但那只是暫存草稿,與正式「更新」是兩件不同的事。
錯誤處理(Error Handling)¶
節點設定面板中的分頁,內含「重試」(Retry)與「捕捉」(Catch)兩種錯誤處理機制。重試與其欄位(Max Retry Count 等)即在此分頁設定。
捕捉(Catch)¶
「錯誤處理」分頁中的機制,用來在某個 Action 失敗時,把流程導向另一條處理路徑(例如改走備援步驟),而非讓整個 workflow 直接失敗。
InputPath / ResultSelector / ResultPath / OutputPath¶
節點設定面板「輸入與輸出」分頁中,控制資料在該步驟進出方式的四個欄位:
- InputPath:挑選傳進這個 Action 的輸入資料範圍。
- ResultSelector:從這個 Action 的原始結果中,挑選/重組要保留的欄位。
- ResultPath:決定把結果寫回 state 的哪個位置(例如
$.LLMActionResult)。注意:改動作名稱後 ResultPath 不會自動更新,需手動調整。 - OutputPath:挑選最後要往下一步傳出的資料範圍。
多數情境用預設即可,新手通常不需修改。
附註(Note)¶
節點設定中的純文字多行輸入欄位,用來替該步驟寫備忘說明(外觀看似程式碼框,但只是純文字,可忽略行號)。
進階任務設定¶
設定面板中可展開的進階區塊,收納較少用到的選項(例如 LLM 的 Guardrail 版本等),新手通常維持預設即可。
依賴資源 / 被依賴資源¶
「依賴資源」指這個項目用到的其他資源;「被依賴資源」指有哪些其他項目反過來用到它。用於了解修改或刪除某資源時的影響範圍。