跳到主要内容

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>
用于在生成输出 chunk 时进行处理的可选异步函数

tracingContext?:

TracingContext
用于创建子 span 和添加 metadata 的 Tracing 上下文。使用 Mastra 的 tracing 系统时会自动注入。

currentSpan?:

Span
用于创建子 span 和添加 metadata 的当前 span。可在执行期间用它创建自定义子 span 或更新 span 属性。

tracingOptions?:

TracingOptions
Tracing 配置选项。

metadata?:

Record<string, any>
要添加到根 trace span 的 metadata。可用于添加用户 ID、会话 ID 或 feature flag 等自定义属性。

requestContextKeys?:

string[]
要提取为此 trace 的 metadata 的其他 RequestContext 键。支持使用点表示法访问嵌套值（例如 '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