Technical Documentation: labring/FastGPT
ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference
Overview (README.md)
https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4
快速开始
可以通过 Docker 快速启动 FastGPT，在终端输入以下命令，根据引导完成输入即可拉取配置。
# 输入命令拉取配置文件
bash <(curl -fsSL https://doc.fastgpt.io/deploy/install.sh)
# 启动
docker compose up -d完全启动后，可通过 http://localhost:3000 访问 FastGPT，默认账号为 root，密码为 1234。
如果你遇到问题，可以查看完整 Docker 部署教程
🛸 使用方式
云服务版本
如果你不需要私有化部署，可以直接使用我们提供的云服务版本，地址为：fastgpt.io社区自托管版本
可以使用Docker快速部署，也可以使用Sealos Cloud 来一键部署FastGPT。商业版
如果你需要更完整的功能，或深度的服务支持，可以选择我们的商业版。我们除了提供完整的软件外，还提供相应的场景落地辅导，具体可提交商业咨询
💡 核心功能
1 应用编排能力
- Agent Skill 编排
- 对话工作流、插件工作流，包含基础的 RPA 节点
- 用户交互
- 双向 MCP
- 辅助生成工作流
2 应用调试能力
- 知识库单点搜索测试
- 对话时反馈引用并可修改与删除
- 完整调用链路日志
- 应用评测
- 高级编排 DeBug 调试模式
- 应用节点日志
3 知识库能力
- 多库复用，混用
- chunk 记录修改和删除
- 支持手动输入，直接分段，QA 拆分导入
- 支持 TXT，MD，HTML，PDF，Docx，PPTX，CSV，XLSX (有需要更多 File Loader 可 PR )，支持 URL 读取、CSV 批量导入
- 混合检索 & 重排
- API 知识库
4 插件能力
- 系统工具热更新
- RAG 模块热更新
- Agent-loop 热更新
- AI 实时生成插件
5 运营能力
- 免登录分享窗口
- iframe 一键嵌入
- 统一查阅对话记录，并对数据进行标注
- 应用运营日志
💪 我们的项目 & 链接
🌿 第三方生态
🏘️ 社区交流群
扫码加入飞书话题群：
🤝 贡献者
我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub Issues，大展身手，向我们展示你的奇思妙想。
| **** | |
🌟 Star History
使用协议
本仓库遵循 FastGPT Open Source License 开源协议。
- 允许作为后台服务直接商用，但不允许提供 SaaS 服务。
- 未经商业授权，任何形式的商用服务均需保留相关版权信息。
- 完整请查看 FastGPT Open Source License
- 联系方式：[email protected]，点击查看商业版定价策略
.Agents Skills Doc I18n SKILL (`.agents/skills/doc/i18n/SKILL.md`)
name: doc-i18n
概述
FastGPT 文档采用双文件 i18n 方案，中文为源语言，英文为目标语言。你的任务是将中文文档翻译为自然流畅的北美英文，而非逐字直译。
开始翻译前，必须完整阅读并遵守以下共享规则：
共享词库是产品术语的唯一事实来源，优先级高于现有英文文档、同类产品用词和通用技术习惯。不要在本 Skill 中维护第二套产品词表。
文件结构
文档位于 document/content/ 目录下，可能分布在 docs/、self-host/ 等子目录：
- 内容文件：
{name}.mdx（中文） →{name}.en.mdx（英文） - 导航文件：
meta.json（中文） →meta.en.json（英文）
工作流程
1. 确定翻译范围
两种方式确定需要翻译的文件：
自动检测（用户未指定具体文件时）：
- 运行
git diff --name-only和git diff --cached --name-only检测document/下变更的中文文件 - 筛选出
.mdx（排除.en.mdx）和meta.json（排除meta.en.json） - 检查对应的英文文件是否存在或是否需要更新
手动指定：用户直接给出文件路径或目录。
无论使用哪种方式，只要翻译范围包含 .mdx 内容文件，都必须把同目录的 meta.json / meta.en.json 纳入检查范围，避免新增英文内容后导航缺失。
2. 翻译内容文件（.mdx → .en.mdx）
对每个中文 .mdx 文件，生成或更新对应的 .en.mdx 文件。
翻译前先按最长中文词组匹配共享词库。例如，知识库引用 必须整体匹配为 Dataset citation(s)，不能拆成 知识库 和 引用 分别处理。根据文档语法调整大小写和单复数，但不得改用词库列出的禁用译法。
保持不变的部分：
- MDX import 语句（如
import { Alert } from '@/components/docs/Alert'） - 图片路径（如 ``）
- 链接 URL（保持原始 URL 不变）
- HTML/JSX 组件结构和属性（如
<Alert icon="🤖" context="success">） - 表格的 markdown 结构
- 代码块内容（除非是中文注释）
- emoji 符号
需要翻译的部分：
- frontmatter 的
title和description - 所有正文文本内容
- 组件内的文本内容（如 Alert 内的文字）
- 表格中的文字内容
- 代码块中的中文注释
3. 同步导航文件（meta.json → meta.en.json）
对每个中文 meta.json，生成或更新对应的 meta.en.json。翻译 .mdx 文件时，也要同步检查其同目录导航文件：
- 如果同目录存在
meta.json，检查本次翻译的中文文件 basename（如41503.mdx→41503）是否在pages数组中。 - 如果中文文件是新增页面且
meta.json未引用，应按目录内现有排序和上下文更新meta.json；无法可靠判断位置时，先询问用户，不要只创建.en.mdx后忽略导航。 meta.en.json的pages必须与meta.json保持一致，只翻译title、description和分隔符字符串，不要翻译或删除页面文件名引用。- 如果
meta.en.json缺失，必须创建；如果已存在但pages落后于meta.json，必须同步。 - 如果用户只指定了
meta.json，仍按导航文件翻译规则更新meta.en.json，并检查pages中引用的中文.mdx是否有对应.en.mdx。 - 修改导航 JSON 时优先使用结构化 JSON 方式或严格保持原文件格式，避免手改导致尾逗号、缩进漂移或
pages顺序错误。
需要翻译的字段：title、description、分隔符字符串（如 "---入门---" → "---Getting Started---"）
保持不变的字段：pages 数组中的文件名引用、icon、root、order
4. 翻译完成后
- 对照中文源文和共享词库复核所有产品术语；发现禁用译法时必须修正
- 搜索英文文件中的残留汉字，并逐项确认是品牌名、代码示例还是漏译
- 对词库中的语境词进行人工复核，例如
训练应按功能使用Indexing、Processing或Reindex - 如果遇到词库未收录且会影响产品概念一致性的术语，先向用户报告并确认推荐译法，不要自行固化新术语
- 列出所有已翻译的文件
- 列出所有已更新或确认无需更新的
meta.json/meta.en.json - 如果发现中文文件有对应英文文件缺失的情况，提醒用户
- 如果发现中文
.mdx未被同目录meta.json引用，且本次未能安全更新导航，明确提醒用户
翻译原则
这些原则的核心目标是让北美开发者读起来感觉像是原生英文文档，而不是翻译过来的。
语言风格
- 面向北美开发者，使用自然的美式英语技术写作风格
- 不要逐字翻译，要传达原文的意思和意图
- 技术文档倾向简洁直接，避免冗余修饰
- 中文文档常用的排比、铺陈手法，翻译时应精简为英文读者习惯的表达
示例：
中文：可轻松导入各式各样的文档及数据，能自动对其开展知识结构化处理工作。
✗：You can easily import various documents and data, which will be automatically processed for knowledge structuring.
✓：Import documents and data with automatic knowledge structuring.中国特有平台和服务的本地化
直接使用国际版名称，不保留中文原名：
| 中文 | 英文 |
|---|---|
| 飞书 | Lark |
| 企业微信 | WeCom |
| 钉钉 | DingTalk |
| 公众号 | WeChat Official Account |
| 文心一言 | ERNIE Bot |
| 中国大陆版 | China Mainland |
| 国际版 | International |
技术术语
FastGPT 产品概念必须使用共享专有名词库，不得因为现有文档或竞品采用其他叫法而替换。例如：
知识库→Dataset，不是Knowledge Base数据集→Collection，不是Dataset节点、模块→Node，不是Module调试→Debug；试运行→Test Run引用→Citation；知识库引用→Dataset citation(s)问题优化→Query rewriting索引模型→Embedding model
词库未覆盖的纯技术概念使用业界通用术语，例如 LLM、Vector Store、Low-code。如需参考 n8n 或 Dify，只能比较底层产品含义；FastGPT 共享词库始终优先。
语气
- 保持专业但友好的语气，和原文档的风格一致
- 不要过度正式，也不要过于随意
- 面向开发者和技术用户，假设读者有基本的技术背景
--- METRICS ---
- Files Extracted: 2
- Estimated Token Budget: ~2819 tokens
- Canonical Reference: https://codewiki.google/github.com/labring/FastGPT