ModelMessage

CORE · interface · 类型合同

One provider-neutral turn; images are user visual input and are not part of the text budget.

导入

TypeScript

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

JavaScript

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

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

定义

interface ModelMessage

字段结构

字段	类型	必需	说明
role	"system" | "user" | "assistant" | "tool"	必需	见类型定义及调用场景。
content	string	必需	Rendered text content sent to the model.
images	readonly ModelImage[] | undefined	可省略	User-supplied visual input. Binary payload is separate from the text character budget.
toolCalls	readonly ModelToolCall[] | undefined	可省略	Tool declarations made by an assistant turn; rejected on every other role at runtime.
toolCallId	string | undefined	可省略	Call id answered by a tool result; rejected on every other role at runtime.

使用示例

• 过程监听与节点报告：App 订阅 Core 执行事实；节点报告自身 usedModel，并用实例式子日志先记意图、再补结果，Loop 负责身份和日志。
• ModelRunner：输入可以省写，输出合同保持一致：用真实 Provider 端口执行一次模型交互，返回 value 和本次 invocation。
• 实际请求测量与同次准备快照：需要提前处理上下文时才 prepare；多次测量与最终发送复用同一次传输准备。
• 模型 Tool 与传输：完整校验后才得到类型化选择：Tool 定义提供 Schema 与 resolver；传输将 wire 输出翻译为统一的模型选择合同。
• 兼容 Provider 与自定义 Provider：Support 负责常见 Chat Completions HTTP/SSE 生命周期；App 可替换为自己的 ChatProvider。
• 上下文片段：明确来源、信任和预算：Core 识别片段与装配合同，校验来源元数据和预算，不内置业务压缩算法。
• 压缩器与选择器：推荐实现和自定义算法：将提示词、输出解析和算法绑定为 handler；模型 I/O 通过同一请求的 callModel。
• Support：推荐用法的聚合入口：Support 聚合推荐的构造、策略与同源配置生成；Core 运行不依赖这个命名空间。

监听任务经过的节点与模型事件

入门 · 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 agent = new AgentCoreEngine({ workflow, execution: {
  observe: { event(event) { console.log(event.type, event.eventId); } },
} });
console.log(await agent.run({ name: 'Ivan' }));

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 agent = new AgentCoreEngine({ workflow, execution: {
        observe: { event(event) { console.log(event.type, event.eventId); } },
    } });
console.log(await agent.run({ name: 'Ivan' }));

节点执行时报告业务阶段

配置 · Node.js

节点只报告它知道的事实；Core 负责节点身份和执行关联。

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

JavaScript

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

相关策略源码

• 共享执行事实源和消费隔离
• 子步骤状态及推进关系
• Core 的基础预算缺省值
• 同次准备与真实输入计量
• HTTP 失败映射和受控请求字段
• 片段校验与预算拒绝
• 默认选择指令与摘录范围
• 压缩请求与真实 callModel 合同

相关定义

• ModelImage
• ModelToolCall