Skip to content
中文

PreparedSessionTransport ​

SUPPORT · interface · Type contract

Prepared session transport handed to the runner.

Import ​

ts
import type { PreparedSessionTransport } from '@jangts/agent-core/support';
js
/** @typedef {import('@jangts/agent-core/support').PreparedSessionTransport} PreparedSessionTransport */

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

Definition ​

ts
interface PreparedSessionTransport

Field structure ​

FieldTypeRequiredDescription
optionsPick<ModelOptions, "functions" | "json" | "toolChoice" | "parallelToolCalls" | "temperature">RequiredRead-only. See the type definition and usage context.
schemaCharsnumberRequiredRead-only. See the type definition and usage context.
instructionstringRequiredRead-only. See the type definition and usage context.
createResponse() => ModelResponseCollector<ResolvedSessionResult>RequiredSee the type definition and usage context.

Member index ​

MemberPurpose
createResponseSee the overload below for full inputs and outputs.

Member details ​

createResponse ​

ts
PreparedSessionTransport.createResponse(): ModelResponseCollector<ResolvedSessionResult>

No call parameters.

Returns: ModelResponseCollector<ResolvedSessionResult>.

Return value structure
FieldTypeRequiredDescription
call{ id: string; name: string; argumentChars: number; } | undefinedOptionalRead-only. Native function call that carried the selection, when the response used one.
callsreadonly { id: string; name: string; argumentChars: number; toolId?: string; }[] | undefinedOptionalRead-only. All native calls carried by a session response; omitted by single-selection collectors.
outputCharsnumberRequiredRead-only. Output characters accumulated so far, for output-budget accounting.
push(part: ModelPart) => voidRequiredAppends one streamed part; parts arrive in provider order.
finish() => ResolvedSessionResultRequiredFinalizes the response. Throws when the accumulated content is not a valid selection.

Examples ​

Create a named text transport ​

Beginner · Node.js

ts
import { ModelRunner, Support } from '@jangts/agent-core';
const text = Support.createTextTransport({ id: 'brief', options: { temperature: 0.2 } });
const runner = new ModelRunner({ provider: { async *stream() { yield '服务正常'; } }, transports: [text] });
console.log((await runner.invoke({ input: '简答服务状态', transport: text })).value);
js
import { ModelRunner, Support } from '@jangts/agent-core';
const text = Support.createTextTransport({ id: 'brief', options: { temperature: 0.2 } });
const runner = new ModelRunner({ provider: { async *stream() { yield '服务正常'; } }, transports: [text] });
console.log((await runner.invoke({ input: '简答服务状态', transport: text })).value);

Generate transports for two stages from same-source tools ​

Configuration · Node.js

ts
import { Support } from '@jangts/agent-core';
const inputSchema = Support.defineSchema({
  jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
  parse(value: unknown) {
    if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length) throw new TypeError('需要空对象');
    return {};
  },
});
const tools = Support.defineModelTools([
  { id: 'greet', description: '问候', inputSchema, resolve: () => 'greet' },
  { id: 'status', description: '状态查询', inputSchema, resolve: () => 'status' },
]);
const transport = Support.createStageModelTransport({ id: 'intent', tools,
  stages: [{ id: 'recognize', toolIds: ['greet', 'status'] }, { id: 'status-only', toolIds: ['status'] }],
});
console.log(transport.prepare('status-only').schemaChars);
js
import { Support } from '@jangts/agent-core';
const inputSchema = Support.defineSchema({
    jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
    parse(value) {
        if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length)
            throw new TypeError('需要空对象');
        return {};
    },
});
const tools = Support.defineModelTools([
    { id: 'greet', description: '问候', inputSchema, resolve: () => 'greet' },
    { id: 'status', description: '状态查询', inputSchema, resolve: () => 'status' },
]);
const transport = Support.createStageModelTransport({ id: 'intent', tools,
    stages: [{ id: 'recognize', toolIds: ['greet', 'status'] }, { id: 'status-only', toolIds: ['status'] }],
});
console.log(transport.prepare('status-only').schemaChars);

API reference, usage examples and developer guides.