Tiptap 简写

Beta

Tiptap 简写是一种用于表示 Tiptap 文档的高效 Token 格式。与 Tiptap JSON 相比，它可以将 AI Token 成本降低多达 50%，同时不损失准确性。

Beta 版本

Tiptap 简写目前处于 beta 阶段。如果你对 Tiptap 简写带来的优势感兴趣，欢迎联系我们。

设置 Tiptap 简写格式

通过在 JSON 请求体中设置 format 参数，定义 AI 用于读取和编辑文档的格式。此参数适用于所有 Server AI 工具包端点。

format 的默认值为 "json"。要启用 Tiptap 简写格式，请在所有 API 请求中传入 format: "shorthandV2" 参数。shorthandV2 格式可用于所有支持 shorthand 格式的场景。

例如，请求获取工具定义：

curl -X POST https://api.tiptap.dev/v4/ai/toolkit/fetch-tools \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{
    "format": "shorthandV2",
    "editorContext": {}
  }'

无需进行其他更改。

格式一致性

在同一会话中的所有 API 调用里使用相同的 format 值。不要在单次 AI 交互中混用 json、 shorthand 和 shorthandV2 格式。

Tiptap 简写的工作原理

/v4/ai/toolkit/fetch-tools 端点会返回一个提示，告诉 AI 文档的结构以及它应该以何种格式生成。这包括对 AI 应如何生成文档内容的格式说明。该提示会向 AI 模型讲解语言规则和语法。

Tiptap 简写内容会被编码为一个文本字符串。与 Tiptap JSON 相比，无论是在字符数还是 token 数上，它都占用更少的空间。这在不更改 AI 模型的情况下，实现了速度提升和成本降低。

下一步

阅读 API 参考以查看所有可用的端点及其参数。

PreviouslyCustom nodes

Next upSecurity