ModelBinding

KIT · interface · Type contract

App-defined I/O. Registered literal IDs determine input and output types.

Import

TypeScript

import type { ModelBinding } from '@jangts/agent-core/kits/inference';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/inference').ModelBinding} ModelBinding */

Other public entry points:@jangts/agent-core/types, @jangts/agent-core/kits, @jangts/agent-core/kits/inference.

Definition

interface ModelBinding<Input, Output>

Type parameters

Type parameter	Constraint	Default type
Input	—	—
Output	—	—

Field structure

Field	Type	Required	Description
id	string	Required	Read-only. Catalog key used in requests; must be unique within one ModelCalls instance.
identity	string	Required	Read-only. Non-blank implementation identity (provider plus model name) reported in diagnostics.
invoke	(input: Input, context: ModelInvocationContext) => MaybePromise<Output>	Required	Performs the provider call. May be async; the Kit applies the caller's signal.
assertInput	((input: Input) => void) | undefined	Optional	Optional synchronous assertion run before the budget is consumed or the call starts.
assertOutput	((output: Output) => void) | undefined	Optional	Optional synchronous assertion run after the call, before the result is reported.

Member index

Member	Purpose
invoke	Performs the provider call. May be async; the Kit applies the caller's signal.

Member details

invoke

Performs the provider call. May be async; the Kit applies the caller's signal.

ModelBinding.invoke(input: Input, context: ModelInvocationContext): MaybePromise<Output>

Performs the provider call. May be async; the Kit applies the caller's signal.

Parameter	Type	Passing	Description
input	Input	Required	—
context	ModelInvocationContext	Required	—

Fields of context

Field	Type	Required	Description
attemptBudget	Pick<AttemptBudget, "take"> | undefined	Optional	Read-only. Shared attempt budget; a refusal fails the call with BudgetError before invoking.
logger	SubFlowLog | undefined	Optional	Read-only. Explicit optional recorder for this operation; never inferred from diagnostics.
signal	AbortSignal	Required	Read-only. Non-optional cancellation signal; never undefined once execution has started.
diagnostics	DiagnosticContext | undefined	Optional	Read-only. Diagnostic scope of the enclosing call, when recording is enabled.

Returns: MaybePromise<Output>.

Awaited value: Awaited<Output>.

Examples

• ModelCalls: external inference bindings: Bind identity, validation, cancellation, and a unified invocation receipt for App-defined I/O such as embeddings.

First bind an offline demonstration vector algorithm

Beginner · Node.js

The algorithm only demonstrates I/O binding and does not provide real language embedding quality.

TypeScript

import { ModelCalls } from '@jangts/agent-core/kits/inference';
const models = new ModelCalls([
  { id: 'demo-vector', identity: 'length-direction-v1', invoke: (text: string) => [text.length, 1] },
] as const);
const result = await models.invoke({ modelId: 'demo-vector', input: 'Agent Core', timeoutMs: 1000 }, { signal: new AbortController().signal });
console.log(result.value, result.invocation.modelId);

JavaScript

import { ModelCalls } from '@jangts/agent-core/kits/inference';
const models = new ModelCalls([
    { id: 'demo-vector', identity: 'length-direction-v1', invoke: (text) => [text.length, 1] },
]);
const result = await models.invoke({ modelId: 'demo-vector', input: 'Agent Core', timeoutMs: 1000 }, { signal: new AbortController().signal });
console.log(result.value, result.invocation.modelId);

Add input and output checks plus cancellation to the same invoke

Configuration · Node.js

TypeScript

import { ModelCalls } from '@jangts/agent-core/kits/inference';
const models = new ModelCalls([
  { id: 'demo-vector', identity: 'length-direction-v1',
    assertInput(text: string) { if (!text.trim()) throw new Error('文本为空'); },
    invoke(text: string, context) { context.signal.throwIfAborted(); return [text.length, 1]; },
    assertOutput(vector: number[]) { if (vector.length !== 2 || vector.some(value => !Number.isFinite(value))) throw new Error('向量无效'); },
  },
] as const);
const controller = new AbortController();
const result = await models.invoke({ modelId: 'demo-vector', input: 'Agent Core', timeoutMs: 1000 }, { signal: controller.signal });
console.log(models.identity('demo-vector'), result.value);

JavaScript

import { ModelCalls } from '@jangts/agent-core/kits/inference';
const models = new ModelCalls([
    { id: 'demo-vector', identity: 'length-direction-v1',
        assertInput(text) { if (!text.trim())
            throw new Error('文本为空'); },
        invoke(text, context) { context.signal.throwIfAborted(); return [text.length, 1]; },
        assertOutput(vector) { if (vector.length !== 2 || vector.some(value => !Number.isFinite(value)))
            throw new Error('向量无效'); },
    },
]);
const controller = new AbortController();
const result = await models.invoke({ modelId: 'demo-vector', input: 'Agent Core', timeoutMs: 1000 }, { signal: controller.signal });
console.log(models.identity('demo-vector'), result.value);

Related policy source

• Bindings, validation, deadlines, and real receipts

Related definitions

• MaybePromise
• ModelInvocationContext