跳转到内容

签名关联类型:AgentRoleStructuredOutput – ApplicationExtensionHost

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

返回接口索引

AgentRoleStructuredOutput · AgentRoleTargetRef · AgentRoleToolset · AgentTargetMode · AgentTargetSnapshot · AggregateConnectDirection · AppPageId · AppPageLocation · AppPageScopeStatus · AppTaskHistoryQuery · AppTelemetryQuery · AppThemeSchemaVersion · AppThemeSnapshot · AppThemeTokenGroup · AppThemeTokenName · AppThemeTokens · ApplicationExtensionActualState · ApplicationExtensionAuthLevel · ApplicationExtensionCatalogSummary · ApplicationExtensionChange · ApplicationExtensionChangeBatch · ApplicationExtensionChangesResult · ApplicationExtensionConfigWriteInput · ApplicationExtensionHost

AgentRoleStructuredOutput

export type AgentRoleStructuredOutput = (typeof AGENT_ROLE_STRUCTURED_OUTPUTS)[number];

AgentRoleTargetRef

回合冻结的目标身份;只用稳定 id,不携带 owner/租约。

export type AgentRoleTargetRef = {
readonly canvasId?: string;
readonly nodeId?: string;
readonly mode?: AgentTargetMode;
readonly cameraId?: string;
readonly expectedContentHash?: string;
readonly allowSceneAreaExpansion?: boolean;
readonly worldScope?: {
readonly kind: "scene-area" | "workflow-group-2d" | "world-camera";
readonly areaId?: string;
readonly groupId?: string;
readonly cameraId?: string;
};
};

关联类型:AgentTargetMode

成员说明:

  • canvasId:画布目标(与画布无关的单次任务可省略)。
  • expectedContentHash:领域冻结的内容前置条件(模型内容哈希 / 组 epoch 等)。
  • worldScope:世界目标的宿主已选范围(只含身份,不含版本/租约)。

AgentRoleToolset

角色允许的工具集合;两者都只是「允许」,不是授权。

export type AgentRoleToolset = {
readonly required: readonly string[];
readonly optional: readonly string[];
};

AgentTargetMode

export type AgentTargetMode = (typeof AGENT_TARGET_MODES)[number];

AgentTargetSnapshot

一次回合的显式目标快照(camera/clip/item 使用稳定 id,不用索引)。

export type AgentTargetSnapshot = {
structuredInputHash?: string;
delivery?: {
purpose: "text-generation" | "image-director-scene";
domainRequestId: string;
attemptId: string;
nodeId?: string;
};
canvasId: string;
nodeId?: string;
mode?: AgentTargetMode;
cameraId?: string;
clipId?: string;
itemId?: string;
worldScope?: AssistantWorldScopeSelection;
allowSceneAreaExpansion?: boolean;
model?: string;
reasoningEffort?: AgentReasoningEffort;
capabilityRevision?: string;
connectionId?: string;
expectedContentHash?: string;
role?: AgentRoleRef;
rolePreparedHash?: string;
};

关联类型:AgentTargetMode · AssistantWorldScopeSelection · AgentReasoningEffort · AgentRoleRef

成员说明:

  • structuredInputHash:Trusted structured runner identity; ordinary dispatch must never execute this turn.
  • delivery:Trusted host delivery association; never accepted from a browser entry intent.
  • worldScope:Trusted world scope selection for mode: "world". The host resolves the canonical scope/version and leases; the assistant never supplies them.
  • allowSceneAreaExpansion:Explicit per-turn permission; omitted on older turns means false.
  • model:冻结的账户模型 id(来自真实目录)。 选择失效时 MUST 要求用户处理,不自动换模型(design D5);adapter 不得用别的模型冒充。
  • capabilityRevision:受理时冻结的模型 reasoning 能力修订号(旧回合缺省)。
  • connectionId:冻结的显式来源连接 id。
  • expectedContentHash:领域并发 precondition(模型内容哈希 / 片场 snapshotHash,按模式)。
  • role:受理时冻结的角色身份。 旧回合缺省即 legacy:不补造角色指纹,查询/取消/回执恢复仍按原身份。
  • rolePreparedHash:受理时冻结的准备内容摘要(与角色修订、真实工具集合共同用于原生上下文隔离)。

AggregateConnectDirection

聚合拉线方向。

output 从选区右侧把手出发建立「成员 -> 目标」边;input 从左侧把手出发建立 「目标 -> 成员」边。

export type AggregateConnectDirection = "input" | "output";

AppPageId

顶层页面 identity。

export type AppPageId = "canvas" | "task-history" | "task-monitor" | "telemetry" | "extension";

AppPageLocation

export type AppPageLocation = {
page: AppPageId;
canvasId?: string;
nodeId?: string;
history?: AppTaskHistoryQuery;
telemetry?: AppTelemetryQuery;
extensionPageId?: string;
query?: ExtensionAppPageQuery;
unknownPath?: string;
openSettings?: boolean;
};

关联类型:AppPageId · AppTaskHistoryQuery · AppTelemetryQuery · ExtensionAppPageQuery

成员说明:

  • canvasId:Canvas 目标(从 history 跳转时携带)。
  • history:Task History 类型化查询(仅 task-history 页)。
  • telemetry:遥测复盘页类型化查询。
  • extensionPageId:extension page 的稳定 pageId(仅 page: "extension")。
  • query:extension page 的已应用查询(规范化;仅 page: "extension" 或 task-monitor)。
  • unknownPath:请求路径未注册/不可用(仅 page: "extension");页面显示稳定不可用,不回退 Canvas。
  • openSettings:一次性「打开画布内设置」意图 。 只由旧 /settings 兼容地址产生:解析结果仍是 page: "canvas",openSettings 表示壳就绪后 需要消费一次打开请求。它不是页面身份、不进入 URL 序列化,也不参与 scope identity。

AppPageScopeStatus

export type AppPageScopeStatus = {
id: string;
page: AppPageId;
phase: "starting" | "ready" | "error";
error: string | null;
};

关联类型:AppPageId

AppTaskHistoryQuery

Task History 已应用查询。

MUST NOT 包含未应用草稿、prompt、parameters 或媒体 URL。状态用有界 tab 表达; cursor 是 opaque 页游标;taskKey 是选中详情。

export type AppTaskHistoryQuery = {
tab?: "all" | "active" | "succeeded" | "failed" | "cancelled";
providerId?: string;
modelType?: "language" | "image" | "video" | "audio" | "motion";
modelKey?: string;
canvasId?: string;
nodeId?: string;
taskKey?: string;
source?: "canvas" | "extension" | "unknown";
extensionId?: string;
from?: string;
to?: string;
cursor?: string;
};

AppTelemetryQuery

本机遥测复盘页的已应用查询。

只含有界枚举(窗口/事件名/结果)、不透明游标与记录 id;MUST NOT 包含事件属性、错误消息或 任何其它用户内容——URL 会被复制粘贴给别人看,它是「筛选口径」而不是数据本身。

export type AppTelemetryQuery = {
window?: TelemetryWindow;
name?: TelemetryEventName;
result?: TelemetryResult;
mode?: TelemetryPerfMode;
groupBy?: TelemetryAttributeKey;
cursor?: string;
eventId?: string;
canvasId?: string;
};

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

成员说明:

  • mode:构建模式筛选。 封闭枚举,因此可以进 URL;它同时作用于事件列表与窗口聚合(spec:按 production 筛选的 耗时分布不包含 dev 样本)。
  • groupBy:聚合分组维度(单个属性键,同样是有界枚举)。只影响聚合,不影响列表结果集。
  • canvasId:来源画布:返回目标,不是筛选条件。 复盘页是整页路由,没有它「返回画布」只能落到默认画布;带上它才能回到用户刚才那张。 与 task-history 的 canvasId 同取向(不透明标识,不属于用户内容)。

AppThemeSchemaVersion

export type AppThemeSchemaVersion = typeof APP_THEME_SCHEMA_VERSION;

AppThemeSnapshot

不可变、带确定性 fingerprint 的主题快照。

export type AppThemeSnapshot = {
id: string;
version: AppThemeSchemaVersion;
tokens: Readonly<AppThemeTokens>;
fingerprint: string;
};

关联类型:AppThemeSchemaVersion · AppThemeTokens

成员说明:

  • id:规范化后的 preset id。
  • version:schema 版本常量。
  • tokens:全部 token 的规范 hex 值(不可变)。
  • fingerprint:基于 id/version/tokens 的确定性内容指纹(hex)。

AppThemeTokenGroup

export type AppThemeTokenGroup = keyof typeof APP_THEME_TOKEN_GROUPS;

AppThemeTokenName

扁平 token 名称联合类型(与 canonical preset 的 key 集合一一对应)。

export type AppThemeTokenName = {
[G in AppThemeTokenGroup]: (typeof APP_THEME_TOKEN_GROUPS)[G][number];
}[AppThemeTokenGroup];

关联类型:AppThemeTokenGroup

AppThemeTokens

当前 schema 的必填 token 映射(名称 → 规范 hex 值)。

export type AppThemeTokens = Record<AppThemeTokenName, string>;

关联类型:AppThemeTokenName

ApplicationExtensionActualState

export type ApplicationExtensionActualState = (typeof APPLICATION_EXTENSION_ACTUAL_STATES)[number];

ApplicationExtensionAuthLevel

export type ApplicationExtensionAuthLevel = (typeof APPLICATION_EXTENSION_AUTH_LEVELS)[number];

ApplicationExtensionCatalogSummary

export type ApplicationExtensionCatalogSummary = {
directory?: string;
extensionId: string;
name: string;
description: string;
version: string;
};

成员说明:

  • directory:部署侧提供的所在目录,仅用于展示。

ApplicationExtensionChange

有界增量项:要么是完整状态,要么是删除通知。

export type ApplicationExtensionChange = {
revision: number;
extensionId: string;
status: ApplicationExtensionStatus;
};

关联类型:ApplicationExtensionStatus

ApplicationExtensionChangeBatch

export type ApplicationExtensionChangeBatch = {
revision: number;
changes: ApplicationExtensionChange[];
resyncRequired: boolean;
extensionRelease?: ApplicationExtensionReleasePointer;
};

关联类型:ApplicationExtensionChange · ApplicationExtensionReleasePointer

成员说明:

  • resyncRequired:增量不可用(cursor 过旧/丢失)时为 true,客户端必须重取 snapshot。
  • extensionRelease:同 ApplicationExtensionSnapshot.extensionRelease:随增量带回,变化不推进插件 revision。

ApplicationExtensionChangesResult

export type ApplicationExtensionChangesResult = {
ok: true;
batch: ApplicationExtensionChangeBatch;
} | {
ok: false;
code: ApplicationExtensionRemoteError;
error: string;
};

关联类型:ApplicationExtensionChangeBatch · ApplicationExtensionRemoteError

ApplicationExtensionConfigWriteInput

export type ApplicationExtensionConfigWriteInput = {
extensionId: string;
expectedRevision: number;
enabled: boolean;
values: Record<string, unknown>;
secretRefs: string[];
};

成员说明:

  • secretRefs:opaque secret reference;浏览器不接触秘密值。

ApplicationExtensionHost

export type ApplicationExtensionHost = (typeof APPLICATION_EXTENSION_HOSTS)[number];