Rule

KIT · interface · Type contract

One ordered matching rule of a MockGPT instance.

Import

TypeScript

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

JavaScript

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

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

Definition

interface Rule

Field structure

Field	Type	Required	Description
id	string | undefined	Optional	Unique label reported in CallRecord.ruleId; defaults to rule-<1-based position>.
prompt	string | RegExp | undefined	Optional	Exact prompt string or pattern tested against GenerationContext.prompt.
model	string | undefined	Optional	Restricts the rule to one request model; omitted means any model.
when	((request: ModelRequest) => boolean) | undefined	Optional	Extra predicate on the whole request; must return a boolean synchronously.
generator	Generator	Required	Value or factory used when this rule is the first match.
times	number | undefined	Optional	Maximum accepted calls before the rule is skipped; 1-based integer, omitted means unlimited.

Examples

• MockGPT: direct generation and Provider injection: Get a string or JSON directly; inject the same instance into a Provider when you need to exercise model communication.

Generate native JSON directly

Beginner · Node.js

TypeScript

import { MockGPT } from '@jangts/agent-core/mock';
const mock = new MockGPT({ rules: [{ prompt: '服务状态', generator: { online: true, source: 'fixture' } }] });
const value = await mock.generate({ model: 'demo', messages: [{ role: 'user', content: '服务状态' }] });
console.log(value); // { online: true, source: 'fixture' }
console.log(mock.counts, mock.records);

JavaScript

import { MockGPT } from '@jangts/agent-core/mock';
const mock = new MockGPT({ rules: [{ prompt: '服务状态', generator: { online: true, source: 'fixture' } }] });
const value = await mock.generate({ model: 'demo', messages: [{ role: 'user', content: '服务状态' }] });
console.log(value); // { online: true, source: 'fixture' }
console.log(mock.counts, mock.records);

Inject the same instance into the real Core model boundary

Configuration · Node.js

TypeScript

import { ModelRunner, Support } from '@jangts/agent-core';
import { MockGPT, responses } from '@jangts/agent-core/mock';
const mock = new MockGPT({ rules: [{ prompt: '服务状态', generator: responses.text('服务在线。', { chunkSize: 2, wireChunkSize: 3 }) }] });
const provider = new Support.CompatibleModelProvider({
  config: { baseUrl: 'https://mock.local/v1', apiKey: 'offline-example', model: 'demo' },
  ports: { request: mock.fetch },
});
const result = await new ModelRunner({ provider, maxCalls: 1 }).invoke('服务状态');
console.log(result.value, result.invocation.status);

JavaScript

import { ModelRunner, Support } from '@jangts/agent-core';
import { MockGPT, responses } from '@jangts/agent-core/mock';
const mock = new MockGPT({ rules: [{ prompt: '服务状态', generator: responses.text('服务在线。', { chunkSize: 2, wireChunkSize: 3 }) }] });
const provider = new Support.CompatibleModelProvider({
    config: { baseUrl: 'https://mock.local/v1', apiKey: 'offline-example', model: 'demo' },
    ports: { request: mock.fetch },
});
const result = await new ModelRunner({ provider, maxCalls: 1 }).invoke('服务状态');
console.log(result.value, result.invocation.status);

Related definitions

• Generator
• JsonValue
• ModelRequest
• ResponseDescription