安装 AI 生成扩展

Available in Start plan

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

启动您的内容 AI 应用

激活计划： 开始免费试用或选择订阅方案。
配置您的 AI 应用： 在您的内容 AI 应用中添加您的 OpenAI API 密钥。
设置认证： 使用我们提供的密钥生成包含 HS256 算法的 JWT，用于验证扩展与服务之间的身份。获取您的 JWT 密钥。

访问私有注册表

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({
      // 您的 Tiptap 内容 AI 应用 ID
      appId: 'APP_ID_HERE',
      // 这里应为您生成的 JWT，绝对不要使用 OpenAI API 密钥！
      token: 'TOKEN_HERE',
      autocompletion: true,
      // … 其他选项（详见下文）
    }),
    // … 其他扩展
  ],
})

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