AI 聊天助手

AI 聊天助手是一种面向文档编辑的智能交互工具，允许用户在编辑过程中与 AI 实时对话。它可以理解选中的文本或上下文内容，提供续写、重写、润色、翻译等智能建议，支持多轮对话、历史记录管理和文件上传，帮助用户高效完成文档创作与优化。

AI 聊天助手现已支持所有的文档节点类型，您可以借助于 AI 聊天助手，实现对文档内容的快速创作、编辑和优化，包括对文字、图片、表格、代码块等内容进行创作、编辑、优化。

它的特点通常包括：

• 支持私有化部署：前端只负责发送与渲染，模型与鉴权由后端掌控
• 支持多轮对话：基于 SSE 流式输出持续追加内容
• 支持多个模型：可配置多个 ai.models[] 并在 UI 中切换
• 支持推理模式：当 ai.models[].reasoning = true 时，可切换是否展示/启用推理
• 支持历史消息：当前版本默认使用本地历史（不依赖服务端接口）
• 支持文件上传：启用后可上传图片 / 文件，并把附件信息发给后端
• 支持技能列表：启用后可在聊天中调用已配置的技能

接入之前请先阅读 快速开始。

效果截图

演示视频

默认配置

// AI 聊天助手默认配置
const defaultOptions = {
  ai: {
    chat: {
      enabled: false,
      showName: true,
      showAvatar: true,
      showDatetime: true,
      layout: 'both',
      welcomeMessage:
        '欢迎使用 Umo Editor AI 聊天助手！有什么问题可以问我哦，我会尽力帮助您完成文档编辑工作。',
      files: {
        enabled: true,
        maxSize: 1024 * 1024 * 10,
        maxCount: 3,
        allowed: {
          image: 'image/*',
          file: '.pdf,.doc,.docx,.ppt,.pptx,.xls,.xlsx,.txt,.md,.csv,.json,.xml',
        },
      },
      maxHistory: 10,
    },
  },
}

配置说明

配置说明（ai.chat）

本页只说明 options.ai.chat 下的配置项。通用配置（如 ai.models、ai.callbacks）见 配置及事件。

ai.chat.enabled

说明：是否启用 AI 聊天助手入口/侧边栏。

类型：boolean

默认值：false

ai.chat.layout

说明：消息布局方式。

类型：'single' | 'both'

默认值：'both'

ai.chat.showName

说明：是否显示消息发送者名称。

类型：boolean

默认值：true

ai.chat.showDatetime

说明：是否显示消息时间。

类型：boolean

默认值：true

ai.chat.showAvatar

说明：是否显示消息头像。

类型：boolean

默认值：true

ai.chat.welcomeMessage

说明：聊天窗口欢迎语。

类型：string

默认值：见默认配置中的 defaultOptions.chat.welcomeMessage

ai.chat.maxHistory

说明：本地最多保留多少条历史对话（用于聊天记录面板）。当前版本默认使用本地历史；如需服务端持久化，请在业务侧扩展持久化策略。

类型：number

默认值：10

ai.chat.files

说明：文件上传相关配置。

类型：object

默认值：

• enabled：boolean，是否启用文件上传，默认值为 true。
• maxSize：number，单个附件大小限制（字节），默认值为 1024 * 1024 * 10。
• maxCount：number，单次最多上传附件数量，默认值为 3。
• allowed：object，允许上传的文件类型，默认值见 defaultOptions.chat.files.allowed。

方法列表

openAIChat

说明：打开 AI 聊天助手。

参数：无

返回值：无

closeAIChat

说明：关闭 AI 聊天助手。

参数：无

返回值：无