跳到主要内容

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() 方法取消，所有正在运行的步骤均已停止，后续步骤也不会执行
On this page