ModelTransportDefinition

CORE · interface · 类型合同

One registered transport: a wire format prepared for a stage.

导入

TypeScript

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

JavaScript

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

其他公开入口：@jangts/agent-core、@jangts/agent-core/model、@jangts/agent-core/types、@jangts/agent-core/structs。

定义

interface ModelTransportDefinition<Result>

泛型参数

类型参数	约束	默认类型
Result	—	unknown

字段结构

字段	类型	必需	说明
id	string	必需	只读。Transport id used by call requests and reported in diagnostics.
prepare	(stageId: string) => import("./interactions.js").PreparedModelTransport<Result>	必需	Builds the prepared transport for stageId; must not spend a call by itself.

成员目录

成员	用途
prepare	Builds the prepared transport for stageId; must not spend a call by itself.

成员详情

prepare

Builds the prepared transport for stageId; must not spend a call by itself.

ModelTransportDefinition.prepare(stageId: string): import("./interactions.js").PreparedModelTransport<Result>

Builds the prepared transport for stageId; must not spend a call by itself.

参数	类型	传递	说明
stageId	string	必需	—

返回： PreparedModelTransport<Result>。

返回值结构

字段	类型	必需	说明
options	Pick<ModelOptions, "functions" | "json" | "toolChoice" | "parallelToolCalls" | "temperature">	必需	只读。见类型定义及调用场景。
schemaChars	number	必需	只读。见类型定义及调用场景。
instruction	string | undefined	可省略	只读。见类型定义及调用场景。
createResponse	() => ModelResponseCollector<Result>	必需	见类型定义及调用场景。

使用示例

• 模型 Tool 与传输：完整校验后才得到类型化选择：Tool 定义提供 Schema 与 resolver；传输将 wire 输出翻译为统一的模型选择合同。

声明两个可选择 Tool

入门 · Node.js

TypeScript

import { ModelToolRegistry } from '@jangts/agent-core';
const inputSchema = { jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
  parse(value: unknown) {
    if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length) throw new Error('需要空对象');
    return {};
  } };
const tools = new ModelToolRegistry([
  { id: 'greet', description: '回答问候', inputSchema, resolve: () => 'greet' },
  { id: 'status', description: '查询状态', inputSchema, resolve: () => 'status' },
]).seal();
console.log(tools.resolve({ toolId: 'status', input: {} }, { stageId: 'recognize' }));

JavaScript

import { ModelToolRegistry } from '@jangts/agent-core';
const inputSchema = { jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
    parse(value) {
        if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length)
            throw new Error('需要空对象');
        return {};
    } };
const tools = new ModelToolRegistry([
    { id: 'greet', description: '回答问候', inputSchema, resolve: () => 'greet' },
    { id: 'status', description: '查询状态', inputSchema, resolve: () => 'status' },
]).seal();
console.log(tools.resolve({ toolId: 'status', input: {} }, { stageId: 'recognize' }));

仅向一个阶段投影允许的子集

配置 · Node.js

TypeScript

import { ModelToolRegistry, Support } from '@jangts/agent-core';
const schema = Support.defineSchema({ jsonSchema: { type: 'object', properties: {} },
  parse(value: unknown) { if (!value || typeof value !== 'object' || Array.isArray(value)) throw new TypeError('需要对象'); return {}; } });
const registry = new ModelToolRegistry([
  { id: 'greet', description: '问候', inputSchema: schema, resolve: () => 'greet' },
  { id: 'status', description: '状态', inputSchema: schema, resolve: () => 'status' },
]).seal();
const readOnly = registry.select(['status']);
const transport = Support.createModelTransport({ id: 'recognize', tools: readOnly });
console.log(transport.id, readOnly.ids());

JavaScript

import { ModelToolRegistry, Support } from '@jangts/agent-core';
const schema = Support.defineSchema({ jsonSchema: { type: 'object', properties: {} },
    parse(value) { if (!value || typeof value !== 'object' || Array.isArray(value))
        throw new TypeError('需要对象'); return {}; } });
const registry = new ModelToolRegistry([
    { id: 'greet', description: '问候', inputSchema: schema, resolve: () => 'greet' },
    { id: 'status', description: '状态', inputSchema: schema, resolve: () => 'status' },
]).seal();
const readOnly = registry.select(['status']);
const transport = Support.createModelTransport({ id: 'recognize', tools: readOnly });
console.log(transport.id, readOnly.ids());

相关定义

• PreparedModelTransport