AgentCheckpoint

CORE · interface · Type contract

In-memory checkpoint with a copy-on-read accessor.

The stored data is already a clone, and read clones again, so a caller cannot mutate the checkpoint by mutating what it read.

Import

TypeScript

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

JavaScript

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

Other public entry points:@jangts/agent-core, @jangts/agent-core/engine, @jangts/agent-core/types.

Definition

interface AgentCheckpoint<Data>

Type parameters

Type parameter	Constraint	Default type
Data	—	—

Field structure

Field	Type	Required	Description
id	string	Required	Read-only. Checkpoint identifier, unique within the engine.
source	AgentBranch	Required	Read-only. Branch the checkpoint was taken on.
read	() => Data	Required	See the type definition and usage context.

Member index

Member	Purpose
read	See the overload below for full inputs and outputs.

Member details

read

AgentCheckpoint.read(): Data

No call parameters.

Returns: Data.

Awaited value: Awaited<Data>.

Examples

• Reusing a base Workflow and Agent branches: add preserves the old Workflow and produces a new combined Workflow; fork inherits existing bindings and the branch origin.

A base Workflow produces a new version

Beginner · 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')],
  }],
});
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

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')],
        }],
});
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

Inherit the base Agent bindings and branch origin

Configuration · 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')],
  }],
});
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);

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')],
        }],
});
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);

Related policy source

• Execution implementation of the bounded loop, commit, and cancellation

Related definitions

• AgentBranch