Tiptap 中文文档

更新日志 - 工具定义

@tiptap-pro/ai-toolkit-tool-definitions

0.7.0

0.6.1

0.6.0

小改动

  • c0998e4：简化 tiptapRead 和 tiptapEdit 工具的工具定义

0.5.0

0.4.0

补丁改动

  • a8ac0a0：改进 tiptapReadSelection 工具，使其使用更少的 tokens，并且不会导致 AI 将已选中的内容误认为位于所选内容所在节点中的内容。

0.3.10

0.3.9

0.3.8

0.3.7

补丁改动

  • 0608c46：小的错误修复与改进

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

补丁改动

  • 8a7a077：修复已发布的 CLI，以便 tool-definitions 和工作流命令在作为包二进制文件调用时能正确运行。

0.3.1

0.3.0

0.2.3

0.2.2

0.2.1

0.2.0

小改动

  • e3082aa：围绕 operationResults 数组标准化 tiptapEdit 操作报告。该数组为每个尝试的操作返回一个结果，包括目标、成功状态和任何错误消息。

    向 streamTool 和 tiptapEditWorkflow 添加 streamingOptions 字段，以自定义内容流式传输的方式。

    在审查模式或预览模式下流式传输内容时显示“打字机效果”。可以通过配置 streamingOptions.disableTypingEffect 来禁用此“打字机效果”。

    为 Tiptap Edit 工作流和 Proofreader 工作流添加修订跟踪支持。

    在使用 AI 工具包配合修订跟踪时添加流式传输支持。当流式传输带有修订跟踪的内容时，流式传输支持不显示“打字机效果”。相反，它按操作基础流式传输内容。

    重大改动：

    • tiptapEdit 工具输出现在包含 operationResults 属性，而不是 successful 和 failed。
    • tiptapEditWorkflow 现在返回 operationResults，而不是 successful 和 failed。
    • proofreaderWorkflow 现在返回 operationResults，而不是 operations。

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

小改动

  • e214bc6：启动新的版本控制方案，使所有 AI 工具包和服务器端 AI 工具包包保持在同一版本。

3.0.0-alpha.36

重大改动

  • 需要 @tiptap-pro/ai-toolkit 包版本为 3.0.0-alpha.88 或更高。
  • 在校对工作流中，将 hash 重命名为 target，以与编辑操作保持一致。

小改动

  • 改进工具和工作流的提示，以避免不必要的文档读取。

3.0.0-alpha.35

小改动

  • 为 createTemplateWorkflow 添加了 requiredSlots、requiredConditions 和 requiredAttributes 选项。若省略，则所有字段均为必填（默认）。传入空数组则使该类型的所有字段变为可选。

3.0.0-alpha.34

小改动

  • 添加了 CLI 工具。现在该包可通过命令行工具使用，命令为 npx @tiptap-pro/ai-toolkit-tool-definitions。可用命令包括：tool-definitions、tiptap-edit-workflow、proofreader-workflow、template-workflow、edit-threads-workflow 和 insert-content-workflow。每个命令都会将 JSON 输出到标准输出。

3.0.0-alpha.33

小改动

  • 为 createProofreaderWorkflow、createTemplateWorkflow 和 createTiptapEditWorkflow 工作流的用户提示添加了可选的 context 字段。该字段允许开发者提供与任务相关的额外上下文信息。

3.0.0-alpha.32

补丁改动

  • 明确了模板工作流的提示，指出槽位内容将替换整个槽位元素。

3.0.0-alpha.31

小改动

  • 新增 createTemplateWorkflow 服务器端工作流，用于生成模板填充的提示和模式。

3.0.0-alpha.30

小改动

  • 向 toolDefinitions() 和 tiptapEditTool() 添加了 operationMeta 选项。启用后，AI 会在每次编辑操作中包含一个带有变更原因说明的 meta 字段。

3.0.0-alpha.29

重大改动

  • 改进了 editThreads 工具定义，避免 AI 有时无法创建线程的错误。
  • 优化了 Comments 工作流的提示，减少 AI 无法创建线程的错误。

3.0.0-alpha.28

补丁改动

  • 优化了 tiptapEdit 工具定义，提升编辑效率。

3.0.0-alpha.27

重大改动

  • 重大破坏性变更：在工作流的用户提示中，输入属性 nodes 重命名为 content。此更改影响 createTiptapEditWorkflow 和 createEditThreadsWorkflow。请更新工作流调用，使用 content 替代 nodes。

补丁改动

  • 更新了 editThreadsWorkflow，明确 htmlContent 必须包含整个节点的 HTML，包括该节点的 HTML 标签。
  • 更新了 editThreads 工具描述，明确 HTML 内容要求。

3.0.0-alpha.26

补丁改动

  • 明确了 getThreads 分页范围，工具输出中使用排他性上界。

3.0.0-alpha.25

补丁改动

  • 在 getThreads 工具模式和描述中新增了分页字段。

3.0.0-alpha.24

重大改动

  • 重大破坏性变更：移除此包中的服务器工具定义和导出。

3.0.0-alpha.23

小改动

  • 新增 createTiptapEditWorkflow 方法。该方法创建一个内置工作流的提示和模式，允许 AI 编辑文档。
  • 新增 createEditThreadsWorkflow 方法。该方法创建一个内置工作流的提示和模式，允许 AI 管理评论和线程。

3.0.0-alpha.22

重大改动

  • 重大破坏性变更：修改了 editThreads 工具，采用新的更高效格式。新格式更快、更高效，使用更少代币，完全避免差异不匹配错误，显著提升工具准确性。

3.0.0-alpha.21

小改动

  • 在工具定义中添加了 Zod 模式，位于 zodInputSchema 属性。

3.0.0-alpha.20

小改动

  • 新增 createInsertContentWorkflow 方法。该方法创建允许 AI 插入或替换文档内容的内置工作流提示。

3.0.0-alpha.19

小改动

  • 新增 createProofreaderWorkflow 方法。该方法创建允许 AI 校对文档的内置工作流提示和模式。

3.0.0-alpha.18

小改动

  • 服务器端 AI 工具包的工具定义。

3.0.0-alpha.17

重大改动

  • 新增 tiptapEdit、tiptapRead 和 tiptapReadSelection 工具，设为默认工具。移除 readNodeRange、readSelection、insertContent 和 applyPatch 工具。

3.0.0-alpha.16

小改动

  • 新增 tiptapEdit、tiptapRead 和 tiptapReadSelection 工具，提高编辑速度和效率。此类工具为实验性，需要用户自行选择是否使用。

3.0.0-alpha.15

补丁改动

  • 修复了导致 AI 在聊天交互开始时未读取文档的缺陷。

3.0.0-alpha.14

补丁改动

  • 修复了导致 AI 在不必要时读取整个文档的缺陷。

3.0.0-alpha.13

补丁改动

  • 修复了文档更新后 AI 读取错误内容的缺陷。

3.0.0-alpha.12

补丁改动

  • 修复了新建的线程和评论未创建在文档正确位置的缺陷。

3.0.0-alpha.11

重大改动

  • 全新设计了 applyPatch 工具输入格式，使工具定义更简洁一致。
  • 改进了所有内置工具的输出和工具定义。
  • 需升级至 @tiptap-pro/ai-toolkit 包版本不低于 3.0.0-alpha.37。

3.0.0-alpha.10

重大改动

  • 将 insertContent 工具中的“html”属性重命名为“content”，使内容格式更独立。
  • 需升级至 @tiptap-pro/ai-toolkit 包版本不低于 3.0.0-alpha.36。

补丁改动

  • 修复 insertContent 工具中 activeNodeRange 不是有效位置的缺陷。
  • 修复 insertContent 工具导致 activeNodeRange 总是重置为 0 的缺陷。

3.0.0-alpha.9

重大改动

  • 新增 AI 驱动的评论和线程管理工具 editThreads 和 getThreads。
  • 需升级至 @tiptap-pro/ai-toolkit 包版本不低于 3.0.0-alpha.26。

3.0.0-alpha.8

重大改动

  • 将 applyDiff 工具重命名为 applyPatch。
  • 改进 applyDiff（现名 applyPatch）工具格式和定义，使 AI 生成补丁操作列表。此改进提升准确性（避免 AI 产生不必要跳跃）且显著减少代币使用。

3.0.0-alpha.7

小改动

  • 为 insertContent 工具添加 activeNodeRange 位置，以允许 AI 在活动节点范围内插入内容。当 applyPatch 工具被禁用时，这可以提高编辑的准确性。

3.0.0-alpha.6

小改动

  • AI 工具包与 Pages 扩展集成的实验性实现。引入了 readPage 工具。

3.0.0-alpha.5

重大改动

  • 优化了 readSelection 和 insertContent 工具定义，修复了用户在 AI 读取选区后变更选区导致内容插入错误的缺陷。需 AI 工具包版本不低于 3.0.0-alpha-17。

3.0.0-alpha.4

重大改动

  • 需升级至 @tiptap-pro/ai-toolkit 包版本不低于 3.0.0-alpha.14。
  • 改进了文档读取与编辑的工具定义。

3.0.0-alpha.3

小改动

  • 优化了 readFirstChunk 工具描述。

3.0.0-alpha.2

重大改动

  • 将 schema 重命名为 inputSchema。

3.0.0-alpha.1

重大改动

  • 初始版本，包含适用于 Tiptap AI 工具包的通用工具定义。
PreviouslyAnthropic 工具