ResponseDescription

KIT · class · 运行时值

Wrapper that distinguishes a transport instruction from ordinary generator data.

kind: 'model' carries a ModelOutput, 'http' an HttpFault response, and 'reject' a message used to simulate a network failure. Instances are recognized by brand rather than by instanceof alone, so descriptors survive crossing the ESM/CJS boundary.

导入

TypeScript

import { ResponseDescription } from '@jangts/agent-core/mock';

JavaScript

import { ResponseDescription } from '@jangts/agent-core/mock';

其他公开入口：@jangts/agent-core/mock。

定义

class ResponseDescription

构造函数

new ResponseDescription(kind: "model" | "http" | "reject", value: ModelOutput | HttpFault | string): ResponseDescription

参数	类型	传递	说明
kind	"model" | "http" | "reject"	必需	—
value	string | ModelOutput | HttpFault	必需	—

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

分支 1

string

分支 2

字段	类型	必需	说明
content	string | null | undefined	可省略	Assistant text; null or omitted means no textual content (common for tool-call replies).
tools	readonly ToolCall[] | undefined	可省略	Tool calls emitted by the assistant; their serialized size also counts toward limits.
finishReason	"length" | "tool_calls" | "stop" | "content_filter" | undefined	可省略	Finish reason sent in the last content frame; defaults to tool_calls with tools, else stop.
usage	Usage | undefined	可省略	Usage object included in non-stream replies and in the terminal usage chunk.
delayMs	number | undefined	可省略	Artificial latency before the reply or first frame, in milliseconds; default 0.
chunkSize	number | undefined	可省略	Maximum Unicode code points per content/tool-call delta; default 24; never splits a code point.
intervalMs	number | undefined	可省略	Delay between SSE frames in milliseconds; default 0 (emit as fast as the consumer pulls).
wireChunkSize	number | undefined	可省略	Optional transport-level byte chunks, independent of content/codepoint chunks.
interruptAfter	number | undefined	可省略	Error the stream after this many data frames, without a success terminator.

分支 3

字段	类型	必需	说明
status	number	必需	HTTP status to return; validated to the 400-599 range because faults model failures.
body	JsonValue	必需	JSON body written verbatim, so callers can reproduce upstream error payloads.

返回： ResponseDescription。

实例属性

字段	类型	必需	说明
kind	"model" | "http" | "reject"	必需	只读。见类型定义及调用场景。
value	string | ModelOutput | HttpFault	必需	只读。见类型定义及调用场景。

成员目录

成员	用途
[Symbol.hasInstance]	静态。完整输入输出见下方重载。

成员详情

[Symbol.hasInstance]

静态成员。

ResponseDescription[Symbol.hasInstance](value: unknown): boolean

参数	类型	传递	说明
value	unknown	必需	—

返回： boolean。

使用示例

• MockGPT：响应描述与场景生成器：固定结果用于严格回归，输入相关生成器用于探索接线，显式响应描述用于故障和流式场景。

编码已校验的模型结果

扩展 · Node.js

适配器负责请求校验、首包前延迟和生命周期；编码器不执行规则或修改 MockGPT 调用记录。

TypeScript

import { encodeModelResponse } from '@jangts/agent-core/mock';
const controller = new AbortController();
const response = encodeModelResponse(
  { model: 'demo', messages: [{ role: 'user', content: '状态' }], stream: false },
  { content: '服务在线。' }, 'mock-1', 1700000000, controller.signal,
  (error, cancelled) => console.log({ error, cancelled }),
);
console.log(await response.json());

JavaScript

import { encodeModelResponse } from '@jangts/agent-core/mock';
const controller = new AbortController();
const response = encodeModelResponse({ model: 'demo', messages: [{ role: 'user', content: '状态' }], stream: false }, { content: '服务在线。' }, 'mock-1', 1700000000, controller.signal, (error, cancelled) => console.log({ error, cancelled }));
console.log(await response.json());

从输入生成可检查的摘要

入门 · Node.js

TypeScript

import { MockGPT, generators } from '@jangts/agent-core/mock';
const mock = new MockGPT({ rules: [{ generator: generators.summary({ maxChars: 120, count: 2 }) }] });
console.log(await mock.generate({ model: 'demo', messages: [{ role: 'user', content: '服务刚完成维护。健康检查通过。用户可以查询状态。' }] }));
console.log(mock.records);

JavaScript

import { MockGPT, generators } from '@jangts/agent-core/mock';
const mock = new MockGPT({ rules: [{ generator: generators.summary({ maxChars: 120, count: 2 }) }] });
console.log(await mock.generate({ model: 'demo', messages: [{ role: 'user', content: '服务刚完成维护。健康检查通过。用户可以查询状态。' }] }));
console.log(mock.records);

字段生成器复用同一随机源

配置 · Node.js

TypeScript

import { MockGPT, generators, generatorNames } from '@jangts/agent-core/mock';
const id = generators.id('user');
const age = generators.integer(18, 60);
const mock = new MockGPT({ seed: 42, clock: () => 1700000000000, rules: [{
  generator: context => ({ id: id(context), age: age(context) }),
}] });
console.log(await mock.generate({ model: 'demo', messages: [{ role: 'user', content: '生成资料' }] }));
console.log(generatorNames);

JavaScript

import { MockGPT, generators, generatorNames } from '@jangts/agent-core/mock';
const id = generators.id('user');
const age = generators.integer(18, 60);
const mock = new MockGPT({ seed: 42, clock: () => 1700000000000, rules: [{
            generator: context => ({ id: id(context), age: age(context) }),
        }] });
console.log(await mock.generate({ model: 'demo', messages: [{ role: 'user', content: '生成资料' }] }));
console.log(generatorNames);

相关定义

• HttpFault
• ModelOutput