CoreDiagnosticRecord
CORE · interface · 类型合同
Persisted data is untrusted: normalization checks the current envelope, not arbitrary payloads.
导入
ts
import type { CoreDiagnosticRecord } from '@jangts/agent-core/diagnostics';js
/** @typedef {import('@jangts/agent-core/diagnostics').CoreDiagnosticRecord} CoreDiagnosticRecord */其他公开入口:@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/diagnostics。
定义
ts
interface CoreDiagnosticRecord继承或实现: DiagnosticIdentity。
字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
version | 2 | 必需 | 只读。Envelope version this record was written with. |
eventId | string | 必需 | 只读。见类型定义及调用场景。 |
type | keyof CoreEventPayloads | 必需 | 只读。见类型定义及调用场景。 |
producerSequence | number | 必需 | 只读。Per-producer monotonic sequence; at least 1. |
occurredAtMs | number | 必需 | 只读。见类型定义及调用场景。 |
payload | unknown | 必需 | 只读。Unvalidated payload; only the envelope above is checked during normalization. |
usedModel | boolean | undefined | 可省略 | 只读。见类型定义及调用场景。 |
subSteps | readonly RecordedSubStep[] | 必需 | 只读。见类型定义及调用场景。 |
subStepsDropped | number | 必需 | 只读。见类型定义及调用场景。 |
subStepsTruncated | boolean | 必需 | 只读。见类型定义及调用场景。 |
runId | string | 必需 | 只读。Root run id shared by every fact of one logical run. |
spanId | string | 必需 | 只读。Span that produced the fact. |
parentSpanId | string | undefined | 可省略 | 只读。Enclosing span; absent for a root span. |
invocationId | string | undefined | 可省略 | 只读。Invocation that produced the fact, when the fact belongs to one. |
parentInvocationId | string | undefined | 可省略 | 只读。Enclosing invocation, when one invocation triggers another. |
nodeRole | "invocation" | "workflow-node" | "workflow-boundary" | "loop-step" | undefined | 可省略 | 只读。Role the emitting span plays in the execution graph. |
agentId | string | undefined | 可省略 | 只读。App-owned agent identity. |
branchId | string | undefined | 可省略 | 只读。App-owned branch identity. |
agentVersionId | string | undefined | 可省略 | 只读。App-owned immutable version identity of the agent definition. |
parentBranchId | string | undefined | 可省略 | 只读。Branch this branch was forked from, when applicable. |
parentAgentVersionId | string | undefined | 可省略 | 只读。Version of the parent branch at the fork point. |
forkPointId | string | undefined | 可省略 | 只读。App-owned fork marker shared by the forked branch and its origin. |
workflowInvocationId | string | undefined | 可省略 | 只读。Workflow invocation the fact belongs to. |
workflowNodeId | string | undefined | 可省略 | 只读。Workflow node invocation the fact belongs to. |
definitionKind | string | undefined | 可省略 | 只读。Kind of the workflow/agent definition that dispatched the node. |
definitionId | string | undefined | 可省略 | 只读。Id of that definition. |
definitionRevision | string | undefined | 可省略 | 只读。Revision of that definition; distinguishes executions of different definition states. |
nodeId | string | undefined | 可省略 | 只读。Node id inside the workflow. |
nodeName | string | undefined | 可省略 | 只读。Human-readable node name. |
nodeKind | string | undefined | 可省略 | 只读。Node kind as declared by the App. |
nodeDescription | string | undefined | 可省略 | 只读。Optional node description for diagnostics display. |
stageId | string | undefined | 可省略 | 只读。Model stage that produced the fact. |
modelId | string | undefined | 可省略 | 只读。Model binding used, when the fact concerns a model call. |
使用示例
- 过程监听与节点报告: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' }));