Skip to content
English

AgentBranch ​

CORE · interface · 类型合同

Immutable identity of one branch of an agent.

The three required ids are generated per engine unless the host restores a branch; the optional ids are only present on a fork and record the exact origin, so a forked run can be attributed without consulting external storage.

导入 ​

ts
import type { AgentBranch } from '@jangts/agent-core/engine';
js
/** @typedef {import('@jangts/agent-core/engine').AgentBranch} AgentBranch */

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

定义 ​

ts
interface AgentBranch

字段结构 ​

字段类型必需说明
agentIdstring必需只读。Agent the branch belongs to.
branchIdstring必需只读。Branch identifier, unique within the agent.
agentVersionIdstring必需只读。Agent version the branch was created from.
parentBranchIdstring | undefined可省略只读。Parent branch id; present only for a fork.
parentAgentVersionIdstring | undefined可省略只读。Agent version of the parent branch; present only for a fork.
forkPointIdstring | undefined可省略只读。Checkpoint the branch was forked at; present only for a fork.

使用示例 ​

基础 Workflow 生成一个新版本 ​

入门 · 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 extended = workflow.add({
  nodes: [{ id: 'format', description: '为现有回答增加结尾',
    run: state => ({ answer: state.answer + '!' }), routes: [route.deliver('answer')] }],
  routes: { greet: [route.to('format')] },
});
console.log(await new AgentCoreEngine({ workflow: extended }).run({ name: 'Ivan' }));
console.log(workflow.ids()); // 基础定义仍然只有 greet
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 extended = workflow.add({
    nodes: [{ id: 'format', description: '为现有回答增加结尾',
            run: state => ({ answer: state.answer + '!' }), routes: [route.deliver('answer')] }],
    routes: { greet: [route.to('format')] },
});
console.log(await new AgentCoreEngine({ workflow: extended }).run({ name: 'Ivan' }));
console.log(workflow.ids()); // 基础定义仍然只有 greet

继承基础 Agent 的绑定与分支来源 ​

配置 · 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 base = new AgentCoreEngine({ workflow });
const checkpoint = base.checkpoint({ name: 'Ivan' });
const branch = base.fork({ at: checkpoint });
console.log(await branch.run(checkpoint.read()));
console.log(branch.branch.parentBranchId === base.branch.branchId);
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 base = new AgentCoreEngine({ workflow });
const checkpoint = base.checkpoint({ name: 'Ivan' });
const branch = base.fork({ at: checkpoint });
console.log(await branch.run(checkpoint.read()));
console.log(branch.branch.parentBranchId === base.branch.branchId);

相关策略源码 ​

接口参考、使用示例与开发指南。