CompletionSession
SUPPORT · interface · 类型合同
Per-request completion state observed by one policy.
导入
ts
import type { CompletionSession } from '@jangts/agent-core/support';js
/** @typedef {import('@jangts/agent-core/support').CompletionSession} CompletionSession */其他公开入口:@jangts/agent-core/support、@jangts/agent-core/support/model。
定义
ts
interface CompletionSession字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
part | (part: ModelPart) => void | 必需 | Observe one part immediately before the provider yields it. |
finish | (reason: string) => void | 必需 | Observe the stream's single finish_reason. |
end | () => void | 必需 | Complete the response when the end-of-stream marker arrives. |
成员目录
| 成员 | 用途 |
|---|---|
part | Observe one part immediately before the provider yields it. |
finish | Observe the stream's single finish_reason. |
end | Complete the response when the end-of-stream marker arrives. |
成员详情
part
Observe one part immediately before the provider yields it.
ts
CompletionSession.part(part: ModelPart): voidObserve one part immediately before the provider yields it.
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
part | ModelPart | 必需 | — |
参数 part的可选结构: 选择其中一种结构,各分支的字段要求分别列出。
分支 1
string
分支 2
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
type | "function-call-delta" | 必需 | 见类型定义及调用场景。 |
index | number | 必需 | Index of the call within the response; deltas with the same index belong together. |
id | string | undefined | 可省略 | Provider call id, usually delivered once with the first delta. |
name | string | undefined | 可省略 | Function name, usually delivered once with the first delta. |
arguments | string | undefined | 可省略 | Raw JSON argument fragment; concatenating all fragments yields the full arguments. |
返回: void。
finish
Observe the stream's single finish_reason.
ts
CompletionSession.finish(reason: string): voidObserve the stream's single finish_reason.
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
reason | string | 必需 | — |
返回: void。
end
Complete the response when the end-of-stream marker arrives.
ts
CompletionSession.end(): voidComplete the response when the end-of-stream marker arrives.
无调用参数。
返回: void。
使用示例
- 兼容 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));