CompatibleModelPorts
SUPPORT · interface · 类型合同
Adapter ports the App may override without replacing the provider.
导入
ts
import type { CompatibleModelPorts } from '@jangts/agent-core/support';js
/** @typedef {import('@jangts/agent-core/support').CompatibleModelPorts} CompatibleModelPorts */其他公开入口:@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/support、@jangts/agent-core/support/model。
定义
ts
interface CompatibleModelPorts字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
request | ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) | undefined | 可省略 | Fetch implementation; defaults to the global fetch. |
error | ((failure: ModelProviderFailure) => Error) | undefined | 可省略 | Builds the thrown error for a classified failure. |
ensureJsonInstruction | boolean | undefined | 可省略 | Prefix a JSON instruction when the prompt does not already mention JSON. |
allowEmptyJson | boolean | undefined | 可省略 | Accept an empty JSON response instead of reporting MODEL_INCOMPLETE. |
completionPolicy | CompletionPolicy | undefined | 可省略 | Decide whether a finished stream satisfies the request; defaults to the legacy rules. |
observer | ProviderObserver | undefined | 可省略 | Optional Support observations, collected by the caller independently of Core diagnostics. |
使用示例
- 兼容 Provider 与自定义 Provider:Support 负责常见 Chat Completions HTTP/SSE 生命周期;App 可替换为自己的 ChatProvider。
真实服务端配置接入常见协议
入门 · Node.js
运行此例需要提供可用模型服务的连接配置。
ts
import { ModelRunner, Support } from '@jangts/agent-core';
const provider = new Support.CompatibleModelProvider({ config: {
baseUrl: process.env.MODEL_BASE_URL!, apiKey: process.env.MODEL_API_KEY!, model: process.env.MODEL_NAME!,
} });
const runner = new ModelRunner({ provider });
console.log((await runner.invoke('你好')).value);js
import { ModelRunner, Support } from '@jangts/agent-core';
const provider = new Support.CompatibleModelProvider({ config: {
baseUrl: process.env.MODEL_BASE_URL, apiKey: process.env.MODEL_API_KEY, model: process.env.MODEL_NAME,
} });
const runner = new ModelRunner({ provider });
console.log((await runner.invoke('你好')).value);直连工具线程的声明字段与 wire 映射
配置 · Node.js
只演示消息转换,无网络请求或工具执行。原始 tool_calls、tool_call_id 和宿主附加数据不透传。
ts
import { Support } from '@jangts/agent-core';
const messages: Support.ProviderMessage[] = [
{ role: 'user', content: '查询资料' },
{ role: 'assistant', content: '', toolCalls: [
{ id: 'call-1', name: 'lookup', arguments: '{"query":"资料"}' },
] },
{ role: 'tool', content: '{"found":true}', toolCallId: 'call-1' },
];
console.log(Support.chatCompletionMessages(messages));js
import { Support } from '@jangts/agent-core';
const messages = [
{ role: 'user', content: '查询资料' },
{ role: 'assistant', content: '', toolCalls: [
{ id: 'call-1', name: 'lookup', arguments: '{"query":"资料"}' },
] },
{ role: 'tool', content: '{"found":true}', toolCallId: 'call-1' },
];
console.log(Support.chatCompletionMessages(messages));