签名关联类型:ConversationMessage – EditCompletionStatus
本页由当前 SDK 声明自动生成。
ConversationMessage · ConversationSnapshot · ConversationStatus · ConversationSummary · ConversationToolActivity · ConversationTurn · ConversationTurnStatus · CreatePromptSnippetInput · CreatePromptSnippetTagInput · CurrentUserService · DataScope · DataScopeFields · DecodeResult · DialogCloseGuard · DialogCloseGuardRequest · DialogCloseResult · DialogEditingOwner · DialogOpenParticipant · DialogStack · DirectoryService · DragAttachMode · EditApplyCommand · EditCompleteResult · EditCompletionStatus
ConversationMessage
一条消息(宿主持久化;sequence 单调)。
export type ConversationMessage = { messageId: string; conversationId: string; turnId: string; requestId: string; role: "user" | "assistant" | "system"; content: string; truncated: boolean; sequence: number; createdAt: string;};成员说明:
truncated:内容被预算截断时为 true(不静默丢显式引用)。
ConversationSnapshot
会话快照:消息、回合与事件的权威读模型。
cursor 是当前最大事件 sequence;resyncRequired 表示客户端 cursor 早于保留窗口,
调用方必须丢弃本地事件缓存并以本快照为准。
nextMessageCursor/nextTurnCursor 表示还有更早的合法历史可继续读取:分页只是单次传输片段,不是总量截断,
完整历史始终可以通过游标继续读取。
export type ConversationSnapshot = { conversation: ConversationSummary; turns: readonly ConversationTurn[]; messages: readonly ConversationMessage[]; events: readonly ConversationEvent[]; cursor: number; resyncRequired: boolean; nextMessageCursor?: number; nextTurnCursor?: number;};关联类型:ConversationSummary · ConversationTurn · ConversationMessage · ConversationEvent
成员说明:
nextMessageCursor:继续读取更早消息的游标(消息 sequence);缺省表示已到起点。nextTurnCursor:继续读取更早回合的游标(偏移);缺省表示已到起点。
ConversationStatus
export type ConversationStatus = (typeof CONVERSATION_STATUSES)[number];ConversationSummary
Separates new whole-set conversations from historical local authoring context.
export type ConversationSummary = { contextKey?: string; conversationId: string; canvasId: string; adapterId: string; connectionId?: string; title: string; status: ConversationStatus; createdAt: string; updatedAt: string; latestRequestId?: string; nodeId?: string; turnCount: number;};关联类型:ConversationStatus
成员说明:
connectionId:当前会话冻结的来源连接 id;不自动绑定默认连接。latestRequestId:最近一个回合的 requestId(用于打开确切运行;无回合时缺省)。nodeId:关联的生成目标节点(一个节点复用一条会话;design D8;未绑定/已归档时缺省)。
ConversationToolActivity
有界、脱敏的工具过程投影(不展示完整隐式推理或凭据)。
export type ConversationToolActivity = { tool: string; status: "started" | "completed" | "failed"; summary?: string; afterSequence?: number; createdAt?: string;};成员说明:
afterSequence:工具记录产生前的事件 cursor;用于事件窗口不完整时恢复相对顺序。
ConversationTurn
一个回合的权威投影。
export type ConversationTurn = { turnId: string; conversationId: string; requestId: string; action: AgentEntryAction; status: ConversationTurnStatus; stage: string; target: AgentTargetSnapshot; reasoning?: AgentReasoningApplication; assistantText?: string; tools: readonly ConversationToolActivity[]; runId?: string; taskId?: string; receipt?: unknown; connection?: AgentConnectionBinding; role?: AgentRoleRef; executorCursor?: number; error?: { code: string; message: string; }; createdAt: string; updatedAt: string;};关联类型:AgentEntryAction · ConversationTurnStatus · AgentTargetSnapshot · AgentReasoningApplication · ConversationToolActivity · AgentConnectionBinding · AgentRoleRef
成员说明:
reasoning:请求的思考强度与实际传输应用结果(不包含隐藏推理内容)。assistantText:助手文本(来自真实 adapter 输出;不是权威终态)。tools:工具过程(按 sequence 有界记录)。runId:领域运行关联(显式记录,不从节点 active run 反推)。receipt:权威回执(provider 领域回执,按 discriminant 呈现)。connection:该回合冻结的连接身份(旧数据缺省;用于「修改连接后用原 requestId 重试」拒绝)。role:该回合冻结的角色身份;旧回合缺省即 legacy,不补造。executorCursor:执行器 journal 的已消费事件 cursor。 宿主重启后从这里继续;旧回合缺省表示尚未建立游标。
ConversationTurnStatus
export type ConversationTurnStatus = (typeof CONVERSATION_TURN_STATUSES)[number];CreatePromptSnippetInput
export type CreatePromptSnippetInput = { operationId: string; name: string; body: string; materials: PromptSnippetMaterial[]; tagIds: string[];};CreatePromptSnippetTagInput
export type CreatePromptSnippetTagInput = { operationId: string; name: string;};CurrentUserService
export type CurrentUserService = ReturnType<typeof createCurrentUserService>;DataScope
export type DataScope = InstanceDataScope | UserDataScope;关联类型:InstanceDataScope · UserDataScope
成员说明:
ownerId:会话仓库中的兼容定位键。credentialOwnerId:加密凭据的兼容定位键,不改变加密 AAD。
DataScopeFields
数据归属只用于存储寻址,不能用于认证或授权。
type DataScopeFields = Readonly<{ id: string; ownerId: string; credentialOwnerId: string;}>;成员说明:
ownerId:会话仓库中的兼容定位键。credentialOwnerId:加密凭据的兼容定位键,不改变加密 AAD。
DecodeResult
type DecodeResult<T> = { ok: true; value: T;} | { ok: false; code: string; message: string;};DialogCloseGuard
export type DialogCloseGuard = (instance: DialogInstance) => DialogCloseGuardRequest;关联类型:DialogInstance · DialogCloseGuardRequest
DialogCloseGuardRequest
关闭请求 guard。
requestClose 供 Host 在 Escape、遮罩、Header 关闭按钮与业务关闭请求时调用;返回:
allow:按 Host 默认策略关闭;handled:guard 已接管本次请求(例如弹出「继续编辑 / 放弃修改」确认,或因写请求进行中 直接拒绝),Host MUST NOT 关闭该实例。
guard 按 dialogId 注册、按 instanceId 调用;不保存 React 闭包到 dialog payload。
export type DialogCloseGuardRequest = "allow" | "handled";DialogCloseResult
export type DialogCloseResult = { closed: boolean; instanceId: string | null; handled?: boolean;};成员说明:
handled:guard 接管了本次请求(未关闭)。
DialogEditingOwner
Trusted registration-only identity; never read from request payload.
节点文档带 nodeId;独立文件文档带 documentId 且没有画布节点身份
(编辑扩展工作区,D1/D7)。
export type DialogEditingOwner = { canvasId: string; nodeId?: string; documentId?: string; sessionId: string;};成员说明:
documentId:独立文件文档的不透明 id(与nodeId互斥)。
DialogOpenParticipant
Dialog open pre-commit participant。 在合法 Dialog 实例进入 stack 前同步运行;返回 false/抛错时拒绝打开且不改变 stack。
export type DialogOpenParticipant = DialogOpenParticipant;DialogStack
export type DialogStack = readonly DialogInstance[];关联类型:DialogInstance
DirectoryService
type DirectoryService = Pick<AgentConversationService, "listConnections" | "catalog"> & Partial<Pick<AgentConversationService, "invalidateDirectory">>;成员说明:
listConnections:该 owner 可见的来源连接。只读。 宿主据此渲染来源/连接选择;按数据空间缓存成功结果及在途请求,失败保留原选择。catalog:读取 adapter 授权/能力/账户目录(真实状态,不自动换模型)。invalidateDirectory:配置保存后清除连接/模型目录请求缓存;不改变会话事实或草稿。
DragAttachMode
拖动粘连方向。
predecessor 表示「接触节点 -> 拖动节点」(Q 触须在左),successor 表示
「拖动节点 -> 接触节点」(E 触须在右)。
export type DragAttachMode = "predecessor" | "successor";EditApplyCommand
export type EditApplyCommand = { type: "edit.apply"; preconditions: readonly EditPrecondition[]; operations: readonly EditOperation[];};关联类型:EditPrecondition · EditOperation
EditCompleteResult
编辑完成结果:成功携带回执;失败携带稳定错误码与可选回执。
export type EditCompleteResult = { ok: true; receipt: EditSessionCompletionReceipt;} | { ok: false; code: string; error: string; receipt?: EditSessionCompletionReceipt;};关联类型:EditSessionCompletionReceipt
EditCompletionStatus
export type EditCompletionStatus = (typeof EDIT_COMPLETION_STATUSES)[number];