跳至主要內容

Run.start()

.start() 方法會使用輸入資料啟動 Workflow run，讓你從頭開始執行 Workflow。

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

const run = await workflow.createRun()

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

參數
「參數」的直接連結

inputData?:

z.infer<TInput>
符合 Workflow 輸入 schema 的輸入資料

requestContext?:

RequestContext
Workflow 執行期間使用的 Request Context 資料

outputWriter?:

(chunk: TOutput) => Promise<void>
在產生輸出區塊時處理這些區塊的選用非同步函式

tracingContext?:

TracingContext
用來建立子 span 及新增中繼資料的 Tracing context。使用 Mastra 的 tracing 系統時會自動注入。

currentSpan?:

Span
用來建立子 span 及新增中繼資料的目前 span。執行期間可用它建立自訂子 span 或更新 span 屬性。

tracingOptions?:

TracingOptions
Tracing 設定選項。

metadata?:

Record<string, any>
要新增至根 Trace span 的中繼資料。適合新增使用者 ID、工作階段 ID 或功能旗標等自訂屬性。

requestContextKeys?:

string[]
要擷取為此 Trace 中繼資料的其他 RequestContext key。支援以點號標記法表示巢狀值（例如 'user.id'）。

traceId?:

string
此執行要使用的 Trace ID（1 至 32 個十六進位字元）。若有提供，此 Trace 會成為指定 Trace 的一部分。

parentSpanId?:

string
此執行要使用的父 span ID（1 至 16 個十六進位字元）。若有提供，根 span 會建立為此 span 的子 span。

tags?:

string[]
要套用至此 Trace 的標籤。這些字串標籤可用來分類及篩選 Trace。

outputOptions?:

OutputOptions
輸出設定選項。

includeState?:

boolean
是否在結果中包含 Workflow run 狀態。

回傳值
「回傳值」的直接連結

result:

Promise<WorkflowResult<TState, TOutput, TSteps>>
會解析為 Workflow 執行結果的 promise；結果包含步驟輸出與狀態

traceId?:

string
啟用 Tracing 時，與此執行相關聯的 Trace ID。可用來關聯記錄及偵錯執行流程。

spanId?:

string
啟用 Tracing 時，與此執行相關聯的根 span ID。可用於 span 層級的查找與關聯。

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

import { RequestContext } from '@mastra/core/request-context'

const run = await workflow.createRun()

const requestContext = new RequestContext()
requestContext.set('variable', false)

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