RecordedSubStep
CORE · interface · 类型合同
A step already accepted by a logger, carrying recorder-assigned bookkeeping fields.
导入
ts
import type { RecordedSubStep } from '@jangts/agent-core/diagnostics';js
/** @typedef {import('@jangts/agent-core/diagnostics').RecordedSubStep} RecordedSubStep */其他公开入口:@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/diagnostics。
定义
ts
interface RecordedSubStep继承或实现: ReportedStep。
字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
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. |
createdAtMs | number | undefined | 可省略 | 只读。Optional only for historical records produced before the logger contract. |
revision | number | undefined | 可省略 | 只读。Revision number, incremented by each accepted fix. |
payload | Readonly<Record<string, SubFlowValue>> | undefined | 可省略 | 只读。Reported payload; the recorder snapshots it and bounds the total size. |
type | string | undefined | 可省略 | 只读。App-defined business log type; never a write/fix operation enum. |
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. |
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. |
name | string | 必需 | 只读。Short reported label. |
kind | string | 必需 | 只读。Reported step kind (for example a tool or model call); free-form and node-owned. |
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. |
使用示例
- 过程监听与节点报告:App 订阅 Core 执行事实;节点报告自身 usedModel,并用实例式子日志先记意图、再补结果,Loop 负责身份和日志。
监听任务经过的节点与模型事件
入门 · Node.js
ts
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')],
}],
});
const agent = new AgentCoreEngine({ workflow, execution: {
observe: { event(event) { console.log(event.type, event.eventId); } },
} });
console.log(await agent.run({ name: 'Ivan' }));js
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')],
}],
});
const agent = new AgentCoreEngine({ workflow, execution: {
observe: { event(event) { console.log(event.type, event.eventId); } },
} });
console.log(await agent.run({ name: 'Ivan' }));节点执行时报告业务阶段
配置 · Node.js
节点只报告它知道的事实;Core 负责节点身份和执行关联。
ts
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, context) {
context.report({ payload: { phase: 'formatting' } });
return { answer: '你好,' + state.name };
}, routes: [route.deliver('answer')],
}] });
const agent = new AgentCoreEngine({ workflow, execution: {
observe: { event(event) { console.log(event.type); } },
} });
console.log(await agent.run({ name: 'Ivan' }));js
import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({ id: 'greeting', nodes: [{
id: 'greet', description: '生成问候', startsRound: true,
run(state, context) {
context.report({ payload: { phase: 'formatting' } });
return { answer: '你好,' + state.name };
}, routes: [route.deliver('answer')],
}] });
const agent = new AgentCoreEngine({ workflow, execution: {
observe: { event(event) { console.log(event.type); } },
} });
console.log(await agent.run({ name: 'Ivan' }));