ModelRunnerOptions

CORE · type · Type contract

Full runner construction options: provider, transports, sinks and named limits.

Import

TypeScript

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

JavaScript

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

Other public entry points:@jangts/agent-core, @jangts/agent-core/model, @jangts/agent-core/types, @jangts/agent-core/structs.

Definition

Type: ModelRunnerOptions<Transports>

Type parameters

Type parameter	Constraint	Default type
Transports	readonly ModelTransportDefinition[]	readonly ModelTransportDefinition[]

Field structure

Field	Type	Required	Description
provider	ChatProvider	Required	See the type definition and usage context.
execution	ExecutionOptions | undefined	Optional	See the type definition and usage context.
transports	Transports | undefined	Optional	See the type definition and usage context.
sink	{ output?: ModelRunnerPorts["onOutput"]; } | undefined	Optional	See the type definition and usage context.
errors	{ inputBudget?: ModelRunnerPorts["inputBudgetError"]; outputBudget?: ModelRunnerPorts["outputBudgetError"]; } | undefined	Optional	See the type definition and usage context.
children	ModelChildPolicy | undefined	Optional	Read-only. See the type definition and usage context.
maxInputChars	number | undefined	Optional	Character budget for the assembled input.
maxSchemaChars	number | undefined	Optional	Character allowance for registered capability schemas.
tokenBudget	ModelTokenBudget | undefined	Optional	See the type definition and usage context.
maxOutputTokens	number | undefined	Optional	Default output reservation; invoke can override it for one call.
maxCalls	number | undefined	Optional	Calls allowed for the whole request, including descendant runners' reservations.
callTimeoutMs	number | undefined	Optional	Deadline for one provider call, in milliseconds.
maxOutputChars	number | undefined	Optional	Cap on streamed output characters; exceeding it fails the call.
usage	boolean | undefined	Optional	Request and record provider usage for each call.

Examples

• ModelRunner: input can be shortened while the output contract stays the same: Execute one model interaction through the real Provider port and return a value plus the invocation for this call.

Two inputs for the same output

Beginner · Node.js

TypeScript

import { ModelRunner } from '@jangts/agent-core/model';
const provider = {
  async *stream(messages: readonly { content: string }[]) {
    yield '收到：' + messages.at(-1)!.content;
  },
};
const runner = new ModelRunner({ provider });
const first = await runner.invoke('你好');
const second = await runner.invoke({ input: '你好' });
console.log(first.value, second.value);
console.log(first.invocation.invocationId);

JavaScript

import { ModelRunner } from '@jangts/agent-core/model';
const provider = {
    async *stream(messages) {
        yield '收到：' + messages.at(-1).content;
    },
};
const runner = new ModelRunner({ provider });
const first = await runner.invoke('你好');
const second = await runner.invoke({ input: '你好' });
console.log(first.value, second.value);
console.log(first.invocation.invocationId);

Add budget and request cancellation

Configuration · Node.js

TypeScript

import { ModelRunner } from '@jangts/agent-core/model';
const provider = {
  async *stream(messages: readonly { content: string }[]) {
    yield '收到：' + messages.at(-1)!.content;
  },
};
const runner = new ModelRunner({ provider, maxCalls: 2, maxInputChars: 4000,
  maxOutputChars: 2000, callTimeoutMs: 15000,
  execution: { signal: AbortSignal.timeout(20000) },
});
const result = await runner.invoke({ input: '你好', stageId: 'reply', maxOutputTokens: 600 });
console.log(result.value, runner.remainingCalls);

JavaScript

import { ModelRunner } from '@jangts/agent-core/model';
const provider = {
    async *stream(messages) {
        yield '收到：' + messages.at(-1).content;
    },
};
const runner = new ModelRunner({ provider, maxCalls: 2, maxInputChars: 4000,
    maxOutputChars: 2000, callTimeoutMs: 15000,
    execution: { signal: AbortSignal.timeout(20000) },
});
const result = await runner.invoke({ input: '你好', stageId: 'reply', maxOutputTokens: 600 });
console.log(result.value, runner.remainingCalls);

Related policy source

• Core default budget values

Related definitions

• ChatProvider
• ExecutionOptions
• ModelChildPolicy
• ModelRunnerPorts
• ModelRunnerSettings
• ModelTokenBudget
• ModelTransportDefinition