跳至主要內容

Run 類別

Run 類別代表 Workflow 執行個體,提供啟動、繼續、串流及監控 Workflow 執行的方法。

使用範例
「使用範例」的直接連結

const run = await workflow.createRun()

const result = await run.start({
inputData: { value: 'initial data' },
})

if (result.status === 'suspended') {
const resumedResult = await run.resume({
resumeData: { value: 'resume data' },
})
}

Run 方法
「Run 方法」的直接連結

start:

(options?: StartOptions) => Promise<WorkflowResult>
以輸入資料啟動 Workflow 執行

resume:

(options?: ResumeOptions) => Promise<WorkflowResult>
從特定步驟繼續已暫停的 Workflow

stream:

(options?: StreamOptions) => MastraWorkflowStream
以事件串流監控 Workflow 執行,並提供增強的串流功能

resumeStream:

(options?: ResumeStreamOptions) => MastraWorkflowStream
以串流支援繼續已暫停的 Workflow

cancel:

() => Promise<{ message: string }>
取消 Workflow 執行、停止所有執行中的步驟,並阻止後續步驟執行

restart:

(options?: RestartOptions) => Promise<WorkflowResult>
從最後一個作用中步驟重新啟動 Workflow 執行

timeTravel:

(options?: TimeTravelOptions) => Promise<WorkflowResult>
使用已儲存的快照資料或你提供的自訂情境,從任一特定步驟開始重新執行 Workflow。

timeTravelStream:

(options?: TimeTravelOptions) => MastraWorkflowStream
以串流支援對 Workflow 執行進行 time travel

Run 狀態
「Run 狀態」的直接連結

Workflow run 的 status 代表目前的執行狀態。可能的值如下:

success:

string
所有步驟都已成功執行完畢,並產生有效的結果輸出

failed:

string
Workflow 執行期間發生錯誤,並可取得錯誤詳細資料

suspended:

string
Workflow 執行已暫停並等待繼續,且包含已暫停步驟的資訊

canceled:

string
Workflow 執行已透過 cancel() 方法取消,所有執行中的步驟均已停止,後續步驟也不會執行