SuperAPI AI 工具集

proofreader-api

编程与开发

查看项目

更新于 10-15 12:47

技能介绍

用途

Proofreader API 技能用于在 JavaScript 或 TypeScript 网页应用中实现和调试浏览器 Proofreader API 集成。当需要为编辑器或表单界面添加浏览器内置校对能力、进行可用性检查、监控模型下载、渲染校对结果或进行配额感知的预检时,可使用该技能。

主要能力

该技能提供一套分步流程,覆盖从识别集成入口到验证行为的完整过程:

  • 识别浏览器集成面:检查工作区中的浏览器入口点、编辑器或表单 UI 处理器,以及已有的内置 AI 抽象层。可通过运行 node scripts/find-proofreader-targets.mjs . 清点可能的前端文件和现有 Proofreader API 标记。
  • 确认 API 可行性与选项结构:阅读参考文档,验证功能在安全 Window 上下文中运行,且当前 frame 被允许使用 proofreader 的 permissions-policy 特性;精确匹配 availability() 与 create() 的选项结构,尤其是 expectedInputLanguages、includeCorrectionTypes、includeCorrectionExplanations 和 correctionExplanationLanguage。
  • 实现带守卫的校对封装:基于 assets/proofreader-session.template.ts 适配框架;用 Proofreader.availability() 门控会话创建;在需要时使用 monitor 选项显示下载进度;使用 AbortController 支持可取消的调用,并在不再需要时调用 destroy()。
  • 连接 UX 与结果处理:区分缺失 API、设备不可用、模型可下载或下载中、会话就绪、校对进行中、已取消和硬失败等状态;保留非 AI 回退方案;在需要可见差异或选择性接受时渲染 correctedInput 和结构化 corrections 数组;仅在需要配额感知或大输入预检时使用 measureInputUsage()。
  • 验证行为:确认功能检测、安全上下文检查、permissions-policy 访问和 availability() 行为;用生产环境使用的确切选项测试会话创建;确认 proofread() 返回预期的 correctedInput 和修正范围;确认取消能干净地停止工作且已销毁的会话不被复用;编辑后运行构建、类型检查或测试。

使用方式

该技能以流程化步骤组织,每一步都指明应阅读的参考文件(如 references/proofreader-reference.md、references/examples.md、references/compatibility.md、references/troubleshooting.md)和应执行的操作。开发者按步骤在目标工作区中实施集成,并在最后进行验证。

适用场景

  • 为网页编辑器或表单添加浏览器内置校对功能。
  • 需要处理 Proofreader API 的可用性检查、模型下载监控、结果渲染或配额预检。
  • 在 TypeScript 项目中为实际使用的 Proofreader API 表面添加或保留类型定义。

限制

  • 该技能仅适用于浏览器网页应用;如果项目不是浏览器网页应用,应停止并说明不适用。
  • Proofreader API 是仅限窗口的浏览器 API,不能在 Worker 或服务端上下文中运行。
  • 如果功能必须通过通用文本生成接口运行,应停止并说明平台不匹配。
  • 不应将 Proofreader 用作通用聊天、摘要或改写界面;当任务不是校对时,应切换到正确的内置 API。
  • 会话选项在创建后固定,不能通过修改选项来改变行为,需要重新创建会话。
  • 浏览器预览标志、渠道、硬件要求、iframe 约束等兼容性细节需参考 references/compatibility.md。
  • 关于收费、价格、平台支持范围等具体信息,资料中暂未提供。