WorkflowSubflowRecord

CORE · type · 类型合同

Historical subflow snapshots may omit recorder fields or descriptive content.

导入

TypeScript

import type { WorkflowSubflowRecord } from '@jangts/agent-core/engine';

JavaScript

/** @typedef {import('@jangts/agent-core/engine').WorkflowSubflowRecord} WorkflowSubflowRecord */

其他公开入口：@jangts/agent-core、@jangts/agent-core/engine、@jangts/agent-core/types、@jangts/agent-core/structs。

定义

类型： WorkflowSubflowRecord

类型表达式

type WorkflowSubflowRecord = Omit<RecordedSubStep, 'name' | 'kind'> & {
  readonly name?: string;
  readonly kind?: string;
  readonly sourceEventId?: string;
  readonly producerSequence?: number;
};

字段结构

字段	类型	必需	说明
subnodeId	string | undefined	可省略	只读。Logical subnode grouping within this node visit; independent of individual log ids.
stepId	string	必需	只读。Log record identity, unique within one node visit; not a subnode id.
type	string | undefined	可省略	只读。App-defined business log type; never a write/fix operation enum.
parentStepId	string | undefined	可省略	只读。Reported parent step, forming a tree; absent for a top-level step.
relatedDefinitionId	string | undefined	可省略	只读。Self-reported reference only; never a workflow dispatch identity.
relatedInvocationId	string | undefined	可省略	只读。Real model/tool invocation identity, kept separate from the node-local subnode id.
status	"error" | "success" | "unknown" | "planned" | "running" | "cancelled" | "skipped" | undefined	可省略	只读。Reported lifecycle status; omission means the node did not report one.
usedModel	boolean | undefined	可省略	只读。This step's own reported model use, never a descendant rollup.
startedAtMs	number | undefined	可省略	只读。Reported start instant in epoch milliseconds.
endedAtMs	number | undefined	可省略	只读。Reported end instant in epoch milliseconds; only meaningful for terminal statuses.
nextStepIds	readonly string[] | undefined	可省略	只读。Reported successor step ids, for display only.
caseId	string | undefined	可省略	只读。Reported case or variant id, interpreted by the App.
summary	string | undefined	可省略	只读。Reported one-line summary.
payload	Readonly<Record<string, SubFlowValue>> | undefined	可省略	只读。Reported payload; the recorder snapshots it and bounds the total size.
createdAtMs	number | undefined	可省略	只读。Optional only for historical records produced before the logger contract.
revision	number | undefined	可省略	只读。Revision number, incremented by each accepted fix.
origin	"reported"	必需	只读。Historical marker: only self-reported steps are recorded.
operation	"write" | "fix" | undefined	可省略	只读。Append-only logging operation, separate from the App-owned business type.
targetStepId	string | undefined	可省略	只读。Original write record revised by this fix; fixes have their own stepId.
sequence	number	必需	只读。One-based append order within the node visit, including every fix.
name	string | undefined	可省略	只读。见类型定义及调用场景。
kind	string | undefined	可省略	只读。见类型定义及调用场景。
sourceEventId	string | undefined	可省略	只读。见类型定义及调用场景。
producerSequence	number | undefined	可省略	只读。见类型定义及调用场景。

使用示例

• Workflow：节点、路由与局部状态更新：用一份真实参与运行的节点定义，集中展示执行顺序、分支、错误去向和结束条件。
• 复用基础 Workflow 与 Agent 分支：add 保留旧 Workflow，生成组合后的新 Workflow；fork 继承已有绑定及分支来源。

一个节点完成问候

入门 · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';

type State = { name: string; answer?: string };
const workflow = defineWorkflow<State, string>({
  id: 'greeting',
  nodes: [{
    id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
    run: state => ({ answer: '你好，' + state.name }),
    routes: [route.deliver('answer')],
  }],
});
console.log(workflow.entryNodeId);
console.log(workflow.describe());

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({
    id: 'greeting',
    nodes: [{
            id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
            run: state => ({ answer: '你好，' + state.name }),
            routes: [route.deliver('answer')],
        }],
});
console.log(workflow.entryNodeId);
console.log(workflow.describe());

增加校验阶段，原状态与 run 方式不变

配置 · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
type State = { name: string; answer?: string; error?: string };
const workflow = defineWorkflow<State, string>({
  id: 'greeting',
  nodes: [
    { id: 'check', description: '检查姓名', startsRound: true,
      run: state => ({ error: state.name.trim() ? undefined : '姓名不能为空' }),
      routes: [route.toIfError('failure'), route.to('greet')] },
    { id: 'greet', description: '生成问候', provides: ['answer'],
      run: state => ({ answer: '你好，' + state.name }), routes: [route.deliver('answer')] },
    { id: 'failure', description: '返回校验提示', requires: ['error'], routes: [route.deliver('error')] },
  ],
});
console.log(await new AgentCoreEngine({ workflow }).run({ name: 'Ivan' }));

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({
    id: 'greeting',
    nodes: [
        { id: 'check', description: '检查姓名', startsRound: true,
            run: state => ({ error: state.name.trim() ? undefined : '姓名不能为空' }),
            routes: [route.toIfError('failure'), route.to('greet')] },
        { id: 'greet', description: '生成问候', provides: ['answer'],
            run: state => ({ answer: '你好，' + state.name }), routes: [route.deliver('answer')] },
        { id: 'failure', description: '返回校验提示', requires: ['error'], routes: [route.deliver('error')] },
    ],
});
console.log(await new AgentCoreEngine({ workflow }).run({ name: 'Ivan' }));

相关策略源码

• 有界循环、提交与取消的执行实现
• 引用、可达性和有界循环校验

相关定义

• RecordedSubStep
• SubFlowValue