encodeModelResponse
KIT · function · 运行时值
Optional app-owned codec; validation and encoding consume the same snapshots.
Thin public wrapper over encodeModel: re-validates identity arguments and re-snapshots both the request and the model output, so callers that build replies themselves get identical validation and cannot mutate the mock's state afterwards.
导入
import { encodeModelResponse } from '@jangts/agent-core/mock';import { encodeModelResponse } from '@jangts/agent-core/mock';其他公开入口:@jangts/agent-core/mock。
定义
调用
encodeModelResponse(request: ModelRequest, result: ModelOutput, id: string, created: number, signal: AbortSignal, finish: (error?: unknown, cancelled?: boolean) => void): ResponseOptional app-owned codec; validation and encoding consume the same snapshots.
Thin public wrapper over encodeModel: re-validates identity arguments and re-snapshots both the request and the model output, so callers that build replies themselves get identical validation and cannot mutate the mock's state afterwards.
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
request | ModelRequest | 必需 | — |
result | ModelOutput | 必需 | — |
id | string | 必需 | — |
created | number | 必需 | — |
signal | AbortSignal | 必需 | — |
finish | (error?: unknown, cancelled?: boolean) => void | 必需 | — |
request 的字段
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
model | string | 必需 | 只读。Model identifier; required, non-empty, and compared verbatim by Rule.model. |
messages | readonly Readonly<{ [key: string]: unknown; role: string; content?: unknown; tool_calls?: unknown; tool_call_id?: string; }>[] | 必需 | 只读。Non-empty conversation; the last user message supplies the default prompt. |
stream | boolean | 必需 | 只读。Whether the codec should emit SSE; defaulted to false during normalization. |
tools | readonly unknown[] | undefined | 可省略 | 只读。Tool schemas declared by the client; only the array shape is validated. |
stream_options | Readonly<{ include_usage?: boolean; }> | undefined | 可省略 | 只读。include_usage: true appends a terminal usage-only chunk to the stream. |
result 的字段
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
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. |
返回: Response。
使用示例
- MockGPT:响应描述与场景生成器:固定结果用于严格回归,输入相关生成器用于探索接线,显式响应描述用于故障和流式场景。
编码已校验的模型结果
扩展 · Node.js
适配器负责请求校验、首包前延迟和生命周期;编码器不执行规则或修改 MockGPT 调用记录。
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());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
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);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
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);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);