Payload 与错误
所有节点间传递的数据类型,也就是 workflow payload,都必须继承WorkflowPayload。该类型来自核心包:
输出 payload
Output node 应该显式返回包含errCode、errMessage 和 items 的对象:
items 是当前唯一用户可见输出载体。App、server embed、server/web 日志和 external response 都读取该数组;assistant 消息的完整输出也保存在 items 中,而不是顶层 content。
如果业务失败但 executor 没有崩溃,可以返回非零 errCode 和可读 errMessage。外部 Dify 风格 API 会读取最终 report 里的 errCode:只有 executor 成功且 errCode === 0 才映射为 succeeded。
WorkflowResult
底层 safe run 会把 workflow 执行结果归一为:result 字段会保存该结构。App 和 server web 会根据 report、stdout、stderr 和 output node 输出组合出最终展示。
用户输入等待
用户输入节点会把 workflow 暂停成持久的waiting_for_input 状态,而不是把它标记为普通失败。报告中会包含:
| 字段 | 说明 |
|---|---|
pendingUserInput | 当前等待的请求,包含 requestId、节点名、标题、描述、表单 params、默认值和节点 metadata。 |
resolvedUserInputs | 本 run 已提交的答案数组,包含 requestId、节点名、values 和 submittedAt。 |
user_input_requested 和 user_input_resolved。等待状态的标准错误码映射为 202,用于表示 workflow 仍可恢复;成功恢复后的节点 payload 仍必须继承 WorkflowPayload,默认包含 errCode: 0、errMessage: ""、requestId、values 和 submittedAt。
WorkflowError
可以主动抛出workflow.WorkflowError,附带类型、消息、节点和 metadata。框架也会把普通异常转换成 WorkflowError。
常见错误类型包括:
- 输入校验失败。
- 节点执行失败。
- workflow 执行失败。
- 文件解析失败。
- provider 调用失败。
- abort 或 timeout。
UI 中的错误
- App 本地运行会把本地 stdout/stderr 和 report 写进本地运行缓存。
- server run 会持久化
RunResult,日志页从/api/workflows/{name}/runs/{runId}读取。 waiting_for_inputrun 会继续保留pendingUserInput,App/server embed 可以提交答案恢复同一个runId。- 外部 blocking API 返回
data.error;streaming API 通过 SSEerror或最终workflow_finished表达失败。
追踪
本文档首版由 issue #32 记录。payload 约束对齐core/types/payload.ts、core/workflow/errors.ts 和 server/src/routes/external.ts。