多语言文档 AI 驱动导入使用说明

多语言文档 AI 驱动导入 使用文档
多语言文档 AI 驱动导入 使用文档

一、模块用途

本模块用于接收人工智能工具生成或整理的 Markdown 文档。人工智能工具先读取网站当前启用的语言和文档分类,再检查准备提交的内容,最后创建待审核任务。

管理员可以在后台逐篇查看标题、语言、分类和正文。确认无误后发布,不适合发布的文档可以填写原因并驳回。

当前只接收扩展名为 .md.markdown 的文档。

二、安装与启用

安装本模块前,请先安装并启用:

  • Vendor 4.8.0 及以上;
  • I18nDocument 1.6.0 及以上;
  • I18nDocumentMarkdown 1.1.0 及以上;
  • ModStart 5.0.0 及以上。

安装步骤:

  1. 登录系统后台。
  2. 进入“系统管理-模块管理-本地模块”。
  3. 安装并启用“I18nDocumentAiImport 多语言文档 AI 驱动导入”。
  4. 刷新后台页面,确认“内容管理-AI驱动导入”下出现四个功能入口。

后台菜单如下:

内容管理
└─ AI驱动导入
   ├─ AI API 客户端
   ├─ AI API 调用审计
   ├─ AI 导入任务
   └─ AI 接入说明

如果菜单没有出现,请先确认模块已经启用,再检查当前管理员是否拥有相应权限。

三、模块设置

进入模块设置后可以调整以下内容:

设置项 默认值 说明
启用 AI 导入 API 开启 关闭后,所有外部导入请求都会被拒绝
允许 API 直接发布 关闭 开启后仍需客户端拥有直接发布权限;普通使用建议保持关闭
单批最大文档数 50 每次允许提交的文档数量,系统实际允许范围为 1~200

正式使用时建议保留人工审核,不要为普通客户端开启直接发布。

四、首次接入

第一步:创建客户端密钥

  1. 进入“内容管理-AI驱动导入-AI API 客户端”。
  2. 填写一个容易识别的名称,例如“Codex-办公电脑”。
  3. 根据需要设置每分钟和每天的调用次数。
  4. 如需限制来源,可填写允许访问的网络地址。
  5. 填写有效期,单位为天,默认 30 天,可填写 1~99999。
  6. 普通导入保留“读取语言与分类、检查文档、创建待审核任务”三项权限。
  7. 点击“创建客户端密钥”。

“直接发布文档”可以跳过人工审核,普通客户端不要勾选。

第二步:保存三项配置

创建成功后,打开“查看接入”,页面会显示:

  • 网站接口地址;
  • 客户端编号(App ID);
  • 客户端密钥(App Secret)。

网站接口地址根据当前网站配置自动生成,不需要手工修改模块代码。建议把三项内容保存到人工智能工具提供的安全变量中:

RESDOC_BASE_URL
RESDOC_APP_ID
RESDOC_APP_SECRET

不要把客户端密钥保存到 Markdown、源码、版本库或公开对话中。

第三步:测试连接

在“查看接入”页面点击“发送测试请求”。连接成功时,页面会显示网站语言和分类的数量。

测试只检查网站地址、客户端密钥、权限和访问限制,不会创建任务,也不会发布文档。

第四步:安装示例技能包

  1. 进入“AI 接入说明”。
  2. 打开“新手示例-示例 Skill 安装”。
  3. 下载示例技能包并解压。
  4. 按页面中对应工具的安装路径,复制四个技能文件夹。
  5. 完全退出并重新打开人工智能工具,使工具重新读取技能。

压缩包根目录中的 suite-manifest.json 是版本和文件清单,只用于核对套件是否完整,不需要复制到技能安装目录。

第五步:复制并执行提示词

“查看接入”页面提供三种提示词:

  • 核心提示词:用于补充到用户自己编写的任务中;
  • 不含密钥的一键提示词:从安全变量读取密钥,适合日常使用;
  • 含密钥的一键提示词:只适合临时测试,不要保存或转发。

把不含密钥的一键提示词发送到需要整理的当前对话后,工具应直接完成以下工作:

  1. 在当前工作目录建立 fileMD_YYYYMMDDhhmmss 文件夹。
  2. 整理当前完整对话,生成 Markdown 文件并保存到该文件夹。
  3. 重新读取生成的文件,检查内容是否完整并移除敏感信息。
  4. 获取网站最新语言和文档分类。
  5. 检查整批文档并创建待审核任务。
  6. 查询任务状态,返回请求编号、任务编号和每篇文档的分类结果。

如果目录不可写、技能缺失、安全变量未配置、分类不可靠或网站返回失败,工具应停止并说明原因,不能把未完成的操作报告为成功。已经生成的本地文件应保留,方便修正后重新提交。

五、导入已有 Markdown 文档

如果要导入已有文件,应明确告诉人工智能工具文件夹和语言,例如:

请导入 D:\Docs\待发布 目录中的 Markdown 文档,语言为 zh-CN。
只读取这个目录中的 .md 和 .markdown 文件。
请使用网站提供的核心提示词完成分类、检查并创建待审核任务。

不要要求工具扫描整个磁盘,也不要授权读取与本次导入无关的目录。

新增同一主文档的其他语言内容时,需要提供准确的主文档编号。更新已有语言内容时,需要提供准确的内容记录编号和最新内容摘要。如果无法唯一确认目标,工具应停止,不能只按标题猜测并覆盖。

六、审核与发布

  1. 进入“内容管理-AI驱动导入-AI 导入任务”。
  2. 根据人工智能工具返回的任务编号或请求编号找到任务。
  3. 点击“查看文档与审核”。
  4. 逐篇检查标题、语言、父级分类、分类理由、正文、图片和附件地址。
  5. 对正确的文档点击“审核通过并发布此文档”。
  6. 对有问题的文档填写原因并点击“驳回此文档”。

也可以批量处理所有仍在等待审核的文档。系统会逐篇保存并显示处理进度,只有实际保存成功的文档才计入成功数量。部分文档失败时,应打开对应文档查看原因,修正后用新的请求编号重新提交。

七、四个后台入口

入口 用途
AI API 客户端 创建、查看、停用和轮换客户端密钥,设置权限及调用限制
AI API 调用审计 查看调用时间、接口、结果和错误原因,不显示完整密钥及文档正文
AI 导入任务 查看任务和文档,逐篇或批量审核
AI 接入说明 查看使用说明、新手示例、接口文档、技能安装方法和提示词

普通用户不需要自己编写调用代码。接口路径、请求字段、签名方法和手工调试示例统一放在“AI 接入说明-接口文档”中。

八、安全注意事项

  • 每个工具或设备建议使用独立的客户端密钥,便于查看记录和单独停用。
  • 设备丢失、人员变动或怀疑密钥泄露时,应立即停用客户端或轮换密钥。
  • 不要上传密码、环境变量、版本库凭证、原始对话编号及其他敏感内容。
  • 模块不接受本机磁盘地址、file:// 地址或网络共享路径作为文档资源。
  • 相对图片和附件只会收到提醒,服务器不会自动上传这些文件。
  • 正式使用建议关闭直接发布,由管理员检查后再发布。

九、常见问题

测试连接失败

检查网站接口地址、客户端编号和客户端密钥是否正确;再检查客户端是否启用、是否过期、当前访问地址是否在允许范围内,以及电脑时间是否准确。

检查通过,但后台没有任务

“检查文档”只验证内容,不会保存任务。应确认工具继续执行了“创建待审核任务”,并返回了真实的任务编号。

后台有任务,但前台没有文档

新任务默认等待审核。管理员需要进入任务详情,审核通过后文档才会发布。

图片或附件无法访问

检查 Markdown 中是否仍使用本机路径或相对路径。请先把资源上传到网站,再改为站内地址或安全的网络地址。

提示请求编号已经用于其他内容

同一请求编号只能重试完全相同的内容。文档内容发生变化后,应生成新的请求编号。

任务只有部分文档成功

打开任务详情查看每篇文档的处理结果。已经发布成功的文档不会撤销,只需修正失败内容并重新提交。

更新: 2026-09-11 10:16:14
QQ
微信
客服