ProviderMessage

SUPPORT · type · 类型合同

Message list a host may pass to the compatible provider directly.

导入

TypeScript

import type { ProviderMessage } from '@jangts/agent-core/support';

JavaScript

/** @typedef {import('@jangts/agent-core/support').ProviderMessage} ProviderMessage */

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

定义

类型： ProviderMessage

类型表达式

type ProviderMessage = ProviderSystemMessage | ProviderUserMessage | ProviderAssistantMessage | ProviderToolMessage;

联合分支结构

ProviderMessage的可选结构： 选择其中一种结构，各分支的字段要求分别列出。

分支 1

字段	类型	必需	说明
role	"system"	必需	只读。见类型定义及调用场景。
content	string	必需	只读。见类型定义及调用场景。
images	undefined	可省略	只读。见类型定义及调用场景。
toolCallId	undefined	可省略	只读。见类型定义及调用场景。
toolCalls	undefined	可省略	只读。见类型定义及调用场景。

分支 2

字段	类型	必需	说明
role	"user"	必需	只读。见类型定义及调用场景。
content	string	必需	只读。见类型定义及调用场景。
images	readonly ModelImage[] | undefined	可省略	只读。见类型定义及调用场景。
toolCallId	undefined	可省略	只读。见类型定义及调用场景。
toolCalls	undefined	可省略	只读。见类型定义及调用场景。

分支 3

字段	类型	必需	说明
role	"assistant"	必需	只读。见类型定义及调用场景。
content	string	必需	只读。见类型定义及调用场景。
images	undefined	可省略	只读。见类型定义及调用场景。
toolCallId	undefined	可省略	只读。见类型定义及调用场景。
toolCalls	readonly ModelToolCall[] | undefined	可省略	只读。见类型定义及调用场景。

分支 4

字段	类型	必需	说明
role	"tool"	必需	只读。见类型定义及调用场景。
content	string	必需	只读。见类型定义及调用场景。
toolCallId	string	必需	只读。见类型定义及调用场景。
images	undefined	可省略	只读。见类型定义及调用场景。
toolCalls	undefined	可省略	只读。见类型定义及调用场景。

使用示例

• 兼容 Provider 与自定义 Provider：Support 负责常见 Chat Completions HTTP/SSE 生命周期；App 可替换为自己的 ChatProvider。

真实服务端配置接入常见协议

入门 · Node.js

运行此例需要提供可用模型服务的连接配置。

TypeScript

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);

JavaScript

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 和宿主附加数据不透传。

TypeScript

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));

JavaScript

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));

相关策略源码

• HTTP 失败映射和受控请求字段

相关定义

• ModelImage
• ModelToolCall
• ProviderAssistantMessage
• ProviderSystemMessage
• ProviderToolMessage
• ProviderUserMessage