responses

KIT · constant · Runtime value

Import

TypeScript

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

JavaScript

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

Other public entry points:@jangts/agent-core/mock.

Definition

Member index

Member	Purpose
text	See the overload below for full inputs and outputs.
toolCalls	See the overload below for full inputs and outputs.
httpError	See the overload below for full inputs and outputs.
reject	Simulate a transport failure that rejects the client call instead of answering with HTTP.

Member details

text

responses.text(content: string, options?: OutputOptions): ResponseDescription

Parameter	Type	Passing	Description
content	string	Required	—
options	OutputOptions	Optional	—

Fields of options

Field	Type	Required	Description
finishReason	"length" | "tool_calls" | "stop" | "content_filter" | undefined	Optional	Finish reason sent in the last content frame; defaults to tool_calls with tools, else stop.
usage	Usage | undefined	Optional	Usage object included in non-stream replies and in the terminal usage chunk.
delayMs	number | undefined	Optional	Artificial latency before the reply or first frame, in milliseconds; default 0.
chunkSize	number | undefined	Optional	Maximum Unicode code points per content/tool-call delta; default 24; never splits a code point.
intervalMs	number | undefined	Optional	Delay between SSE frames in milliseconds; default 0 (emit as fast as the consumer pulls).
wireChunkSize	number | undefined	Optional	Optional transport-level byte chunks, independent of content/codepoint chunks.
interruptAfter	number | undefined	Optional	Error the stream after this many data frames, without a success terminator.

Returns: ResponseDescription.

toolCalls

responses.toolCalls(tools: readonly ToolCall[], options?: OutputOptions): ResponseDescription

Parameter	Type	Passing	Description
tools	readonly ToolCall[]	Required	—
options	OutputOptions	Optional	—

Fields of options

Field	Type	Required	Description
finishReason	"length" | "tool_calls" | "stop" | "content_filter" | undefined	Optional	Finish reason sent in the last content frame; defaults to tool_calls with tools, else stop.
usage	Usage | undefined	Optional	Usage object included in non-stream replies and in the terminal usage chunk.
delayMs	number | undefined	Optional	Artificial latency before the reply or first frame, in milliseconds; default 0.
chunkSize	number | undefined	Optional	Maximum Unicode code points per content/tool-call delta; default 24; never splits a code point.
intervalMs	number | undefined	Optional	Delay between SSE frames in milliseconds; default 0 (emit as fast as the consumer pulls).
wireChunkSize	number | undefined	Optional	Optional transport-level byte chunks, independent of content/codepoint chunks.
interruptAfter	number | undefined	Optional	Error the stream after this many data frames, without a success terminator.

Returns: ResponseDescription.

httpError

responses.httpError(status: number, body?: JsonValue): ResponseDescription

Parameter	Type	Passing	Description
status	number	Required	—
body	JsonValue	Optional	—

Returns: ResponseDescription.

reject

Simulate a transport failure that rejects the client call instead of answering with HTTP.

responses.reject(message?: string): ResponseDescription

Parameter	Type	Passing	Description
message	string	Optional	—

Returns: ResponseDescription.

Examples

• MockGPT: response descriptions and scenario generators: Fixed results serve strict regression, input-dependent generators explore wiring, and explicit response descriptions cover failure and streaming scenarios.

Encode a validated model result

Extension · Node.js

The adapter handles request validation, pre-first-byte delay, and lifecycle; the encoder does not execute rules or modify MockGPT call records.

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());

Generate an inspectable summary from the input

Beginner · 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);

Reuse the same random source across field generators

Configuration · 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);

Related definitions

• JsonValue
• OutputOptions
• ResponseDescription
• ToolCall