中文EN
ResearchX Docs
中文

用户使用手册总览

基于用户愿景与 MVP 功能的手册导航页

用户使用手册总览

本手册面向个人研究者、小团队成员与管理员,重点说明 ResearchX 里最常用的操作:登录、创建项目、发起会话、管理文件、使用助手、安装能力包、配置模型和查看管理员设置。

最近你会看到的变化

对话和助手

  • 多步骤任务有进度面板:当助手处理较复杂任务时,会在会话侧边显示简短待办进度,标出未开始、进行中和已完成步骤。
  • 工具输出可以边运行边看:长时间执行的命令会把输出持续流式写回聊天区,停止会话时也会尽量中断后台工具并释放执行资源。
  • 会话断线后自动续连:聊天、Agent 票据和容器状态流会在网络短暂中断后自动重连,减少手动刷新页面的次数。
  • 文件路径更容易点开:助手回复中的本地工作区路径、file:// 链接和裸路径会自动识别为文件链接;目录路径不会误识别成文件。
  • 文件引用可复制粘贴:含文件标签的用户消息复制后,再粘贴到输入框时会尽量保留文件引用,不只是保留文件名文本。
  • 保存常用助手配置:可以把一个项目里常用的模型、提示词、记忆、能力包和执行环境保存成 Assistant。以后新项目或新对话可以直接复用,不需要每次重新配置。
  • 只在当前对话使用 Assistant:如果只是临时想换一种助手风格或工具组合,可以选择“在当前对话使用”,不会影响项目默认设置。
  • 计划模式:单个会话可以切换到 Plan。在计划模式下,助手会优先产出可审阅的执行计划;确认后再切回聊天模式并开始实现。
  • 助手可发起结构化反问:当任务需要你做选择或补充信息时,聊天区会出现问题卡片。你可以选择推荐项、填写自定义答案,或关闭本次提问。
  • 编辑历史消息并对比结果:修改一条已经发出的用户消息后,系统会保留原来的对话,并生成一个新的分支。你可以在不同版本之间切换,比较哪种问法效果更好。
  • 长输出更容易看:命令执行、文件写入和文件编辑等工具结果会自动整理成可展开的区块,聊天区不会被大段日志淹没。
  • 文件附件更顺手:在输入框输入 @ 可以搜索当前项目文件并插入到消息里,也可以从文件区直接引用文件。

项目和文件

  • 侧边栏操作更完整:可以在侧边栏创建项目、跨项目新建对话,并对较长的会话列表使用“显示更多/收起”。
  • 创建项目时可直接开始首个会话:新建项目后可以更快进入提问和整理资料的流程。
  • 支持删除项目:项目设置中可以删除项目。删除会同时移除该项目下的会话、文件和成员关系,请先确认不再需要。
  • 从其他项目导入文件:文件面板支持选择来源项目,把需要的文件或文件夹复制到当前项目。
  • 上传和重命名更稳妥:文件重名时可选择覆盖或自动改名,重命名操作会在专用输入框中完成,避免误触浏览器原生提示。
  • 项目存储配额:当部署启用 JuiceFS 存储配额后,项目列表和项目设置会显示已用空间与上限;超出配额的上传会被明确阻止。
  • 文件预览更丰富:常见文档、表格、演示文稿和图片可以直接在线预览;项目还可以使用专用预览插件展示特殊格式。

个人设置和模型

  • 更多模型接入模板:模型管理新增 OpenAI Responses、OpenAI Codex、Codex CLI Token、OpenRouter 和 DeepSeek 等模板,减少手动填写 provider 参数的成本。
  • Codex OAuth 模型凭据:使用 OpenAI Codex (ChatGPT OAuth) 模板时,可在模型表单中登录 Codex、导入本机 Codex 登录、刷新或清除凭据。
  • 默认上下文窗口更统一:未单独配置时,模型默认按 200k tokens 上下文窗口估算,并继续支持按模型自定义压缩阈值。
  • 语言、主题和界面偏好会自动保存:登录后切换语言、主题或界面模式,后续页面会继续沿用你的选择。
  • 个人模型管理:普通用户可以在 /workspace/models 维护自己可用的模型;聊天里的模型列表只显示你当前有权限使用的模型。
  • Token 使用统计:可以查看最近 30 天的模型用量,按项目、模型、日期等维度了解消耗情况。
  • 模型计费与钱包:如果管理员启用了计费,你可以看到余额、信用额度和使用明细;余额不足时,新的模型调用可能会被阻止。
  • Linux 用户绑定:在启用 Slurm Linux 身份绑定的部署中,可在个人资料页绑定 Linux 用户,再由项目 owner 选择是否用该身份运行项目环境。

能力包、工具和自动化

  • 安装 Skill 更方便:项目可以从目录中选择并安装 Skill,也可以继续使用 zip 导入、跨项目导入或启用全局 Skill。
  • Action 和 Agent 可导入导出:常用自动化流程可以打包迁移到其他项目,适合团队复用。
  • 工具执行前可确认:当助手准备修改文件、编辑内容或执行可能改变环境的命令时,系统可以先展示确认面板;你批准后才会继续执行。
  • 可查看差异并尝试回滚:文件写入或编辑完成后,工具卡片会尽量展示改动差异;如果之后没有发生新的冲突改动,可以尝试回滚。
  • 定时任务:项目可以创建定时执行的提示词任务,例如每日汇总、每周检查或定期生成报告。
  • 网络搜索和外部工具:管理员启用后,助手可以使用网络搜索或项目配置的外部工具来获取更多信息。

管理员和高级能力

  • 账号安全策略更明确:密码长度现在限制为最多 32 个字符;会话除滑动过期外还有最长登录期限,管理员重新启用账号时会清除该账号的登录锁定。
  • 项目公开展示:管理员可以把项目发布到公开展示页,未登录访客也能查看被公开的会话、文件预览和成果。
  • 自定义页面预览:HTML 文件和 Visualizer 插件可以直接在预览弹窗中打开,适合展示项目里的可视化结果。
  • 成员和权限更清晰:邀请成员时会校验邮箱,项目写入、容器启停等操作会按角色权限控制。
  • 容器环境可重启和配置资源:项目的持久化运行环境支持启动、停止、重试和资源配置;系统会持续校准 Docker / Kubernetes 实际状态,减少页面状态与真实容器不一致。
  • 管理员导航分组:管理后台按组织与用量、AI 能力、Agent 策略、安全与访问、运行基础设施等分类展示,更容易找到相关设置。

更详细的操作步骤见「会话与消息」「项目管理」「文件管理」「模型管理」等章节。

智能助手(Assistant)

智能助手可以理解为“可复用的工作方式”。它会记录一个项目常用的模型、提示词、记忆、能力包、自动化动作和运行环境,之后可以一键套用到项目或当前对话。

你可以这样进入:

  • 在聊天页面右上角的设置菜单中打开 Assistant
  • 在项目设置里的 Assistant 管理页查看、保存和应用
  • 管理员可从 /workspace/admin/assistants 管理平台推荐的 Assistant 模板

常见用法分两种:

  • 应用到当前项目
    • 之后这个项目的新会话默认使用这套设置
    • 适合团队项目、固定研究流程或长期任务
  • 在当前对话使用
    • 只对当前对话生效
    • 不会改写项目配置
    • 适合临时尝试另一套助手配置

项目内保存配置支持以下操作:

  • 保存当前配置:把当前项目的常用设置保存下来
  • 更新配置:用当前项目的新设置覆盖已有配置
  • 应用配置:把保存过的配置应用到项目
  • 分享/取消分享:把项目配置提交给管理员审核,审核后可作为团队或平台模板
  • 删除配置:移除不再使用的保存配置

管理员模板管理支持:

  • 审核项目分享上来的 Assistant
  • 置顶常用模板,调整展示顺序
  • 维护模板说明,帮助用户快速判断该模板适合什么任务
  • 管理全局模板的可见性,避免过期或实验性配置误用

当 Assistant 已启用时:

  • 聊天顶部会显示当前 Assistant 名称
  • 与该 Assistant 相关的部分项目开关会由系统接管,避免同一时间出现互相冲突的设置
  • 如果 Assistant 需要的能力包或自动化动作当前项目没有安装,页面会提示你补装或更换配置

新对话里如果有固定推荐的 Assistant,还可以直接点选使用;页面上的 More 会跳到完整的 Assistant 管理页。

通道(Channels)

Channels 用来把外部聊天工具接入 ResearchX。当前已支持 飞书(Feishu)微信 / 企业微信形态的 Weixin 通道,适合把团队群聊、外部线程或机器人消息连接到某个 ResearchX 项目。

你可以把它理解为“让外部聊天消息进入项目会话,并把 ResearchX 的回复送回原线程”的连接面板:

  • 入口位于工作区左侧导航 通道
  • 页面会先让你选择一个项目,再按项目分别配置消息渠道
  • 每个项目可以单独配置自己的外部通道连接
  • 新消息进入后,系统会把外部聊天和项目内会话对应起来,后续回复会回到同一个外部线程

使用流程建议如下:

  1. 进入 /workspace/channels
  2. 选择要接入外部通道的项目
  3. 按通道类型填写应用凭据,例如飞书的 App IDApp secret
  4. 在飞书开放平台事件配置中选择使用长连接接收事件,并订阅 im.message.receive_v1
  5. 保存后点击 Test connection 检查凭据是否可用
  6. 点击 ConnectReconnect 建立 WebSocket 长连接
  7. 发送一条真实外部消息,确认页面下方出现新的绑定记录

配置项含义:

  • Mode shared_bot 表示用同一个机器人身份收发消息;member_mapped 表示按成员身份做映射。
  • App ID / App secret 飞书应用凭据,创建配置时必填。
  • Base URL 可选;默认使用飞书官方开放平台地址,只有私有部署或代理场景才需要调整。

消息体验:

  • 飞书通道收到用户消息后会尽快发送“已响应/处理中”类的表态,减少用户重复发送。
  • Weixin 通道在助手生成回复期间会尽量发送输入中状态;最终回复发出后会自动收束这类活动状态。
  • shared bot 模式下,外部通道可使用平台内置工具和已配置能力;涉及写入或高风险操作时仍遵循项目的确认与权限规则。

权限与验证规则:

  • 只有项目 manager 及以上角色可以修改、测试或控制通道配置。
  • Test connection 只检查当前通道凭据是否可用;收到真实外部事件后,页面下方才会出现绑定记录。
  • 飞书通道使用 WebSocket 长连接接收事件。保存配置后通常还需要点击 ConnectReconnect,并保持 ResearchX 服务持续运行。

排查时重点关注以下状态信息:

  • Status:是否已经完成项目级配置。
  • connection_status:当前连接状态,例如 connecteddisconnectederror
  • Last runtime error:最近一次错误,通常能提示是凭据错误、网络不通还是连接失败。
  • Active external bindings:查看外部聊天是否已经和 ResearchX 会话建立对应关系。

MCP(Model Context Protocol)服务器

MCP 服务器可以理解为“把外部工具接到当前项目里”。管理员或项目管理者配置好后,助手就可以在对话中调用这些外部工具。

项目工作台资产弹窗中的 MCP 标签页可用于管理这类外部工具服务:

  • 点击 New 新建服务,填写名称和服务地址
  • 点击 Test & Load Tools 检查连接,并加载这个服务提供的工具
  • 保存并启用后,这些工具就可以出现在会话中
  • Expose tools to chat 用来控制是否允许聊天助手看到这些工具
  • 如果某些工具风险较高,可以要求调用前先经过用户确认;确认流程与普通工具权限确认一致

推荐阅读顺序

  1. 快速开始
  2. 核心概念
  3. 账号与认证
  4. 项目管理
  5. 容器管理
  6. Agent / Action / Runtime / Visualizer 管理
  7. 会话与消息
  8. 网络搜索
  9. MCP 服务器
  10. Skill 管理
  11. 文件管理
  12. 模型管理(Owner)
  13. 模型计费与钱包
  14. 协作与权限边界
  15. 容器固定挂载(管理员)
  16. 检索记忆
  17. 资源配额管理
  18. 执行平台
  19. 常见问题
  20. 故障排查与支持

范围说明

  • 本手册优先覆盖已上线能力与标准操作路径。
  • 规划中能力会在对应章节明确标注为“后续版本”。