Tiptap 中文文档

基础 AI 生成编辑器命令

Available in Start plan

Tiptap Editor 的基础 AI 生成扩展包含一组预配置命令，您可以将其集成到富文本编辑器中。这些命令可让您调整文本语气、补全文本、生成图片等，从而增强编辑器的功能。

要了解这些命令的使用方式，请查看 概览 页面上的示例。

命令描述
aiAdjustTone(tone: Tone, options: TextOptions)将所选文本的语气调整为指定的 TONE。
aiBloggify(options: TextOptions)将文本重写为博客格式
aiComplete(options: TextOptions)补全所选文本
aiDeEmojify(options: TextOptions)移除所选文本中的表情符号
aiEmojify(options: TextOptions)为您的文本添加表情符号 ✨
aiExtend(options: TextOptions)扩展您的文本
aiFixSpellingAndGrammar(options: TextOptions)修正拼写和语法
aiKeypoints(options: TextOptions)将您的文本总结为要点列表
aiRephrase(options: TextOptions)改写所选文本
aiRestructure(options: TextOptions)将所选文本重构为使用富文本格式
aiShorten(options: TextOptions)缩短所选文本
aiSimplify(options: TextOptions)用更简洁的词语改写您的文本
aiSummarize(options: TextOptions)总结您的文本
aiTextPrompt(options: TextOptions)运行您的自定义提示词
aiTldr(options: TextOptions)创建一个“Too Long; Didn't Read”版本的文本
aiTranslate(language: Language, options: TextOptions)将所选文本翻译为指定语言
实用工具
aiAccept(options: AcceptOptions)接受生成的响应，并将其插入编辑器中
aiReject(options: RejectOptions)拒绝生成的响应，重置 ai.storage 状态
aiRegenerate(options: RegenerateOptions)使用相同参数重新生成响应

大多数文本命令

大多数文本命令接受相同的选项，使用方法类似。以下示例展示了如何使用 aiBloggify 命令：

editor.chain().focus().aiBloggify(options: TextOptions)

aiAdjustTone 

// 语气: 'default' | 'academic' | 'business' | 'casual' | 'childfriendly' | 'confident' | 'conversational' | 'creative' | 'emotional' | 'excited' | 'formal' | 'friendly' | 'funny' | 'humorous' | 'informative' | 'inspirational' | 'memeify' | 'narrative' | 'objective' | 'persuasive' | 'poetic' | string
editor.chain().focus().aiAdjustTone(tone: Tone, options: TextOptions).run()

aiTranslate

将选中的文本内容翻译为指定的输出语言。

接受两个字母 ISO 639-1 语言代码。

// 语言: 'en' | 'de' | 'nl' | ...
editor.chain().focus().aiTranslate(language: Language, options: TextOptions).run()

文本命令选项

对于支持 TextOptions 的每个命令，您可以指定以下选项：

SettingTypeDefaultDefinition
modelNamesee 支持的文本模型gpt-5-mini (gpt-4.1 if streaming: true)在 OpenAI 中使用的模型
format'rich-text' | 'plain-text'plain-text决定模型应如何响应的 格式
streambooleanfalse命令是否应将字符流式输出到编辑器？这类似于 ChatGPT 中的 打字机 效果。这需要最新的扩展版本！
insertAtundefined | number | {from: number; to: number}undefined将响应插入到编辑器中的位置；如果为 undefined，响应将插入到当前选区。如果是数字，响应将插入到该位置。如果是对象，则会替换该范围。
languagestring (e.g. en, de)null虽然我们会尽力提示 OpenAI 以输入语言生成响应，但有时最好由您自己定义。
tonestringnull响应应转换为的 语气
textLengthnumberundefinedAI 应响应的 textLengthUnit 数量（例如，“3 段”中的 3）
textLengthUnit'paragraphs' | 'words' | 'characters'undefinedAI 应响应的 textLength 单位（例如，“3 段”中的 paragraphs）
collapseToEndbooleantrue操作完成后光标是否应设置到末尾，或者是否应选中插入内容。
contextArray<{ type: 'text', text: string} | { type: 'url', url: string }>[]提供给模型用于生成响应的 上下文。
textstringundefined供模型响应的可选消息
insertbooleantrue允许禁用直接将内容插入编辑器
appendbooleantrue如果为 true，响应将追加到当前选区末尾。如果为 false，响应将替换当前选区。
regeneratebooleanfalse命令是否重新生成之前生成的响应。如果设置为 true，initialContent 属性将不会更新。

遗憾的是，语气与语言的组合有时会导致生成的响应不符合预期语言。

支持的文本模型

目前支持如下 OpenAI 聊天模型：

  • gpt-5
  • gpt-5-2025-08-07
  • gpt-5-mini
  • gpt-5-mini-2025-08-07
  • gpt-5-nano
  • gpt-5-nano-2025-08-07
  • gpt-5-chat
  • gpt-5-chat-2025-08-07
  • gpt-5.4-mini
  • gpt-5.4-nano
  • gpt-4.1
  • gpt-4.1-2025-04-14
  • gpt-4.1-mini
  • gpt-4.1-mini-2025-04-14
  • gpt-4.1-nano
  • gpt-4.1-nano-2025-04-14
  • chatgpt-4o-latest
  • gpt-4o-mini
  • gpt-4o-mini-2024-07-18
  • gpt-4o
  • gpt-4o-2024-11-20
  • gpt-4o-2024-08-06
  • gpt-4o-2024-05-13
  • gpt-4-turbo
  • gpt-4-turbo-2024-04-09
  • gpt-4
  • gpt-4-0613
  • gpt-3.5-turbo-0125
  • gpt-3.5-turbo
  • gpt-3.5-turbo-1106
  • gpt-3.5-turbo-16k

选择合适的模型

在配置 Tiptap AI 扩展时，请根据您的应用需求考虑：

  • 对于成本效益型操作： 如果主要关注预算，且任务不需要最先进的能力，则选择 GPT-5 mini。
  • 对于高级需求： 如果您的应用需要最高水平的语言理解或图像生成质量，且预算限制较少，则选择 GPT-5。

Tiptap AI 扩展的灵活配置使您能够根据具体需求和预算调整 AI 集成方案。

注：由于价格存在变动且需保持最新，本文未提供具体定价。建议访问官方 OpenAI 价格页面了解最新信息。

PreviouslyText generation