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 執行進行時間回溯
Run 狀態Run 狀態 的直接連結
Workflow 執行的 status 表示其目前的執行狀態。可能的值包括:
success:
string
所有步驟均已成功執行完畢,並產生有效的結果輸出
failed:
string
Workflow 執行期間遇到錯誤,並提供錯誤詳情
suspended:
string
Workflow 執行已暫停並等待恢復,並提供已暫停步驟的資料
canceled:
string
Workflow 執行已透過 cancel() 方法取消,任何正在執行的步驟均會停止,並阻止後續步驟執行