Skip to content

uni-flow 公开 API(中文注解)


uni-flow 公开 API(中文注解) / WorkflowEngine

Interface: WorkflowEngine

Defined in: core/types.ts:315

工作流引擎对外 API:运行、恢复、转向、HITL、查询状态。 由 createWorkflowEnginecreateEngineFromYaml 创建。

Methods

followUp()

followUp(targetUnitId, content): void

Defined in: core/types.ts:325

向目标 Unit 发送追问。

Parameters

targetUnitId

string

content

string

Returns

void


getMessages()

getMessages(): WorkflowMessage[]

Defined in: core/types.ts:331

当前消息历史。

Returns

WorkflowMessage[]


getRunId()

getRunId(): string

Defined in: core/types.ts:333

当前 run id。

Returns

string


getState()

getState(): SharedState

Defined in: core/types.ts:329

当前 SharedState。

Returns

SharedState


respondToHITL()

respondToHITL(approved, responder): Promise<void>

Defined in: core/types.ts:327

响应人工审核请求。

Parameters

approved

boolean

responder

string

Returns

Promise<void>


resume()

resume(runId, snapshotId?): Promise<WorkflowResult>

Defined in: core/types.ts:321

从检查点恢复。

Parameters

runId

string

snapshotId?

string

Returns

Promise<WorkflowResult>


run()

run(input?): Promise<WorkflowResult>

Defined in: core/types.ts:319

启动新运行;input 写入 SharedState 初始键(常见 task / params / context)。

Parameters

input?

Record<string, unknown>

Returns

Promise<WorkflowResult>


steer()

steer(targetUnitId, content): void

Defined in: core/types.ts:323

向目标 Unit 发送转向内容。

Parameters

targetUnitId

string

content

string

Returns

void

MIT Licensed