NodeAgentCache

CORE · interface · 类型合同

Async node view. Writes and clear can only address the current partition.

导入

TypeScript

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

JavaScript

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

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

定义

interface NodeAgentCache

字段结构

字段	类型	必需	说明
get	(key: string, options?: AgentCacheOptions & CacheReadOptions) => Promise<unknown>	必需	见类型定义及调用场景。
has	(key: string, options?: AgentCacheOptions) => Promise<boolean>	必需	见类型定义及调用场景。
set	(key: string, value: unknown, options?: AgentCacheOptions) => Promise<void>	必需	见类型定义及调用场景。
delete	(key: string, options?: AgentCacheOptions) => Promise<boolean>	必需	见类型定义及调用场景。
clear	(options?: AgentCacheOptions) => Promise<void>	必需	见类型定义及调用场景。

成员目录

成员	用途
get	完整输入输出见下方重载。
has	完整输入输出见下方重载。
set	完整输入输出见下方重载。
delete	完整输入输出见下方重载。
clear	完整输入输出见下方重载。

成员详情

get

NodeAgentCache.get(key: string, options?: AgentCacheOptions & CacheReadOptions): Promise<unknown>

参数	类型	传递	说明
key	string	必需	—
options	(AgentCacheOptions & CacheReadOptions) | undefined	可省略	—

参数 options的可选结构： 选择其中一种结构，各分支的字段要求分别列出。

分支 1

undefined

分支 2

字段	类型	必需	说明
persistence	boolean | undefined	可省略	只读。见类型定义及调用场景。
nodeId	string | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<unknown>。

等待后的值： unknown。

has

NodeAgentCache.has(key: string, options?: AgentCacheOptions): Promise<boolean>

参数	类型	传递	说明
key	string	必需	—
options	AgentCacheOptions | undefined	可省略	—

参数 options的可选结构： 选择其中一种结构，各分支的字段要求分别列出。

分支 1

undefined

分支 2

字段	类型	必需	说明
persistence	boolean | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<boolean>。

等待后的值： boolean。

set

NodeAgentCache.set(key: string, value: unknown, options?: AgentCacheOptions): Promise<void>

参数	类型	传递	说明
key	string	必需	—
value	unknown	必需	—
options	AgentCacheOptions | undefined	可省略	—

参数 options的可选结构： 选择其中一种结构，各分支的字段要求分别列出。

分支 1

undefined

分支 2

字段	类型	必需	说明
persistence	boolean | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<void>。

等待后的值： void。

delete

NodeAgentCache.delete(key: string, options?: AgentCacheOptions): Promise<boolean>

参数	类型	传递	说明
key	string	必需	—
options	AgentCacheOptions | undefined	可省略	—

参数 options的可选结构： 选择其中一种结构，各分支的字段要求分别列出。

分支 1

undefined

分支 2

字段	类型	必需	说明
persistence	boolean | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<boolean>。

等待后的值： boolean。

clear

NodeAgentCache.clear(options?: AgentCacheOptions): Promise<void>

参数	类型	传递	说明
options	AgentCacheOptions | undefined	可省略	—

参数 options的可选结构： 选择其中一种结构，各分支的字段要求分别列出。

分支 1

undefined

分支 2

字段	类型	必需	说明
persistence	boolean | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<void>。

等待后的值： void。

使用示例

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

相关策略源码

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

相关定义

• AgentCacheOptions
• CacheReadOptions