开源免费的WPS AI 软件 察元AI文档助手：链路 002：executeAssistantFromRibbon 与任务进度窗

开源免费的WPS AI 软件 察元AI文档助手：链路 002：executeAssistantFromRibbon 与任务进度窗

• • 总体链路图
  • 本篇在总体链路中的位置
  • 深度说明（工程视角）
  • 与教程系列文档的对照
  • 摘要
  • 关键词
  • 链路位置（源码索引）
  • 正文
  • • [1. Ribbon 选项与 ShowDialog](#1. Ribbon 选项与 ShowDialog)
  • 上下游衔接

总体链路图

下图在全系列各篇保持一致，仅通过高亮样式标示本篇所覆盖的环节；箭头表示主成功路径，点线为异常或可选路径。阅读任意一篇时都应能回到本图定位，避免在单文件里「钻太深」而失去上下游语境。
plain
structured
multimodal
1 入口: Ribbon/对话框 → assistantId
2 startAssistantTask 占位任务
3 launchInfo 与 resolveDocumentInput
4 resolveModel 与模型清单
5 提示词拼装与 launchGuard
6 分流 plain / structured / multimodal
7a chatCompletion 文本链路 plain
7b chatCompletion 结构化批次
8a applyDocumentAction
8b executionPlan → applyDocumentProcessingPlan
7c generateMultimodalAsset
9 评测持久化与任务完成态
异常路径 normalizeError → 安全弹窗

本篇在总体链路中的位置

对应图中节点 N1：把宿主控件语义收敛为 assistantId，尚未触及模型与网络。 高亮节点：N1。若本篇同时引用 chatApi 与任务运行器，通常意味着该逻辑处于「编排层与网络层交界」：修改时要同时考虑任务取消与 UI 快照。

深度说明（工程视角）

从工程维护角度看，本篇讨论的对象应当被视为「可替换实现」：只要对外的任务状态、HTTP 契约与文档写回语义保持不变，内部可以重构函数拆分或调整日志字段。阅读时建议始终抓住三个锚点：一是数据从哪来（PluginStorage、localStorage、COM 选区还是全文）；二是数据何时离开本机（进入 fetch 之前是否已完成脱敏与快照）；三是失败时用户可见的文本由谁归一（chatApi 与助手错误弹窗两条路径）。

就「链路 002：executeAssistantFromRibbon 与任务进度窗」而言，源码位置可概括为：ribbon.js 中 executeAssistantFromRibbon；任务 Promise 由 assistantTaskRunner.startAssistantTask 返回。这与摘要中的判断一致：Ribbon 启动助手时强制 strictAssistantDefaults 与 launchSource=ribbon-direct，再经 startAssistantTask 创建占位任务并打开 task-progress-dialog。该链在调用大模型之前完成用户可见任务壳。关键词「ShowDialog、startAssistantTask、launchSource」提示你在仓库内做全文检索时应优先锁定这些符号，而不是仅依赖界面文案。

与网络请求相关的修改，务必在本地用开发者工具或代理核对：请求体中的 model 字段是否与设置页保存的 modelId 一致；Authorization 是否只取 apiKey 列表的第一段（部分网关对多密钥格式敏感）；stream 为 true 时宿主是否稳定消费 SSE。若你引入新的 provider，应对照 getChatApiConfigByProvider 的 URL 拼接分支补充单元测试或手测用例，避免「路径已含 v1 却又重复拼接」类错误。

与文档写回相关的修改，应优先在无界面的纯函数层复现：例如仅调用 applyDocumentAction 或 applyDocumentProcessingPlan 的入参快照，观察 Range 坐标是否在 CRLF 归一化前后发生漂移。WPS 与 Word 在选区、批注锚点上的差异会放大这类问题，因此本篇若在讲坐标或分段，请同时阅读 documentPositionUtils 与 chunk 相关教程篇目。

阅读顺序上，本篇之后建议继续看：startAssistantTask 内部调用 executeAssistantTask（见 003、018）。若在总体图中定位，对应图中节点 N1：把宿主控件语义收敛为 assistantId，尚未触及模型与网络。 遇到与教程系列术语不一致时，以源码标识符为准：教程侧重导航与概念，本系列侧重调用次序与失败面。

最后说明写作立场：本系列不对任何云厂商或模型服务做优劣评价，也不暗示「必须开通」某类账号；所述配置项仅反映当前仓库为打通 OpenAI 兼容协议而需要的最小字段集合。若组织策略禁止外联，应在网关或 hosts 层拦截，而不是在加载项内写死假地址。

与教程系列文档的对照

下列文档来自 docs/chayuan-tutorial-series，侧重「如何阅读仓库」与界面侧概念，与本链路系列互补：不重复推销功能，仅帮助建立目录与模块边界。

• chayuan-tutorial-series/01-chayuan-gailan-yu-dingwei.md：与本篇链路相邻的工程说明，可对照变量命名与文件职责。
• chayuan-tutorial-series/12-yuanma-fenceng-yu-AI-bianma-zai-ben-xiangmu.md：与本篇链路相邻的工程说明，可对照变量命名与文件职责。

摘要

Ribbon 启动助手时强制 strictAssistantDefaults 与 launchSource=ribbon-direct，再经 startAssistantTask 创建占位任务并打开 task-progress-dialog。该链在调用大模型之前完成用户可见任务壳。

关键词

ShowDialog;startAssistantTask;launchSource

链路位置（源码索引）

ribbon.js 中 executeAssistantFromRibbon；任务 Promise 由 assistantTaskRunner.startAssistantTask 返回。

正文

1. Ribbon 选项与 ShowDialog

getAssistantLaunchInfo 可能触发全文确认；随后 startAssistantTask 并用任务 id 拼出进度对话框 URL。

维护时建议把本节涉及的符号在 IDE 里「查找引用」：确认是否还有对话框专用服务、拼写检查服务或评测脚本以拷贝粘贴方式重复了相似逻辑。若发现重复，优先抽到 chatApi 之上的薄封装，而不是在业务层再次拼接 URL 或 Authorization，以降低安全审查时的遗漏面。

// src/components/ribbon.js 第681-705行
async function executeAssistantFromRibbon(assistantId, options = {}) {
  const ribbonOptions = {
    ...options,
    strictAssistantDefaults: true,
    launchSource: 'ribbon-direct'
  }
  const launchInfo = getAssistantLaunchInfo(assistantId, ribbonOptions)
  if (launchInfo.requiresFullDocumentConfirm) {
    const confirmed = confirmFullDocumentSubmit(launchInfo.title, launchInfo.inputLength)
    if (!confirmed) {
      return { cancelled: true }
    }
  }
  const { taskId, promise } = startAssistantTask(assistantId, ribbonOptions)
  if (!taskId) {
    throw new Error('任务启动失败，未能创建任务')
  }
  window.Application.ShowDialog(
    Util.GetUrlPath() + Util.GetRouterHash() + `/task-progress-dialog?taskId=${encodeURIComponent(taskId)}`,
    options.taskTitle || '任务进度',
    520 * (window.devicePixelRatio || 1),
    260 * (window.devicePixelRatio || 1),
    false
  )
  return promise

上下游衔接

startAssistantTask 内部调用 executeAssistantTask（见 003、018）。