defineWorkflow

CORE · function · 运行时值

Build a validated workflow from a definition.

导入

TypeScript

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

JavaScript

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

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

定义

泛型参数

类型参数	约束	默认类型
State	—	—
Result	—	—
Runtime	—	undefined

调用

defineWorkflow<State, Result, Runtime = undefined>(definition: AgentWorkflowDefinition<State, Result, Runtime>): AgentWorkflow<State, Result, Runtime>

Build a validated workflow from a definition.

类型参数	约束	默认类型
State	—	—
Result	—	—
Runtime	—	undefined

参数	类型	传递	说明
definition	AgentWorkflowDefinition<State, Result, Runtime>	必需	—

definition 的字段

字段	类型	必需	说明
id	string	必需	只读。Stable workflow id, also reported in every event.
chainSource	WorkflowChainSource | undefined	可省略	只读。App-owned authorized diagnostic reader; no global run storage is installed.
revision	string | undefined	可省略	只读。Definition revision; lets hosts distinguish executions of different graph versions.
nodes	readonly WorkflowNode<State, Result, Runtime>[]	必需	只读。见类型定义及调用场景。
isResult	((result: Result) => boolean) | undefined	可省略	只读。Synchronous result adjudicator; returning anything other than true is a contract error.
entryNodeId	string | undefined	可省略	只读。First node to enter; defaults to the first declared node, which must start a round.

返回： AgentWorkflow<State, Result, Runtime>。

使用示例

• Workflow：节点、路由与局部状态更新：用一份真实参与运行的节点定义，集中展示执行顺序、分支、错误去向和结束条件。

一个节点完成问候

入门 · 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' }));

同一节点合同可由类实现

扩展 · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
type State = { name: string; answer?: string };
class GreetingNode {
  readonly id = 'greet';
  readonly description = '根据姓名生成问候';
  readonly startsRound = true;
  readonly routes = [route.deliver('answer')];
  #prefix = '你好，';
  run(state: Readonly<State>) { return { answer: this.#prefix + state.name }; }
}
const workflow = defineWorkflow<State, string>({ id: 'greeting', nodes: [new GreetingNode()] });
console.log(await new AgentCoreEngine({ workflow }).run({ name: 'Ivan' }));

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
class GreetingNode {
    id = 'greet';
    description = '根据姓名生成问候';
    startsRound = true;
    routes = [route.deliver('answer')];
    #prefix = '你好，';
    run(state) { return { answer: this.#prefix + state.name }; }
}
const workflow = defineWorkflow({ id: 'greeting', nodes: [new GreetingNode()] });
console.log(await new AgentCoreEngine({ workflow }).run({ name: 'Ivan' }));

相关策略源码

• 引用、可达性和有界循环校验

相关定义

• AgentWorkflow
• AgentWorkflowDefinition