跳转到内容

签名关联类型:TaskSubmitRequest – TelemetryWindow

本页由当前 SDK 声明自动生成。

返回接口索引

TaskSubmitRequest · TaskSubmitResponse · TelemetryAnomaly · TelemetryAnomalyRuleId · TelemetryAnomalySeverity · TelemetryAttributeKey · TelemetryBucket · TelemetryEvent · TelemetryEventFilter · TelemetryEventInput · TelemetryEventName · TelemetryEventPage · TelemetryEventRecord · TelemetryExportStatus · TelemetryOrigin · TelemetryPerfMode · TelemetryResult · TelemetrySeriesPoint · TelemetryStatus · TelemetryStoreState · TelemetrySummary · TelemetrySummaryRow · TelemetrySurface · TelemetryWindow

TaskSubmitRequest

submit 请求体:由 Canvas 从 published Y.Doc 解析后构造。

export type TaskSubmitRequest = {
serviceConnection?: {
serviceConnectionId: string;
owner: string;
};
workerTaskKey: string;
canvasId: string;
nodeId: string;
runId: string;
jobId: string;
nodeType: CanvasTaskNodeType;
modelType: CanvasTaskModelType;
modelKey: string;
interaction?: ModelInteractionDescriptor;
prompt: string;
parameters: Record<string, unknown>;
inputs: CanvasTaskInput[];
worldCapture?: WorldCaptureGenerationBinding;
modelTitle?: string;
providerName?: string;
canvasTitle?: string;
nodeTitle?: string;
};

关联类型:CanvasTaskNodeType · CanvasTaskModelType · ModelInteractionDescriptor · CanvasTaskInput · WorldCaptureGenerationBinding

成员说明:

  • serviceConnection:In-process Canvas port only; HTTP decoder deliberately does not accept caller-supplied owners.
  • workerTaskKey:稳定幂等 key:Canvas 生成,同一 run 重试用同一值。
  • modelKey:稳定 opaque catalog 身份。
  • interaction:catalog 声明的交互 identity;Task 校验其与当前 catalog 一致。
  • inputs:只含稳定媒体引用;Task 通过 Media Service 校验并签出执行期 URL。
  • worldCapture:T10 static world framing frozen at acceptance. It is stable metadata only (no bytes/URL); it is recorded so a completed run can be traced to the exact captured media and version, independent of later canvas changes.
  • modelTitle:执行时显示快照。缺省时旧记录降级为稳定 ID。

TaskSubmitResponse

submit 响应:accepted 不等待 provider 终态。

export type TaskSubmitResponse = {
workerTaskKey: string;
state: TaskExecutionState;
reused: boolean;
canvasId: string;
nodeId: string;
runId: string;
};

关联类型:TaskExecutionState

成员说明:

  • reused:true 表示这是已存在的记录(幂等命中)。

TelemetryAnomaly

一条异常命中。

observed / baseline 是同一度量在两个窗口上的值(比率或耗时),samples 是观测窗口的 样本数——没有样本数的“100% 失败”是解读陷阱,必须一起呈现。

export type TelemetryAnomaly = {
readonly ruleId: TelemetryAnomalyRuleId;
readonly severity: TelemetryAnomalySeverity;
readonly name: TelemetryEventName;
readonly attributeValue?: string;
readonly window: TelemetryWindow;
readonly observed: number;
readonly baseline: number;
readonly samples: number;
readonly evidence: Readonly<Record<string, string | number>>;
};

关联类型:TelemetryAnomalyRuleId · TelemetryAnomalySeverity · TelemetryEventName · TelemetryWindow

成员说明:

  • attributeValue:分组命中时的分组成员(latency-regression 可按 kind / stage / mode 分组)。 缺省表示这条命中是针对该事件名整体的。规则本身不判断“要不要分组”——那是调用方的 查询口径(design D5);这里只如实带出,界面据此把「pan 变慢」与「整体变慢」分开显示。

TelemetryAnomalyRuleId

export type TelemetryAnomalyRuleId = (typeof TELEMETRY_ANOMALY_RULE_IDS)[number];

TelemetryAnomalySeverity

export type TelemetryAnomalySeverity = "info" | "warn" | "error";

TelemetryAttributeKey

export type TelemetryAttributeKey = (typeof TELEMETRY_ATTRIBUTE_KEYS)[number];

TelemetryBucket

export type TelemetryBucket = (typeof TELEMETRY_BUCKETS)[number];

TelemetryEvent

一条本机遥测事实。

export type TelemetryEvent = {
readonly name: TelemetryEventName;
readonly result: TelemetryResult;
readonly origin: TelemetryOrigin;
readonly surface?: TelemetrySurface;
readonly durationMs?: number;
readonly errorCode?: string;
readonly traceId?: string;
readonly frontendVersion?: string;
readonly occurredAt: number;
readonly attributes?: Readonly<Record<string, string | number | boolean>>;
};

关联类型:TelemetryEventName · TelemetryResult · TelemetryOrigin · TelemetrySurface

成员说明:

  • durationMs:操作耗时;缺失表示该事件不度量耗时。
  • errorCode:稳定错误码(不是错误消息)。
  • traceId:关联标识;32 位小写十六进制。
  • frontendVersion:上报端构建版本;服务端只做形状校验,因此这里同样只留形状。
  • occurredAt:上报端时钟(epoch ms);0 表示不可信/未知。窗口与保留永远不认它。
  • attributes:有界键值细节;键来自 TELEMETRY_ATTRIBUTE_KEYS。

TelemetryEventFilter

事件列表的筛选条件。

export type TelemetryEventFilter = {
readonly window?: TelemetryWindow;
readonly names?: readonly TelemetryEventName[];
readonly results?: readonly TelemetryResult[];
readonly errorCode?: string;
readonly attributeKey?: TelemetryAttributeKey;
readonly attributeValue?: string;
readonly cursor?: string;
readonly limit?: number;
};

关联类型:TelemetryWindow · TelemetryEventName · TelemetryResult · TelemetryAttributeKey

成员说明:

  • window:时间窗口;缺省 24h。
  • names:事件名;缺省不限。
  • results:结果;缺省不限。
  • errorCode:稳定错误码精确匹配;缺省不限。
  • attributeKey:属性维度的单键精确匹配。 必须与 attributeValue 成对出现:只给键或只给值是无法回答的请求,返回 invalid-attribute,绝不静默当成“没有筛选”。
  • attributeValue:与 attributeKey 成对;值按字符串精确比较(数值属性按十进制文本比较)。
  • cursor:上一页最后一条的 id(不透明)。
  • limit:单页条数;缺省 50、上限 200。

TelemetryEventInput

调用点用来发事件的输入形状。

与 TelemetryEvent 只差 occurredAt 可缺省(缺省取宿主当前时间)。字段仍可能非法—— 归一在 normalizeTelemetryEvent 里统一做,调用点不需要自己校验。

export type TelemetryEventInput = Omit<TelemetryEvent, "occurredAt"> & {
readonly occurredAt?: number;
};

关联类型:TelemetryEvent

成员说明:

  • durationMs:操作耗时;缺失表示该事件不度量耗时。
  • errorCode:稳定错误码(不是错误消息)。
  • traceId:关联标识;32 位小写十六进制。
  • frontendVersion:上报端构建版本;服务端只做形状校验,因此这里同样只留形状。
  • attributes:有界键值细节;键来自 TELEMETRY_ATTRIBUTE_KEYS。

TelemetryEventName

export type TelemetryEventName = (typeof TELEMETRY_EVENT_NAMES)[number];

TelemetryEventPage

export type TelemetryEventPage = {
readonly events: readonly TelemetryEventRecord[];
readonly nextCursor?: string;
};

关联类型:TelemetryEventRecord

TelemetryEventRecord

一条已落库的事件:事件本身 + 宿主决定的身份与时间。

export type TelemetryEventRecord = TelemetryEvent & {
readonly id: number;
readonly receivedAt: number;
};

关联类型:TelemetryEvent

成员说明:

  • durationMs:操作耗时;缺失表示该事件不度量耗时。
  • errorCode:稳定错误码(不是错误消息)。
  • traceId:关联标识;32 位小写十六进制。
  • frontendVersion:上报端构建版本;服务端只做形状校验,因此这里同样只留形状。
  • occurredAt:上报端时钟(epoch ms);0 表示不可信/未知。窗口与保留永远不认它。
  • attributes:有界键值细节;键来自 TELEMETRY_ATTRIBUTE_KEYS。
  • receivedAt:宿主接收时间;排序、窗口与保留都认它。

TelemetryExportStatus

单个导出出口的运行时状态。

export type TelemetryExportStatus = {
readonly exportId: string;
readonly label?: string;
readonly available: boolean;
readonly lastError?: string;
readonly dropped: number;
};

成员说明:

  • lastError:最近一次失败的稳定错误码。
  • dropped:这个出口丢弃的事件数。

TelemetryOrigin

export type TelemetryOrigin = (typeof TELEMETRY_ORIGINS)[number];

TelemetryPerfMode

export type TelemetryPerfMode = (typeof TELEMETRY_PERF_MODES)[number];

TelemetryResult

export type TelemetryResult = (typeof TELEMETRY_RESULTS)[number];

TelemetrySeriesPoint

时间序列的一个点,供页面画趋势。

export type TelemetrySeriesPoint = {
readonly at: number;
readonly name: TelemetryEventName;
readonly count: number;
readonly failures: number;
};

关联类型:TelemetryEventName

成员说明:

  • at:桶起点(epoch ms)。
  • failures:failure + rejected + cancelled 的数量。

TelemetryStatus

复盘页与 status 路由共用的一份状态快照。

export type TelemetryStatus = {
readonly enabled: boolean;
readonly exportEnabled: boolean;
readonly store: TelemetryStoreState;
readonly storePath?: string;
readonly queued: number;
readonly droppedInvalid: number;
readonly droppedOverflow: number;
readonly writeErrors: number;
readonly eventCount: number;
readonly bytes: number;
readonly exports: readonly TelemetryExportStatus[];
};

关联类型:TelemetryStoreState · TelemetryExportStatus

成员说明:

  • enabled:telemetry.local.enabled 的当前值。
  • exportEnabled:telemetry.export.enabled 的当前值。
  • storePath:本地库文件位置(总是给出)。 不可用时它就是“该去处理哪个文件”的答案;可用时它是核对占用的依据(页面显示 bytes)。 读面在启用访问控制时受 telemetry.inspect 保护,因此这里不是公开信息。
  • queued:排队待写的事件数。
  • eventCount:已落库事件数(过期行不计)。
  • bytes:数据库文件字节数。

TelemetryStoreState

export type TelemetryStoreState = "ok" | "unavailable";

TelemetrySummary

export type TelemetrySummary = {
readonly window: TelemetryWindow;
readonly bucket: TelemetryBucket;
readonly since: number;
readonly until: number;
readonly total: number;
readonly groupBy?: TelemetryAttributeKey;
readonly rows: readonly TelemetrySummaryRow[];
readonly series: readonly TelemetrySeriesPoint[];
};

关联类型:TelemetryWindow · TelemetryBucket · TelemetryAttributeKey · TelemetrySummaryRow · TelemetrySeriesPoint

成员说明:

  • groupBy:分组维度。 单键。多键组合会让 SQL 与 URL 状态都变复杂,而现有样本量(本机单实例)不足以支撑 高基数交叉。存在时 rows 是「事件名 × 属性值」的组,缺省时是每个事件名一行。

TelemetrySummaryRow

聚合表的一行:一个事件名在窗口内的表现。

export type TelemetrySummaryRow = {
readonly name: TelemetryEventName;
readonly attributeValue?: string;
readonly count: number;
readonly results: Readonly<Record<TelemetryResult, number>>;
readonly durationP50?: number;
readonly durationP95?: number;
readonly durationMax?: number;
readonly durationSamples: number;
readonly topErrorCodes: readonly {
readonly code: string;
readonly count: number;
}[];
};

关联类型:TelemetryEventName · TelemetryResult

成员说明:

  • attributeValue:分组行的分组成员(只在 TelemetrySummary.groupBy 存在时出现)。 形状与按事件名聚合的行完全相同,只是多这一项:这样表格、排序与分位数口径都只有一份 实现,不需要为分组另写一套。
  • durationP50:以下分位数只统计带 durationMs 的事件;没有样本时为 undefined。

TelemetrySurface

export type TelemetrySurface = (typeof TELEMETRY_SURFACES)[number];

TelemetryWindow

export type TelemetryWindow = (typeof TELEMETRY_WINDOWS)[number];