安装 AI 生成扩展

Available in Start plan

本安装指南基于使用 Tiptap 内容 AI 后端服务，如果您想配置自己的自定义 LLM，请改为参考此指南。

启动你的 Content AI 应用

激活套餐： 先免费试用或选择订阅。
配置你的 AI 应用。 将你的 OpenAI API 密钥添加到你的 Content AI 应用中。
设置身份验证： 使用 aud: "AI" 和 AI:Generation 权限签名一个令牌，然后将其传递给扩展。有关如何签署令牌，请参见身份验证。

访问私有注册表

AI 生成扩展发布在 Tiptap 的私有 npm 注册表中。请按照私有注册表指南集成此扩展。如果您已完成 Tiptap 账户认证，可直接跳转到#安装。

安装

npm install @tiptap-pro/extension-ai

集成到您的编辑器实例中的方法与其他 Tiptap 扩展相同。下面是示例代码：

import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import Ai from '@tiptap-pro/extension-ai'

const editor = new Editor({
  extensions: [
    StarterKit,
    Ai.configure({
      // 这需要是您的签名令牌，且绝不能是 OpenAI API 密钥！
      token: 'TOKEN_HERE',
      autocompletion: true,
      // … 其他选项（详见下文）
    }),
    // … 其他扩展
  ],
})

此时，您即可在 Tiptap 编辑器中使用 OpenAI。可查看配置选项以定制您的使用体验。

先前的 App ID 和密钥（HS256）流程仍然可用，并记录在旧版身份验证中。

隐私与数据处理

了解 Tiptap 如何处理 AI 请求及管理您的内容数据，请参阅我们的隐私文档。文档涵盖数据保留、安全措施及使用内容 AI 功能的合规信息。

Previously概述

Next up文本生成