审阅更改

AI Toolkit 让你可以在审阅 UI 中展示 AI 生成的更改，这样用户就可以接受或拒绝这些更改。

有两种方法：

• 使用 Tracked Changes 扩展来渲染审阅 UI。更改会作为文档的一部分持久保存，并对其他用户可见。
• AI Toolkit 建议：一种基于装饰的 UI，具有临时性，只对当前文档用户可见。

Tracked Changes

AI Toolkit 与 Tracked Changes 扩展 集成，以显示审阅 UI。请按照以下指南开始使用：

AI Toolkit 建议

AI Toolkit 建议是一种基于装饰的审阅 UI，具有临时性，并且只对当前文档用户可见。

当你希望审阅 UI 只对当前文档用户可见，而不对协作文档中的其他用户可见时，它们是 Tracked Changes 审阅 UI 的替代方案。

什么是建议？

建议是对文档的一个拟议更改。每个 Suggestion 对象都有以下属性：

• id (string): 建议的唯一标识符。
• range (Range): 这是建议的位置。它有一个 from 属性（建议开始的位置）和一个 to 属性（建议结束的位置）。在 概念指南 中了解更多关于 range 的信息。
• AI 建议插入到该 range 中的内容。此内容存储在 replacementOptions 属性中。

在 API 参考 中查看 Suggestion 对象的全部属性。

两种类型的建议

有两种类型的建议：

• 预览模式：在应用更改之前预览该更改。文档在用户接受建议之前不会被修改。
• 审阅模式：在应用更改之后进行审阅。文档已经被修改，建议允许用户撤销该更改。

如何生成建议？

当你调用 AI Toolkit 中用于 编辑文档 的方法时，就会生成建议。

这些方法可以通过三种不同方式进行配置：

选项 1：不显示建议

AI Toolkit 方法的默认行为是直接编辑文档，而不生成任何建议。

toolkit.executeTool({
  toolName: 'tiptapEdit',
  input: {},
  // 没有 reviewOptions 属性
  // 或者：
  // reviewOptions: { mode: 'disabled' }
})

选项 2：在编辑文档之前生成建议

这种方式不会修改文档，并会以 预览模式 生成建议。

只有当用户接受这些建议时，文档才会被编辑。

toolkit.executeTool({
  toolName: 'tiptapEdit',
  input: {},
  reviewOptions: { mode: 'preview' },
})

选项 3：在编辑文档之后生成建议

这种方式会直接修改文档，并以 审阅模式 生成建议。这些建议允许用户通过应用该建议来撤销更改。

toolkit.executeTool({
  toolName: 'tiptapEdit',
  input: {},
  reviewOptions: { mode: 'review' },
})

diff 工具有其他选项，请在 API 参考 中了解它们。

接受和拒绝建议

你可以通过调用 acceptSuggestion 和 rejectSuggestion 方法来接受或拒绝建议。

toolkit.acceptSuggestion('suggestion-1')
toolkit.rejectSuggestion('suggestion-1')

这些方法会返回 AI 反馈，你可以收集这些反馈并发送给 AI，以改进未来的建议。

const result = toolkit.acceptSuggestion('suggestion-1')
// result.aiFeedback.events

你还可以通过调用 acceptAllSuggestions 和 rejectAllSuggestions 方法一次性接受或拒绝所有建议。

建议可以通过程序读取和更新。有关所有可用方法，请参阅 API 参考。

指南

请按照以下指南开始使用：