工具定义
服务器 AI 工具包提供了一整套用于在服务器上与 Tiptap 文档交互的工具。
当你将这些工具提供给你的 AI 代理时,它将生成通过 /v3/ai/toolkit/execute-tool 端点执行的工具调用。这允许 AI 读取和编辑文档。
有关检索和执行工具的端点的更多信息,请参阅 API 参考 。
注意
即将发布的版本将包含特定提供者的工具定义(针对 Vercel AI SDK、LangChain.js、OpenAI、Anthropic 等)。目前,你需要从服务器 AI 工具包 API 获取以通用格式提供的工具定义,并将其转换为你的提供者格式。
tiptapRead
使用针对读取操作优化的高效格式读取文档的部分内容。
该工具使用一种适合于读取大型文档的高效格式。
tiptapEdit
使用针对编辑操作优化的高效格式编辑文档。
该工具使用高效的格式,可以对文档进行精确编辑,无需替换全部内容,从而减少令牌使用并提升性能。
getThreads
检索文档中的所有线程和评论。该工具提供有关文档中现有讨论和反馈的全面信息。
需要 Tiptap Cloud 文档
此工具需要在请求体中包含 experimental_documentOptions,因为线程存储在 Tiptap 文档服务器上。请传入引用你 Tiptap Cloud 文档的 documentId。
参数
from(number):要读取的线程起始索引。
结果
文档中所有线程和评论的数据,包括它们的内容和位置。
editThreads
对文档中的线程和评论进行操作。该工具支持全面的线程和评论管理,包括创建、更新和删除线程及评论。
需要 Tiptap Cloud 文档
此工具需要在请求体中包含 experimental_documentOptions,因为线程存储在 Tiptap 文档服务器上。请传入引用你 Tiptap Cloud 文档的 documentId。
参数
operations(array):要执行的操作数组。
结果
如果操作成功,则返回成功消息;如果操作失败,则返回错误消息。