ProviderObservation

SUPPORT · type · 类型合同

One observation: event name with its payload.

导入

TypeScript

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

JavaScript

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

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

定义

类型： ProviderObservation

联合分支结构

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

分支 1

字段	类型	必需	说明
event	"provider.request"	必需	只读。见类型定义及调用场景。
payload	{ url: string; body: unknown; }	必需	只读。见类型定义及调用场景。

分支 2

字段	类型	必需	说明
event	"provider.response"	必需	只读。见类型定义及调用场景。
payload	{ status: number; requestId: string | null; contentType: string | null; }	必需	只读。见类型定义及调用场景。

分支 3

字段	类型	必需	说明
event	"provider.frame"	必需	只读。见类型定义及调用场景。
payload	{ data: string; }	必需	只读。见类型定义及调用场景。

分支 4

字段	类型	必需	说明
event	"provider.error-body"	必需	只读。见类型定义及调用场景。
payload	{ status: number; body: string; truncated?: boolean; }	必需	只读。见类型定义及调用场景。

分支 5

字段	类型	必需	说明
event	"provider.end"	必需	只读。见类型定义及调用场景。
payload	{ complete: boolean; error?: unknown; }	必需	只读。见类型定义及调用场景。

使用示例

• Provider 观察与 App 自己的记录目标：稳定 Provider 绑定观察规则，本次请求只关联自己的目标，子作用域继承关联。

只观察元数据

入门 · Node.js

TypeScript

import { Support } from '@jangts/agent-core';
const scope = Support.createProviderObservationScope<{ requestId: string }>({
  accepts(_owner, descriptor) { return descriptor.content === 'metadata'; },
  write(owner, event, spanId) { console.log(owner.requestId, spanId, event.event); },
});
console.log(scope.observer);

JavaScript

import { Support } from '@jangts/agent-core';
const scope = Support.createProviderObservationScope({
    accepts(_owner, descriptor) { return descriptor.content === 'metadata'; },
    write(owner, event, spanId) { console.log(owner.requestId, spanId, event.event); },
});
console.log(scope.observer);

按本次请求绑定自己的关联值

配置 · Node.js

此例只装配；实际调用时把该 diagnostics 配入对应请求 execution，不把 App ID 强塞进 Core 身份。

TypeScript

import { Support } from '@jangts/agent-core';
import { createDiagnostics } from '@jangts/agent-core/diagnostics';
const scope = Support.createProviderObservationScope<{ requestId: string }>({
  accepts: (_owner, descriptor) => descriptor.content === 'metadata',
  write(owner, event, spanId) { console.log(owner.requestId, spanId, event.event); },
});
const provider = new Support.CompatibleModelProvider({
  config: { baseUrl: process.env.MODEL_BASE_URL!, apiKey: process.env.MODEL_API_KEY!, model: process.env.MODEL_NAME! },
  observe: { provider: scope.observer },
});
const diagnostics = scope.attach(createDiagnostics(), { requestId: 'app-request-1' });
console.log(provider, diagnostics.identity?.runId);

JavaScript

import { Support } from '@jangts/agent-core';
import { createDiagnostics } from '@jangts/agent-core/diagnostics';
const scope = Support.createProviderObservationScope({
    accepts: (_owner, descriptor) => descriptor.content === 'metadata',
    write(owner, event, spanId) { console.log(owner.requestId, spanId, event.event); },
});
const provider = new Support.CompatibleModelProvider({
    config: { baseUrl: process.env.MODEL_BASE_URL, apiKey: process.env.MODEL_API_KEY, model: process.env.MODEL_NAME },
    observe: { provider: scope.observer },
});
const diagnostics = scope.attach(createDiagnostics(), { requestId: 'app-request-1' });
console.log(provider, diagnostics.identity?.runId);

相关定义

• ProviderEventName
• ProviderEventPayloads