Workflow.createRun()
.createRun() 方法會建立新的 Workflow run 執行個體,讓你能以特定輸入資料執行 Workflow。這是目前會回傳 Run 執行個體的 API。
使用範例「使用範例」的直接連結
await workflow.createRun()
參數「參數」的直接連結
runId?:
string
Workflow run 的選用自訂識別碼
resourceId?:
string
選用識別碼,用來將 Workflow run 與特定資源(例如使用者 ID、租戶 ID)建立關聯。此值會隨 Workflow run 一併保存,並可用來篩選及查詢 run。
disableScorers?:
boolean
是否停用此 Workflow run 的 scorer,為選用旗標
回傳值「回傳值」的直接連結
run:
Run
可用來執行 Workflow 的新 Workflow run 執行個體
延伸使用範例「延伸使用範例」的直接連結
const workflow = mastra.getWorkflow('workflow')
const run = await workflow.createRun()
const result = await run.start({
inputData: {
value: 10,
},
})
使用 resourceId「using-resourceid」的直接連結
resourceId 參數會將 Workflow run 與特定資源(例如使用者或租戶)建立關聯。這對多租戶應用程式,或需要追蹤由哪位使用者啟動 Workflow 的情境很有幫助。
const workflow = mastra.getWorkflow('workflow')
// Create a run associated with a specific user
const run = await workflow.createRun({
resourceId: 'user-123',
})
const result = await run.start({
inputData: {
value: 10,
},
})
// Later, retrieve the run and access the resourceId
const storedRun = await workflow.getWorkflowRunById(run.runId)
console.log(storedRun.resourceId) // "user-123"