v4.6.4 (#585)

* perf: md format

* add systemConfig schema (#2)

* fix: markdown

* fix: root

* fix: root

---------

Co-authored-by: heheer <71265218+newfish-cmyk@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bugs.md

@@ -11,7 +11,7 @@ assignees: ''
 [//]: # '方框内填 x 表示打钩'
 
 - [ ] 我已确认目前没有类似 issue
-- [ ] 我已完整查看过项目 README，以及[项目文档](https://doc.fastgpt.run/docs/intro/)
+- [ ] 我已完整查看过项目 README，以及[项目文档](https://doc.fastgpt.in/docs/intro/)
 - [ ] 我使用了自己的 key，并确认我的 key 是可正常使用的
 - [ ] 我理解并愿意跟进此 issue，协助测试和提供反馈
 - [x] 我理解并认可上述内容，并理解项目维护者精力有限，**不遵循规则的 issue 可能会被无视或直接关闭**

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
   - name: 微信交流群
-    url: https://doc.fastgpt.run/wechat-fastgpt.webp
+    url: https://doc.fastgpt.in/wechat-fastgpt.webp
     about: FastGPT 全是问题群

.github/workflows/fastgpt-image-personal.yml

@@ -0,0 +1,52 @@
+name: Build FastGPT images in Personal warehouse
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'projects/app/**'
+      - 'packages/**'
+    branches:
+      - 'main'
+jobs:
+  build-fastgpt-images:
+    runs-on: ubuntu-20.04
+    if: github.repository != 'labring/FastGPT'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GH_PAT }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt:latest" >> $GITHUB_ENV
+      - name: Build and publish image for main branch or tag push event
+        env:
+          DOCKER_REPO_TAGGED: ${{ env.DOCKER_REPO_TAGGED }}
+        run: |
+          docker buildx build \
+          --build-arg name=app \
+          --label "org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/FastGPT" \
+          --label "org.opencontainers.image.description=fastgpt image" \
+          --push \
+          --cache-from=type=local,src=/tmp/.buildx-cache \
+          --cache-to=type=local,dest=/tmp/.buildx-cache \
+          -t ${DOCKER_REPO_TAGGED} \
+          -f Dockerfile \
+          .

.github/workflows/fastgpt-image.yml

@@ -5,8 +5,6 @@ on:
     paths:
       - 'projects/app/**'
       - 'packages/**'
-    branches:
-      - 'main'
     tags:
       - 'v*.*.*'
 jobs:
@@ -53,9 +51,8 @@ jobs:
           docker buildx build \
           --build-arg name=app \
           --platform linux/amd64,linux/arm64 \
-          --label "org.opencontainers.image.source=  https://github.com/  ${{ github.repository_owner }}/FastGPT" \
+          --label "org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/FastGPT" \
           --label "org.opencontainers.image.description=fastgpt image" \
-          --label "org.opencontainers.image.licenses=Apache" \
           --push \
           --cache-from=type=local,src=/tmp/.buildx-cache \
           --cache-to=type=local,dest=/tmp/.buildx-cache \

.github/workflows/preview-image.yml

@@ -24,7 +24,7 @@ jobs:
         with:
           driver-opts: network=host
       - name: Cache Docker layers
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-${{ github.sha }}
@@ -48,6 +48,7 @@ jobs:
           --label "org.opencontainers.image.source=  https://github.com/  ${{ github.repository_owner }}/FastGPT" \
           --label "org.opencontainers.image.description=fastgpt-pr image" \
           --label "org.opencontainers.image.licenses=Apache" \
+          --push \
           --cache-from=type=local,src=/tmp/.buildx-cache \
           --cache-to=type=local,dest=/tmp/.buildx-cache \
           -t ${DOCKER_REPO_TAGGED} \

Dockerfile

@@ -42,9 +42,7 @@ ARG name
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
 
-RUN sed -i 's/https/http/' /etc/apk/repositories
+RUN apk add --no-cache curl ca-certificates \
-RUN apk add curl \
-  && apk add ca-certificates \
   && update-ca-certificates
 
 # copy running files

README.md

@@ -6,7 +6,8 @@
 
 <p align="center">
   <a href="./README_en.md">English</a> |
-  <a href="./README.md">简体中文</a>
+  <a href="./README.md">简体中文</a> |
+  <a href="./README_ja.md">日语</a>
 </p>
 
 FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开箱即用的数据处理、模型调用等能力。同时可以通过 Flow 可视化进行工作流编排，从而实现复杂的问答场景！
@@ -17,10 +18,10 @@ FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开
   <a href="https://fastgpt.run/">
     <img height="21" src="https://img.shields.io/badge/在线使用-d4eaf7?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
   </a>
-  <a href="https://doc.fastgpt.run/docs/intro">
+  <a href="https://doc.fastgpt.in/docs/intro">
     <img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document">
   </a>
-  <a href="https://doc.fastgpt.run/docs/development">
+  <a href="https://doc.fastgpt.in/docs/development">
     <img height="21" src="https://img.shields.io/badge/本地开发-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
   </a>
   <a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
@@ -43,6 +44,10 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 | ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
 | ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 💡 功能
 
 1. 强大的可视化编排，轻松构建 AI 应用
@@ -78,6 +83,10 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
    - [x] Iframe 一键嵌入
    - [x] 统一查阅对话记录，并对数据进行标注
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 👨‍💻 开发
 
 项目技术栈：NextJs + TS + ChakraUI + Mongo + Postgres (Vector 插件)
@@ -91,19 +100,27 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
   由于需要部署数据库，部署完后需要等待 2~4 分钟才能正常访问。默认用了最低配置，首次访问时会有些慢。
 
 * [快开始本地开发](https://doc.fastgpt.in/docs/development/intro/)
-* [部署 FastGPT](https://doc.fastgpt.in/docs/installation)
+* [部署 FastGPT](https://doc.fastgpt.in/docs/development/sealos)
 * [系统配置文件说明](https://doc.fastgpt.in/docs/development/configuration/)
-* [多模型配置](https://doc.fastgpt.in/docs/installation/one-api/)
+* [多模型配置](https://doc.fastgpt.in/docs/development/one-api/)
-* [版本更新/升级介绍](https://doc.fastgpt.in/docs/installation/upgrading)
+* [版本更新/升级介绍](https://doc.fastgpt.in/docs/development/upgrading)
 * [OpenAPI API 文档](https://doc.fastgpt.in/docs/development/openapi/)
 * [知识库结构详解](https://doc.fastgpt.in/docs/use-cases/datasetengine/)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 🏘️ 社区交流群
 
 添加 wx 小助手加入：
 
 ![](https://otnvvf-imgs.oss.laf.run/wx300.jpg)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 💪 相关项目
 
 - [Laf：3 分钟快速接入三方应用](https://github.com/labring/laf)
@@ -111,20 +128,36 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 - [One API：多模型管理，支持 Azure、文心一言等](https://github.com/songquanpeng/one-api)
 - [TuShan：5 分钟搭建后台管理系统](https://github.com/msgbyte/tushan)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 👀 其他
 
 - [保姆级 FastGPT 教程](https://www.bilibili.com/video/BV1n34y1A7Bo/?spm_id_from=333.999.0.0)
 - [接入飞书](https://www.bilibili.com/video/BV1Su4y1r7R3/?spm_id_from=333.999.0.0)
 - [接入企微](https://www.bilibili.com/video/BV1Tp4y1n72T/?spm_id_from=333.999.0.0)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 🤝 第三方生态
 
-- [OnWeChat 个人微信/企微机器人](https://doc.fastgpt.run/docs/use-cases/onwechat/)
+- [OnWeChat 个人微信/企微机器人](https://doc.fastgpt.in/docs/use-cases/onwechat/)
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
 ## 🌟 Star History
 
 [![Star History Chart](https://api.star-history.com/svg?repos=labring/FastGPT&type=Date)](https://star-history.com/#labring/FastGPT&Date)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 使用协议
 
 本仓库遵循 [FastGPT Open Source License](./LICENSE) 开源协议。
@@ -132,4 +165,4 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 1. 允许作为后台服务直接商用，但不允许提供 SaaS 服务。
 2. 未经商业授权，任何形式的商用服务均需保留相关版权信息。
 3. 完整请查看 [FastGPT Open Source License](./LICENSE)
-4. 联系方式：yujinlong@sealos.io，[点击查看商业版定价策略](https://doc.fastgpt.run/docs/commercial)
+4. 联系方式：yujinlong@sealos.io，[点击查看商业版定价策略](https://doc.fastgpt.in/docs/commercial)

README_en.md

@@ -6,7 +6,8 @@
 
 <p align="center">
   <a href="./README_en.md">English</a> |
-  <a href="./README.md">简体中文</a>
+  <a href="./README.md">简体中文</a> |
+  <a href="./README_ja.md">日语</a>
 </p>
 
 FastGPT is a knowledge-based Q&A system built on the LLM, offers out-of-the-box data processing and model invocation capabilities, allows for workflow orchestration through Flow visualization!
@@ -41,6 +42,10 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 | ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
 | ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 💡 Features
 
 1. Powerful visual workflows: Effortlessly craft AI applications
@@ -86,6 +91,10 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
    - [x] One-click embedding with Iframe
    - [ ] Unified access to dialogue records
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 👨‍💻 Development
 
 Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
@@ -111,6 +120,10 @@ Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
 | ------------------------------------------------- | ---------------------------------------------- |
 | ![](https://otnvvf-imgs.oss.laf.run/wxqun300.jpg) | ![](https://otnvvf-imgs.oss.laf.run/wx300.jpg) | -->
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 👀 Others
 
 - [FastGPT FAQ](https://kjqvjse66l.feishu.cn/docx/HtrgdT0pkonP4kxGx8qcu6XDnGh)
@@ -118,6 +131,10 @@ Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
 - [Official Account Integration Video Tutorial](https://www.bilibili.com/video/BV1xh4y1t7fy/)
 - [FastGPT Knowledge Base Demo](https://www.bilibili.com/video/BV1Wo4y1p7i1/)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 💪 Related Projects
 
 - [Laf: 3-minute quick access to third-party applications](https://github.com/labring/laf)
@@ -125,10 +142,18 @@ Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
 - [One API: Multi-model management, supports Azure, Wenxin Yiyuan, etc.](https://github.com/songquanpeng/one-api)
 - [TuShan: Build a backend management system in 5 minutes](https://github.com/msgbyte/tushan)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 🤝 Third-party Ecosystem
 
 - [luolinAI: Enterprise WeChat bot, ready to use](https://github.com/luolin-ai/FastGPT-Enterprise-WeChatbot)
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 🌟 Star History
 
 [![Star History Chart](https://api.star-history.com/svg?repos=labring/FastGPT&type=Date)](https://star-history.com/#labring/FastGPT&Date)

README_ja.md

@@ -0,0 +1,135 @@
+<div align="center">
+
+<a href="https://fastgpt.run/"><img src="/.github/imgs/logo.svg" width="120" height="120" alt="fastgpt logo"></a>
+
+# FastGPT
+
+<p align="center">
+  <a href="./README_en.md">English</a> |
+  <a href="./README.md">简体中文</a> |
+  <a href="./README_ja.md">日语</a>
+</p>
+
+FastGPT は、LLM 上 に 構築 された 知識 ベースの Q&A システムで、すぐに 使 えるデータ 処理 とモデル 呼 び 出 し 機能 を 提供 し、Flow の 可視化 を 通 じてワークフローのオーケストレーションを 可能 にします！
+
+</div>
+
+<p align="center">
+  <a href="https://fastgpt.run/">
+    <img height="21" src="https://img.shields.io/badge/在线使用-d4eaf7?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
+  </a>
+  <a href="https://doc.fastgpt.run/docs/intro">
+    <img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document">
+  </a>
+  <a href="https://doc.fastgpt.run/docs/development">
+    <img height="21" src="https://img.shields.io/badge/本地开发-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
+  </a>
+  <a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
+    <img height="21" src="https://img.shields.io/badge/相关项目-7d09f1?style=flat-square" alt="project">
+  </a>
+  <a href="https://github.com/labring/FastGPT/blob/main/LICENSE">
+    <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=d4eaf7&color=7d09f1" alt="license">
+  </a>
+</p>
+
+https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4
+
+## 🛸 クラウドサービスの 利用
+
+[fastgpt.run](https://fastgpt.run/)
+| | |
+| ---------------------------------- | ---------------------------------- |
+| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
+| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
+
+## 💡 機能
+
+1. パワフルなビジュアルワークフロー：AI アプリケーションを 簡単 に 作成
+
+   - [x] デッキのシンプルモード - マニュアルアレンジ 不要
+   - [x] ユーザ 対話事前 ガイダンス
+   - [x] グローバル 変数
+   - [x] ナレッジベース 検索
+   - [x] 複数 の LLM モデルによる 対話
+   - [x] テキストマジック - 構造化 データへの 変換
+   - [x] HTTP による 拡張
+   - [ ] on-the-fly HTTP モジュールのための 埋 め 込 みLaf
+   - [x] 次 の 対話 ステップへの 指示
+   - [x] ソースファイル 参照 の 追跡
+   - [ ] カスタムファイルリーダー
+   - [ ] モジュールをプラグインにパッケージして 再利用 する
+
+2. 広範 なナレッジベースの 前処理
+
+   - [x] 複数 のナレッジベースの 再利用 と 混合
+   - [x] チャンクの 変更 と 削除 を 追跡
+   - [x] 手動入力、直接分割、QA 分割 インポートをサポート
+   - [x] URL フェッチとバッチ CSV インポートをサポート
+   - [x] ナレッジベースにユニークなベクトルモデルを 設定可能
+   - [x] オリジナルファイルの 保存
+   - [ ] ファイル 学習 エージェント
+
+3. 複数 の 効果測定 チャンネル
+
+   - [x] シングルポイントナレッジベース 検索 テスト
+   - [x] 対話中 のフィードバック 参照 と 修正 ・ 削除機能
+   - [x] 完全 なコンテキストの 提示
+   - [ ] 完全 なモジュール 中間値提示
+
+4. OpenAPI
+
+   - [x] 補完 インターフェイス (GPT インターフェイスに 合 わせる)
+   - [ ] ナレッジベース CRUD
+
+5. オペレーション 機能
+
+   - [x] ログイン 不要 の 共有 ウィンドウ
+   - [x] Iframe によるワンクリック 埋 め 込 み
+   - [ ] 対話記録 への 統一 されたアクセス
+
+## 👨‍💻 開発
+
+プロジェクトの 技術 スタック：NextJs + TS + ChakraUI + Mongo + Postgres (Vector プラグイン)
+
+- **⚡ デプロイ**
+
+  [![](https://cdn.jsdelivr.us/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt)
+
+  デプロイ 後、データベースをセットアップするので、2～4分待 ってください。基本設定 を 使 っているので、最初 は 少 し 遅 いかもしれません。
+
+- [ローカル 開発入門](https://doc.fastgpt.run/docs/development)
+- [FastGPT のデプロイ](https://doc.fastgpt.run/docs/installation)
+- [システム 設定 ガイド](https://doc.fastgpt.run/docs/installation/reference)
+- [複数 モデルの 設定](https://doc.fastgpt.run/docs/installation/reference/models)
+- [バージョン 更新 とアップグレード](https://doc.fastgpt.run/docs/installation/upgrading)
+
+<!-- ## :point_right: ロードマップ
+- [FastGPT ロードマップ](https://kjqvjse66l.feishu.cn/docx/RVUxdqE2WolDYyxEKATcM0XXnte) -->
+
+<!-- ## 🏘️ コミュニティ
+
+| コミュニティグループ                                 | アシスタント                                     |
+| ------------------------------------------------- | ---------------------------------------------- |
+| ![](https://otnvvf-imgs.oss.laf.run/wxqun300.jpg) | ![](https://otnvvf-imgs.oss.laf.run/wx300.jpg) | -->
+
+## 👀 その 他
+
+- [FastGPT FAQ](https://kjqvjse66l.feishu.cn/docx/HtrgdT0pkonP4kxGx8qcu6XDnGh)
+- [Docker 導入 チュートリアル 動画](https://www.bilibili.com/video/BV1jo4y147fT/)
+- [公式 アカウント 統合 ビデオチュートリアル](https://www.bilibili.com/video/BV1xh4y1t7fy/)
+- [FastGPT ナレッジベースデモ](https://www.bilibili.com/video/BV1Wo4y1p7i1/)
+
+## 💪 関連 プロジェクト
+
+- [Laf：サードパーティ 製 アプリケーションに 3 分 でクイックアクセス](https://github.com/labring/laf)
+- [Sealos：クラスタアプリケーションの 迅速 な 展開](https://github.com/labring/sealos)
+- [One API：マルチモデル 管理、Azure、Wenxin Yiyuan などをサポートします。](https://github.com/songquanpeng/one-api)
+- [TuShan：5 分 でバックエンド 管理 システムを 構築](https://github.com/msgbyte/tushan)
+
+## 🤝 サードパーティエコシステム
+
+- [luolinAI：すぐに 使 える 企業向 け WeChat ボット](https://github.com/luolin-ai/FastGPT-Enterprise-WeChatbot)
+
+## 🌟 Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=labring/FastGPT&type=Date)](https://star-history.com/#labring/FastGPT&Date)

docSite/.zhlintrc

@@ -1,6 +1,6 @@
 {
-  "preset": "default",
+    "preset": "default",
-  "rules": {
+    "rules": {
-    "adjustedFullWidthPunctuation": ""
+      "adjustedFullWidthPunctuation": ""
-  }
+    }
-}
+  }

docSite/content/docs/_index.md

@@ -1,5 +1,5 @@
 ---
-weight: 10
+weight: 0
 title: '文档'
 description: 'FastGPT 官方文档'
 icon: menu_book

docSite/content/docs/agreement/_index.md

@@ -1,8 +1,8 @@
 ---
-weight: 1100
+weight: 1200
-title: '社区'
+title: '协议'
 description: '社区相关内容'
-icon: 'forum'
+icon: 'handshake'
 draft: false
 images: []
 ---

docSite/content/docs/agreement/disclaimer.md

@@ -0,0 +1,38 @@
+---
+title: '免责声明'
+description: ' FastGPT 免责声明'
+icon: 'gavel'
+draft: false
+toc: true
+weight: 1220
+---
+
+由于生成式 AI 的特性，其在不同国家的管控措施也会有所不同。请所有使用者务必遵守所在地的相关法律。
+
+免责声明：以任何违反 FastGPT 可接受使用政策的方式使用，包括但不限于法律、法规、政府命令或法令禁止的任何用途，或任何侵犯他人权利的使用；由使用者自行承担。我们对由客户使用产生的问题概不负责。
+
+下面是各国对生成式AI的管控条例的链接：
+
+[中国生成式人工智能服务管理办法（征求意见稿）](http://www.cac.gov.cn/2023-04/11/c_1682854275475410.htm)
+
+## 内容要求 
+
+我们禁止使用我们对接的模型服务生成可能对个人或社会造成伤害的内容。保障平台的安全性，是长期稳定运营的关键。如发现任何利用平台接入模型能力进行违规内容生成和使用，将立即封号，账号余额不退。
+
+- 剥削和虐待 
+  - 禁止描述、展示或宣扬儿童性剥削或性虐待的内容，无论法律是否禁止。这包括涉及儿童或使儿童色情的内容。
+  - 禁止描述或用于培养儿童的内容。修饰是成年人以剥削，特别是性剥削为目的与儿童建立关系的行为。这包括以性剥削、贩运或其他形式剥削为目的与儿童交流。
+- 未经同意的私密内容 
+  - 服务禁止描述、提供或宣传未经同意的亲密活动的内容。
+- 禁止描述、提供特征或宣传或用于招揽商业性活动和性服务的内容。这包括鼓励和协调真正的性活动。
+- 禁止描述或用于人口贩运目的的内容。这包括招募人员、便利交通、支付和助长对人的剥削，如强迫劳动、家庭奴役、役、强迫婚姻和强迫医疗程序。
+- 自杀和自残，禁止描述、赞美、支持、促进、美化、鼓励和/或指导个人自残或自杀的内容。
+- 暴力内容和行为 
+  - 禁止描述、展示或宣扬血腥暴力或血腥的内容。
+  - 禁止描绘恐怖主义行为的内容；赞扬或支持恐怖组织、恐怖行为者或暴力恐怖意识形态；鼓励恐怖活动；向恐怖组织或恐怖事业提供援助；或协助恐怖组织招募成员。
+  - 禁止通过暴力威胁或煽动来鼓吹或宣扬对他人的暴力行为的内容。
+- 仇恨言论和歧视 
+  - 禁止基于实际或感知的种族、民族、国籍、性别、性别认同、性取向、宗教信仰、年龄、残疾状况、种姓或与系统性偏见或边缘化相关的任何其他特征等特征攻击、诋毁、恐吓、降级、针对或排斥个人或群体的内容。
+  - 禁止针对个人或群体进行威胁、恐吓、侮辱、贬低或贬低的语言或图像、宣扬身体伤害或其他虐待行为（如跟踪）的内容。
+- 禁止故意欺骗并可能对公共利益产生不利影响的内容，包括与健康、安全、选举诚信或公民参与相关的欺骗性或不真实内容。
+- 直接支持非法主动攻击或造成技术危害的恶意软件活动的内容，例如提供恶意可执行文件、组织拒绝服务攻击或管理命令和控制服务器。

docSite/content/docs/agreement/open-source.md

@@ -4,7 +4,7 @@ description: ' FastGPT 开源许可证'
 icon: 'verified_user'
 draft: false
 toc: true
-weight: 1120
+weight: 1210
 ---
 
 FastGPT 项目在 Apache License 2.0 许可下开源，同时包含以下附加条件：

docSite/content/docs/commercial/_index.md

@@ -0,0 +1,9 @@
+---
+weight: 1100
+title: '商业版介绍'
+description: 'FastGPT 商业版介绍'
+icon: 'shopping_cart'
+draft: false
+images: []
+---
+<!-- 1100 ~ 1200 -->

docSite/content/docs/commercial/intro.md

@@ -4,7 +4,7 @@ description: 'FastGPT 商业版相关说明'
 icon: 'shopping_cart'
 draft: false
 toc: true
-weight: 20
+weight: 1001
 ---
 
 ## FastGPT 线上服务

docSite/content/docs/community.md

@@ -4,7 +4,7 @@ description: ' 加入 FastGPT 开发者社区和我们一起成长'
 icon: 'forum'
 draft: false
 toc: true
-weight: 1110
+weight: 1300
 ---
 
 FastGPT 是一个由用户和贡献者参与推动的开源项目，如果您对产品使用存在疑问和建议，可尝试以下方式寻求支持。我们的团队与社区会竭尽所能为您提供帮助。

docSite/content/docs/course/_index.md

@@ -0,0 +1,9 @@
+---
+weight: 100
+title: '基础教程'
+description: 'FastGPT 基础教程'
+icon: 'import_contacts'
+draft: false
+images: []
+---
+<!-- 100 ~ 300 -->

docSite/content/docs/course/quick-start.md

@@ -4,7 +4,7 @@ description: '快速体验 FastGPT 基础功能'
 icon: 'rocket_launch'
 draft: false
 toc: true
-weight: 30
+weight: 101
 ---
 
 更多使用技巧，[查看视屏教程](https://www.bilibili.com/video/BV1n34y1A7Bo/?spm_id_from=333.337.search-card.all.click&vd_source=903c2b09b7412037c2eddc6a8fb9828b)

docSite/content/docs/development/_index.md

@@ -1,8 +1,9 @@
 ---
-weight: 500
+weight: 700
-title: '开发指南'
+title: '开发与部署指南'
 description: '本地开发 FastGPT 必看'
 icon: 'code_blocks'
 draft: false
 images: []
 ---
+<!-- 700 ~ 1100 -->

docSite/content/docs/development/configuration.md

@@ -4,10 +4,10 @@ description: 'FastGPT 配置参数介绍'
 icon: 'settings'
 draft: false
 toc: true
-weight: 520
+weight: 708
 ---
 
-由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 `projects/app/data/config.json` 看到默认的配置文件。可以参考 [docker-compose 快速部署](/docs/installation/docker/) 来挂载配置文件。
+由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 `projects/app/data/config.json` 看到默认的配置文件。可以参考 [docker-compose 快速部署](/docs/development/docker/) 来挂载配置文件。
 
 **开发环境下**，你需要将示例配置文件 `config.json` 复制成 `config.local.json` 文件才会生效。
 
@@ -21,91 +21,140 @@ weight: 520
 ```json
 {
   "SystemParams": {
+    "pluginBaseUrl": "", // 商业版接口地址
     "vectorMaxProcess": 15, // 向量生成最大进程，结合数据库性能和 key 来设置
     "qaMaxProcess": 15,  // QA 生成最大进程，结合数据库性能和 key 来设置
     "pgHNSWEfSearch": 100  // pg vector 索引参数，越大精度高但速度慢
   },
-  "ChatModels": [
+  "ChatModels": [ // 对话模型
     {
-      "model": "gpt-3.5-turbo", // 实际调用的模型
+      "model": "gpt-3.5-turbo-1106",
-      "name": "GPT35-4k", // 展示的名字
+      "name": "GPT35-1106",
-      "maxToken": 4000, // 最大token，均按 gpt35 计算
+      "price": 0, // 除以 100000 后等于1个token的价格
-      "quoteMaxToken": 2000, // 引用内容最大 token
+      "maxContext": 16000, // 最大上下文长度
-      "maxTemperature": 1.2, // 最大温度
+      "maxResponse": 4000, // 最大回复长度
-      "price": 0,
+      "quoteMaxToken": 2000, // 最大引用内容长度
+      "maxTemperature": 1.2, // 最大温度值
+      "censor": false, // 是否开启敏感词过滤(商业版)
+      "vision": false, // 支持图片输入
       "defaultSystemChatPrompt": ""
     },
     {
       "model": "gpt-3.5-turbo-16k",
       "name": "GPT35-16k",
-      "maxToken": 16000,
+      "maxContext": 16000,
+      "maxResponse": 16000,
+      "price": 0,
       "quoteMaxToken": 8000,
       "maxTemperature": 1.2,
-      "price": 0,
+      "censor": false,
+      "vision": false,
       "defaultSystemChatPrompt": ""
     },
     {
       "model": "gpt-4",
       "name": "GPT4-8k",
-      "maxToken": 8000,
+      "maxContext": 8000,
+      "maxResponse": 8000,
+      "price": 0,
       "quoteMaxToken": 4000,
       "maxTemperature": 1.2,
+      "censor": false,
+      "vision": false,
+      "defaultSystemChatPrompt": ""
+    },
+    {
+      "model": "gpt-4-vision-preview",
+      "name": "GPT4-Vision",
+      "maxContext": 128000,
+      "maxResponse": 4000,
       "price": 0,
+      "quoteMaxToken": 100000,
+      "maxTemperature": 1.2,
+      "censor": false,
+      "vision": true,
       "defaultSystemChatPrompt": ""
     }
   ],
-  "QAModels": [ // QA 拆分模型
+  "QAModels": [ // QA 生成模型
-    { 
+    {
       "model": "gpt-3.5-turbo-16k",
       "name": "GPT35-16k",
-      "maxToken": 16000,
+      "maxContext": 16000,
+      "maxResponse": 16000,
       "price": 0
     }
   ],
+  "CQModels": [ // 问题分类模型
+    {
+      "model": "gpt-3.5-turbo-1106",
+      "name": "GPT35-1106",
+      "maxContext": 16000,
+      "maxResponse": 4000,
+      "price": 0,
+      "functionCall": true, // 是否支持function call， 不支持的模型需要设置为 false，会走提示词生成
+      "functionPrompt": ""
+    },
+    {
+      "model": "gpt-4",
+      "name": "GPT4-8k",
+      "maxContext": 8000,
+      "maxResponse": 8000,
+      "price": 0,
+      "functionCall": true,
+      "functionPrompt": ""
+    }
+  ],
   "ExtractModels": [ // 内容提取模型
-    { 
-      "model": "gpt-3.5-turbo-16k",
-      "name": "GPT35-16k",
-      "maxToken": 16000, 
-      "price": 0,
-      "functionCall": true, // 是否支持 function call
-      "functionPrompt": "" // 自定义非 function call 提示词
-    }
-  ],
-  "CQModels": [ // Classify Question: 问题分类模型
     {
-      "model": "gpt-3.5-turbo-16k",
+      "model": "gpt-3.5-turbo-1106",
-      "name": "GPT35-16k",
+      "name": "GPT35-1106",
-      "maxToken": 16000,
+      "maxContext": 16000,
-      "price": 0,
+      "maxResponse": 4000,
-      "functionCall": true,
-      "functionPrompt": ""
-    },
-    {
-      "model": "gpt-4",
-      "name": "GPT4-8k",
-      "maxToken": 8000,
       "price": 0,
       "functionCall": true,
       "functionPrompt": ""
     }
   ],
-  "QGModels": [ // Question Generation: 生成下一步指引模型
+  "QGModels": [ // 生成下一步指引
-    { 
+    {
-      "model": "gpt-3.5-turbo",
+      "model": "gpt-3.5-turbo-1106",
-      "name": "GPT35-4k",
+      "name": "GPT35-1106",
-      "maxToken": 4000,
+      "maxContext": 1600,
+      "maxResponse": 4000,
       "price": 0
     }
   ],
-  "VectorModels": [
+  "VectorModels": [ // 向量模型
     {
       "model": "text-embedding-ada-002",
       "name": "Embedding-2",
-      "price": 0,
+      "price": 0.2,
-      "defaultToken": 500,
+      "defaultToken": 700,
       "maxToken": 3000
     }
-  ]
+  ],
+  "AudioSpeechModels": [
+    {
+      "model": "tts-1",
+      "name": "OpenAI TTS1",
+      "price": 0,
+      "baseUrl": "",
+      "key": "",
+      "voices": [
+        { "label": "Alloy", "value": "alloy", "bufferId": "openai-Alloy" },
+        { "label": "Echo", "value": "echo", "bufferId": "openai-Echo" },
+        { "label": "Fable", "value": "fable", "bufferId": "openai-Fable" },
+        { "label": "Onyx", "value": "onyx", "bufferId": "openai-Onyx" },
+        { "label": "Nova", "value": "nova", "bufferId": "openai-Nova" },
+        { "label": "Shimmer", "value": "shimmer", "bufferId": "openai-Shimmer" }
+      ]
+    }
+  ],
+  "WhisperModel": {
+    "model": "whisper-1",
+    "name": "Whisper1",
+    "price": 0
+  }
 }
 ```

docSite/content/docs/development/custom-models/_index.md

@@ -6,3 +6,4 @@ icon: 'model_training'
 draft: false
 images: []
 ---
+<!-- 900~950 -->

docSite/content/docs/development/custom-models/chatglm2-m3e.md

@@ -23,7 +23,7 @@ FastGPT 默认使用了 OpenAI 的 LLM 模型和向量模型，如果想要私
 也可以通过环境变量引入：sk-key。有关docker环境变量引入的方法请自寻教程，此处不再赘述。
 ```
 
-## 接入 [One API](/docs/installation/one-api/)
+## 接入 [One API](/docs/development/one-api/)
 
 为 chatglm2 和 m3e-large 各添加一个渠道，参数如下：
 
@@ -59,7 +59,7 @@ Authorization 为 sk-aaabbbcccdddeeefffggghhhiiijjjkkk。model 为刚刚在 One
 
 ## 接入 FastGPT
 
-修改 config.json 配置文件，在 VectorModels 中加入 chatglm2 和 M3E 模型：
+修改 config.json 配置文件，在 ChatModels 中加入 chatglm2, 在 VectorModels 中加入 M3E 模型：
 
 ```json
 "ChatModels": [

docSite/content/docs/development/custom-models/chatglm2.md

@@ -99,7 +99,7 @@ Authorization 为 sk-aaabbbcccdddeeefffggghhhiiijjjkkk。model 为刚刚在 One
 
 ## 接入 FastGPT
 
-修改 config.json 配置文件，在 VectorModels 中加入 chatglm2 模型：
+修改 config.json 配置文件，在 ChatModels 中加入 chatglm2 模型：
 
 ```json
 "ChatModels": [
@@ -107,10 +107,11 @@ Authorization 为 sk-aaabbbcccdddeeefffggghhhiiijjjkkk。model 为刚刚在 One
   {
     "model": "chatglm2",
     "name": "chatglm2",
-    "maxToken": 8000,
+    "maxContext": 4000,
-    "price": 0,
+    "maxResponse": 4000,
-    "quoteMaxToken": 4000,
+    "quoteMaxToken": 2000,
-    "maxTemperature": 1.2,
+    "maxTemperature": 1,
+    "vision": false, 
     "defaultSystemChatPrompt": ""
   }
 ]

docSite/content/docs/development/design/_index.md

@@ -1,8 +1,9 @@
 ---
-weight: 540
+weight: 960
 title: "设计方案"
 description: "FastGPT 部分设计方案"
 icon: public
 draft: false
 images: []
----
+---
+<!-- 960~1050 -->

docSite/content/docs/development/design/dataset.md

@@ -1,5 +1,5 @@
 ---
-weight: 541
+weight: 961
 title: "数据集"
 description: "FastGPT 数据集中文件与数据的设计方案"
 icon: dataset

docSite/content/docs/development/docker.md

@@ -4,7 +4,7 @@ description: '使用 Docker Compose 快速部署 FastGPT'
 icon: ''
 draft: false
 toc: true
-weight: 720
+weight: 707
 ---
 
 ## 准备条件
@@ -13,13 +13,13 @@ weight: 720
 
 ### 1. 准备好代理环境（国外服务器可忽略）
 
-确保可以访问 OpenAI，具体方案可以参考：[代理方案](/docs/installation/proxy/)。或直接在 Sealos 上 [部署 OneAPI](/docs/installation/one-api)，既解决代理问题也能实现多 Key 轮询、接入其他大模型。
+确保可以访问 OpenAI，具体方案可以参考：[代理方案](/docs/development/proxy/)。或直接在 Sealos 上 [部署 OneAPI](/docs/development/one-api)，既解决代理问题也能实现多 Key 轮询、接入其他大模型。
 
 ### 2. 多模型支持
 
 FastGPT 使用了 one-api 项目来管理模型池，其可以兼容 OpenAI 、Azure 、国内主流模型和本地模型等。
 
-可选择 [Sealos 快速部署 OneAPI](/docs/installation/one-api)，更多部署方法可参考该项目的 [README](https://github.com/songquanpeng/one-api)，也可以直接通过以下按钮一键部署：
+可选择 [Sealos 快速部署 OneAPI](/docs/development/one-api)，更多部署方法可参考该项目的 [README](https://github.com/songquanpeng/one-api)，也可以直接通过以下按钮一键部署：
 
 [![](https://fastly.jsdelivr.net/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Done-api)
 
@@ -86,7 +86,7 @@ curl -O https://raw.githubusercontent.com/labring/FastGPT/main/projects/app/data
 
 ## 三、启动容器
 
-修改`docker-compose.yml`中的`OPENAI_BASE_URL`和`CHAT_API_KEY`即可，对应为 API 的地址和 key。
+修改`docker-compose.yml`中的`OPENAI_BASE_URL`和`CHAT_API_KEY`即可，对应为 API 的地址(别忘记加/v1)和 key。
 
 ```bash
 # 在 docker-compose.yml 同级目录下执行

docSite/content/docs/development/intro.md

@@ -1,10 +1,10 @@
 ---
-title: '快速开始'
+title: '快速开始本地开发'
 description: '对 FastGPT 进行开发调试'
 icon: 'developer_guide'
 draft: false
 toc: true
-weight: 510
+weight: 705
 ---
 
 本文档介绍了如何设置开发环境以构建和测试 [FastGPT](https://fastgpt.run)。
@@ -46,7 +46,7 @@ git clone git@github.com:<github_username>/FastGPT.git
 
 ### 3. 安装数据库
 
-第一次开发，需要先部署数据库，建议本地开发可以随便找一台 2C2G 的轻量小数据库实践。数据库部署教程：[Docker 快速部署](/docs/installation/docker/)。部署完了，可以本地访问其数据库。
+第一次开发，需要先部署数据库，建议本地开发可以随便找一台 2C2G 的轻量小数据库实践。数据库部署教程：[Docker 快速部署](/docs/development/docker/)。部署完了，可以本地访问其数据库。
 
 ### 4. 初始配置
 
@@ -54,11 +54,11 @@ git clone git@github.com:<github_username>/FastGPT.git
 
 **环境变量**
 
-复制.env.template 文件，在同级目录下生成一个.env.local 文件，修改.env.local 里内容才是有效的变量。变量说明见 .env.template
+复制`.env.template`文件，在同级目录下生成一个`.env.local` 文件，修改`.env.local` 里内容才是有效的变量。变量说明见 .env.template
 
 **config 配置文件**
 
-复制 data/config.json 文件，生成一个 data/config.local.json 配置文件，具体配置参数说明，可参考 [config 配置说明](/docs/development/configuration)
+复制 `data/config.json` 文件，生成一个 `data/config.local.json` 配置文件，具体配置参数说明，可参考 [config 配置说明](/docs/development/configuration)
 
 **注意：json 配置文件不能包含注释，介绍中为了方便看才加入的注释**
 

docSite/content/docs/development/one-api.md

@@ -4,7 +4,7 @@ description: '通过接入 One API 来实现对各种大模型的支持'
 icon: 'Api'
 draft: false
 toc: true
-weight: 730
+weight: 708
 ---
 
 * 默认情况下，FastGPT 只配置了 GPT 的 3 个模型，如果你需要接入其他模型，需要进行一些额外配置。
@@ -46,7 +46,6 @@ SqlLite 版本不支持多实例，适合个人小流量使用，但是价格非
 
 ```
 SESSION_SECRET=SESSION_SECRET
-CHANNEL_TEST_FREQUENCY=30
 POLLING_INTERVAL=60
 BATCH_UPDATE_ENABLED=true
 BATCH_UPDATE_INTERVAL=60
@@ -72,7 +71,7 @@ BATCH_UPDATE_INTERVAL=60
 
 ### 3. 修改 FastGPT 的环境变量
 
-有了 One API 令牌后，FastGPT 可以通过修改 baseurl 和 key 去请求到 One API，再由 One API 去请求不同的模型。修改下面两个环境变量：
+有了 One API 令牌后，FastGPT 可以通过修改 `baseurl` 和 `key` 去请求到 One API，再由 One API 去请求不同的模型。修改下面两个环境变量：
 
 ```bash
 # 下面的地址是 Sealos 提供的，务必写上 v1， 两个项目都在 sealos 部署时候，https://xxxx.cloud.sealos.io 可以改用内网地址
@@ -99,11 +98,12 @@ CHAT_API_KEY=sk-xxxxxx
     {
       "model": "ERNIE-Bot", // 这里的模型需要对应 One API 的模型
       "name": "文心一言", // 对外展示的名称
-      "maxToken": 4000, // 最大长下文 token，无论什么模型都按 GPT35 的计算。GPT 外的模型需要自行大致计算下这个值。可以调用官方接口去比对 Token 的倍率，然后在这里粗略计算。
+      "maxContext": 8000, // 最大长下文 token，无论什么模型都按 GPT35 的计算。GPT 外的模型需要自行大致计算下这个值。可以调用官方接口去比对 Token 的倍率，然后在这里粗略计算。
+      "maxResponse": 4000, // 最大回复 token
       // 例如：文心一言的中英文 token 基本是 1:1，而 GPT 的中文 Token 是 2:1，如果文心一言官方最大 Token 是 4000，那么这里就可以填 8000，保险点就填 7000.
-      "price": 0, // 1个token 价格 => 1.5 / 100000 * 1000 = 0.015元/1k token
       "quoteMaxToken": 2000, // 引用知识库的最大 Token
       "maxTemperature": 1, // 最大温度
+      "vision": false, // 是否开启图片识别
       "defaultSystemChatPrompt": "" // 默认的系统提示词
     }
     ...

docSite/content/docs/development/openApi.md

@@ -1,546 +0,0 @@
----
-title: 'OpenAPI 使用（API Key 使用）'
-description: 'FastGPT OpenAPI 文档'
-icon: 'api'
-draft: false
-toc: true
-weight: 512
----
-
-# 基本配置
-```
-baseUrl: "https://fastgpt.run/api"
-headers: {
-    Authorization: "Bearer apikey"
-}
-```
-
-# 如何获取 API Key
-
-FastGPT 的 API Key 有 2 类，一类是全局通用的 key；一类是携带了 AppId 也就是有应用标记的 key。
-
-|        通用key               |           应用特定 key            |
-| --------------------- | --------------------- |
-| ![](/imgs/fastgpt-api2.png) | ![](/imgs/fastgpt-api.png) |
-
-# 接口
-
-## 发起对话
-
-{{% alert icon="🤖 " context="success" %}}
-该接口 API Key 需使用应用特定的 key，否则会报错。  
-
-有些包的 BaseUrl 需要添加 `v1` 路径，有些不需要，建议都试一下。 
-{{% /alert %}}
-
-
-对话接口兼容`GPT`的接口！如果你的项目使用的是标准的`GPT`官方接口，可以直接通过修改 `BaseUrl` 和 `Authorization` 来访问 FastGpt 应用。
-
-请求参数说明
-- headers.Authorization: Bearer apikey
-- chatId: string | undefined 。
-  -  为 undefined 时（不传入），不使用 FastGpt 提供的上下文功能，完全通过传入的 messages 构建上下文。 不会将你的记录存储到数据库中，你也无法在记录汇总中查阅到。
-  - 为非空字符串时，意味着使用 chatId 进行对话，自动从 FastGpt 数据库取历史记录，并使用 messages 数组最后一个内容作为用户问题。(请自行确保 chatId 唯一，长度不限制)
-- messages: 结构与 [GPT接口](https://platform.openai.com/docs/api-reference/chat/object) 完全一致。
-- detail: 是否返回详细值(模块状态，响应的完整结果），`stream模式`下会通过event进行区分，`非stream模式`结果保存在responseData中。
-- variables: 变量内容，一个对象，会替换`{{key}}`变量。在`HTTP`模块中会发给接口，可作为身份凭证等标识。
-
-**请求示例：**
-
-```bash
-curl --location --request POST 'https://fastgpt.run/api/v1/chat/completions' \
---header 'Authorization: Bearer apikey' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "chatId":"111",
-    "stream":false,
-    "detail": false,
-    "variables": {
-        "cTime": "2022/2/2 22:22"
-    },
-    "messages": [
-        {
-            "content": "导演是谁",
-            "role": "user"
-        }
-    ]
-}'
-```
-
-
-{{< tabs tabTotal="3" >}}
-{{< tab tabName="detail=false 响应" >}}
-{{< markdownify >}}
-
-```bash
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":""},"index":0,"finish_reason":null}]}
-
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"电"},"index":0,"finish_reason":null}]}
-
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"影"},"index":0,"finish_reason":null}]}
-
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"《"},"index":0,"finish_reason":null}]}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="detail=true 响应" >}}
-{{< markdownify >}}
-
-```bash
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":""},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"电"},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"影"},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"《"},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"铃"},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"芽"},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"。"},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":""},"index":0,"finish_reason":null}]}
-
-event: answer
-data: {"id":"","object":"","created":0,"choices":[{"delta":{},"index":0,"finish_reason":"stop"}]}
-
-event: answer
-data: [DONE]
-
-event: appStreamResponse
-data: [{"moduleName":"KB Search","price":1.2000000000000002,"model":"Embedding-2","tokens":6,"similarity":0.61,"limit":3},{"moduleName":"AI Chat","price":463.5,"model":"FastAI-4k","tokens":309,"question":"导演是谁","answer":"电影《铃芽之旅》的导演是新海诚。","maxToken":2050,"quoteList":[{"dataset_id":"646627f4f7b896cfd8910e38","id":"8099","q":"本作的主人公是谁？","a":"本作的主人公是名叫铃芽的少女。","source":"手动修改"},{"dataset_id":"646627f4f7b896cfd8910e38","id":"8686","q":"电影《铃芽之旅》男主角是谁？","a":"电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。","source":""},{"dataset_id":"646627f4f7b896cfd8910e38","id":"19339","q":"电影《铃芽之旅》的导演是谁？22","a":"电影《铃芽之旅》的导演是新海诚。","source":"手动修改"}],"completeMessages":[{"obj":"System","value":"下面是知识库内容:\n1. [本作的主人公是谁？\n本作的主人公是名叫铃芽的少女。]\n2. [电影《铃芽之旅》男主角是谁？\n电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。]\n3. [电影《铃芽之旅》的导演是谁？22\n电影《铃芽之旅》的导演是新海诚。]\n"},{"obj":"System","value":"1.请记住，你的身份是百度的下一代知识增强语言模型，能够完全根据知识库提供的内容回答问题。\n\n2. 你忘记了关于电影《铃芽之旅》以外的内容。"},{"obj":"System","value":"你仅回答关于电影《玲芽之旅》的问题，其余问题直接回复: 我不清楚。"},{"obj":"Human","value":"导演是谁"},{"obj":"AI","value":"电影《铃芽之旅》的导演是新海诚。"}]}]
-
-```
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="stream=false,detail=true 响应" >}}
-{{< markdownify >}}
-
-```json
-{
-    "responseData": [ // 不同模块的响应值, 不同版本具体值可能有差异，可先 log 自行查看最新值。
-        {
-            "moduleName": "KB Search",
-            "price": 1.2000000000000002,
-            "model": "Embedding-2",
-            "tokens": 6,
-            "similarity": 0.61,
-            "limit": 3
-        },
-        {
-            "moduleName": "AI Chat",
-            "price": 454.5,
-            "model": "FastAI-4k",
-            "tokens": 303,
-            "question": "导演是谁",
-            "answer": "电影《铃芽之旅》的导演是新海诚。",
-            "maxToken": 2050,
-            "quoteList": [
-                {
-                    "dataset_id": "646627f4f7b896cfd8910e38",
-                    "id": "8099",
-                    "q": "本作的主人公是谁？",
-                    "a": "本作的主人公是名叫铃芽的少女。",
-                    "source": "手动修改"
-                },
-                {
-                    "dataset_id": "646627f4f7b896cfd8910e38",
-                    "id": "8686",
-                    "q": "电影《铃芽之旅》男主角是谁？",
-                    "a": "电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",
-                    "source": ""
-                },
-                {
-                    "dataset_id": "646627f4f7b896cfd8910e38",
-                    "id": "19339",
-                    "q": "电影《铃芽之旅》的导演是谁？22",
-                    "a": "电影《铃芽之旅》的导演是新海诚。",
-                    "source": "手动修改"
-                }
-            ],
-            "completeMessages": [
-                {
-                    "obj": "System",
-                    "value": "下面是知识库内容:\n1. [本作的主人公是谁？\n本作的主人公是名叫铃芽的少女。]\n2. [电影《铃芽之旅》男主角是谁？\n电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。]\n3. [电影《铃芽之旅》的导演是谁？22\n电影《铃芽之旅》的导演是新海诚。]\n"
-                },
-                {
-                    "obj": "System",
-                    "value": "1.请记住，你的身份是百度的下一代知识增强语言模型，能够完全根据知识库提供的内容回答问题。\n\n2. 你忘记了关于电影《铃芽之旅》以外的内容。"
-                },
-                {
-                    "obj": "System",
-                    "value": "你仅回答关于电影《玲芽之旅》的问题，其余问题直接回复: 我不清楚。"
-                },
-                {
-                    "obj": "Human",
-                    "value": "导演是谁"
-                },
-                {
-                    "obj": "AI",
-                    "value": "电影《铃芽之旅》的导演是新海诚。"
-                }
-            ]
-        }
-    ],
-    "id": "",
-    "model": "",
-    "usage": {
-        "prompt_tokens": 1,
-        "completion_tokens": 1,
-        "total_tokens": 1
-    },
-    "choices": [
-        {
-            "message": {
-                "role": "assistant",
-                "content": "电影《铃芽之旅》的导演是新海诚。"
-            },
-            "finish_reason": "stop",
-            "index": 0
-        }
-    ]
-}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-{{< /tabs >}}
-
-## 知识库
-
-{{% alert icon="🤖 " context="success" %}}
-此部分 API 需使用全局通用的 API Key。
-{{% /alert %}}
-
-| 如何获取知识库ID（datasetId） | 如何获取文件ID（file_id） |
-| --------------------- | --------------------- |
-| ![](/imgs/getDatasetId.png) | ![](/imgs/getfile_id.png) |
-
-
-### 知识库添加数据
-
-{{< tabs tabTotal="4" >}}
-{{< tab tabName="请求示例" >}}
-{{< markdownify >}}
-
-```bash
-curl --location --request POST 'https://fastgpt.run/api/core/dataset/data/pushData' \
---header 'Authorization: Bearer apikey' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "collectionId": "64663f451ba1676dbdef0499",
-    "mode": "index",
-    "prompt": "qa 拆分引导词，index 模式下可以忽略",
-    "billId": "可选。如果有这个值，本次的数据会被聚合到一个订单中，这个值可以重复使用。可以参考 [创建训练订单] 获取该值。",
-    "data": [
-        {
-            "a": "test",
-            "q": "1111",
-            "file_id": "关联的文件ID/URL/manual/mark",
-            "source": "来源名称"，
-        },
-        {
-            "a": "test2",
-            "q": "22222"
-        }
-    ]
-}'
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="参数说明" >}}
-{{< markdownify >}}
-
-```json
-{
-    "collectionId": "文件的ID，参考上面的第二张图",
-    "mode": "index | qa ", //  index 模式: 直接将 q 转成向量存起来，a 直接入库。qa 模式: 只关注 data 里的 q，将 q 丢给大模型，让其根据 prompt 拆分成 qa 问答对。  
-    "prompt": "拆分提示词，需严格按照模板，建议不要传入。",
-    "data": [
-        {
-            "q": "生成索引的内容，index 模式下最大 tokens 为3000，建议不超过 1000",
-            "a": "预期回答/补充",
-            "file_id": "如果推送数据到手动录入，这里可以留空; 如果希望关联到某个文件中，需要填写对应文件的ID; 如果希望加入到手动标注中，可设置为: mark",
-        },
-        {
-            "q": "生成索引的内容，qa 模式下最大 tokens 为10000，建议 8000 左右",
-            "a": "预期回答/补充"
-        }
-    ]
-}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="响应例子" >}}
-{{< markdownify >}}
-
-```json
-{
-    "code": 200,
-    "statusText": "",
-    "data": {
-        "insertLen": 1, // 最终插入成功的数量
-        "overToken": [], // 超出 token 的
-        "fileIdInvalid": [  // file_id 无效的
-            {
-                "a": "飞飞dsaf飞",
-                "q": "测试是32否收到",
-                "file_id": "32dwe"
-            }
-        ],
-        "error": [] // 其他错误
-    }
-}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="QA Prompt 模板" >}}
-{{< markdownify >}}
-
-{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容
-
-```
-我会给你一段文本，{{theme}}，学习它们，并整理学习成果，要求为：
-1. 提出最多 25 个问题。
-2. 给出每个问题的答案。
-3. 答案要详细完整，答案可以包含普通文字、链接、代码、表格、公示、媒体链接等 markdown 元素。
-4. 按格式返回多个问题和答案:
-
-Q1: 问题。
-A1: 答案。
-Q2:
-A2:
-……
-
-我的文本："""{{text}}"""
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< /tabs >}}
-
-
-### 搜索测试
-
-{{< tabs tabTotal="2" >}}
-{{< tab tabName="请求示例" >}}
-{{< markdownify >}}
-
-```bash
-curl --location --request POST 'https://fastgpt.run/api/core/dataset/searchTest' \
---header 'Authorization: Bearer apiKey' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "datasetId": "知识库的ID",
-    "text": "导演是谁"
-}'
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="响应示例" >}}
-{{< markdownify >}}
-
-返回 top12 结果
-
-```bash
-{
-  "code": 200,
-  "statusText": "",
-  "data": [
-    {
-      "id": "5613327",
-      "q": "该人有获奖情况吗？",
-      "a": "该人获得过2020/07全国大学生服务外包大赛国家一等奖和2021/05国家创新创业计划立项的获奖情况。",
-      "source": "余金隆简历.pdf",
-      "score": 0.41556452839298963
-    },
-    ......
-  ]
-}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< /tabs >}}
-
-## 订单
-
-### 创建训练订单
-
-**请求示例**
-
-```bash
-curl --location --request POST 'https://fastgpt.run/api/common/bill/createTrainingBill' \
---header 'Authorization: Bearer {{apikey}}' \
---header 'Content-Type: application/json' \
---data-raw ''
-```
-
-**响应结果**
-
-data 为 billId，可用于 api 添加数据时进行账单聚合。
-
-```json
-{
-  "code": 200,
-  "statusText": "",
-  "message": "",
-  "data": "65112ab717c32018f4156361"
-}
-```
-
-## 免登录分享链接校验（内测中）
-
-免登录链接配置中，增加了`凭证校验服务器`后，使用分享链接时会向服务器发起请求，校验链接是否可用，并在每次对话结束后，向服务器发送对话结果。下面以`host`来表示`凭证校验服务器`。服务器接口仅需返回是否校验成功即可，不需要返回其他数据，格式如下：
-
-```json
-{
-    "success": true,
-    "message": "错误提示"
-}
-```
-
-![](/imgs/sharelinkProcess.png)
-
-### 分享链接中增加额外 query
-
-增加一个 query: authToken。例如：
-
-原始的链接：https://fastgpt.run/chat/share?shareId=648aaf5ae121349a16d62192  
-完整链接: https://fastgpt.run/chat/share?shareId=648aaf5ae121349a16d62192&authToken=userid12345
-
-发出校验请求时候，会在`body`中携带 token={{authToken}} 的参数。
-
-### 初始化校验
-
-**FastGPT 发出的请求**
-
-```bash
-curl --location --request POST '{{host}}/shareAuth/init' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "token": "sintdolore"
-}'
-```
-
-### 对话前校验
-
-**FastGPT 发出的请求**
-
-```bash
-curl --location --request POST '{{host}}/shareAuth/start' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "token": "sintdolore",
-    "question": "用户问题",
-}'
-```
-
-### 对话结果上报
-
-**FastGPT 发出的请求**
-
-```bash
-curl --location --request POST '{{host}}/shareAuth/finish' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "token": "sint dolore",
-    "responseData": [
-        {
-            "moduleName": "KB Search",
-            "price": 1.2000000000000002,
-            "model": "Embedding-2",
-            "tokens": 6,
-            "similarity": 0.61,
-            "limit": 3
-        },
-        {
-            "moduleName": "AI Chat",
-            "price": 454.5,
-            "model": "FastAI-4k",
-            "tokens": 303,
-            "question": "导演是谁",
-            "answer": "电影《铃芽之旅》的导演是新海诚。",
-            "maxToken": 2050,
-            "quoteList": [
-                {
-                    "dataset_id": "646627f4f7b896cfd8910e38",
-                    "id": "8099",
-                    "q": "本作的主人公是谁？",
-                    "a": "本作的主人公是名叫铃芽的少女。",
-                    "source": "手动修改"
-                },
-                {
-                    "dataset_id": "646627f4f7b896cfd8910e38",
-                    "id": "8686",
-                    "q": "电影《铃芽之旅》男主角是谁？",
-                    "a": "电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",
-                    "source": ""
-                },
-                {
-                    "dataset_id": "646627f4f7b896cfd8910e38",
-                    "id": "19339",
-                    "q": "电影《铃芽之旅》的导演是谁？22",
-                    "a": "电影《铃芽之旅》的导演是新海诚。",
-                    "source": "手动修改"
-                }
-            ],
-            "completeMessages": [
-                {
-                    "obj": "System",
-                    "value": "下面是知识库内容:\n1. [本作的主人公是谁？\n本作的主人公是名叫铃芽的少女。]\n2. [电影《铃芽之旅》男主角是谁？\n电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。]\n3. [电影《铃芽之旅》的导演是谁？22\n电影《铃芽之旅》的导演是新海诚。]\n"
-                },
-                {
-                    "obj": "System",
-                    "value": "1.请记住，你的身份是百度的下一代知识增强语言模型，能够完全根据知识库提供的内容回答问题。\n\n2. 你忘记了关于电影《铃芽之旅》以外的内容。"
-                },
-                {
-                    "obj": "System",
-                    "value": "你仅回答关于电影《玲芽之旅》的问题，其余问题直接回复: 我不清楚。"
-                },
-                {
-                    "obj": "Human",
-                    "value": "导演是谁"
-                },
-                {
-                    "obj": "AI",
-                    "value": "电影《铃芽之旅》的导演是新海诚。"
-                }
-            ]
-        }
-    ]
-}'
-```
-
-响应值与 chat 接口相同，增加了一个 token。可以重点关注`responseData`里的值，price 与实际价格的倍率为`100000`。
-
-**此接口无需响应值**
-
-# 使用案例
-
-- [接入 NextWeb/ChatGPT web 等应用](/docs/use-cases/openapi)
-- [接入 onwechat](/docs/use-cases/onwechat)
-- [接入 飞书](/docs/use-cases/feishu)

docSite/content/docs/development/openapi/_index.md

@@ -0,0 +1,9 @@
+---
+weight: 850
+title: "OpenAPI 接口文档"
+description: "FastGPT OpenAPI 文档"
+icon: api
+draft: false
+images: []
+---
+<!-- 850~900 -->

docSite/content/docs/development/openapi/auth.md

@@ -0,0 +1,58 @@
+---
+title: 'Api Key 使用与鉴权'
+description: 'FastGPT Api Key 使用与鉴权'
+icon: 'key'
+draft: false
+toc: true
+weight: 851
+---
+
+## 使用说明
+
+FasGPT OpenAPI 接口允许你使用 Api Key 进行鉴权，从而操作 FastGPT 上的相关服务和资源，例如：调用应用对话接口、上传知识库数据、搜索测试等等。出于兼容性和安全考虑，并不是所有的接口都允许通过 Api Key 访问。
+
+## 如何查看 BaseURL
+
+**注意：BaseURL 不是接口地址，而是所有接口的根地址，直接请求 BaseURL 是没有用的。**
+
+![](/imgs/fastgpt-api-baseurl.png)
+
+## 如何获取 Api Key
+
+FastGPT 的 API Key **有 2 类**，一类是全局通用的 key (无法直接调用应用对话)；一类是携带了 AppId 也就是有应用标记的 key (可直接调用应用对话)。
+
+我们建议，仅操作应用或者对话的相关接口使用 `应用特定key`，其他接口使用 `通用key`。
+
+|        通用key               |           应用特定 key            |
+| --------------------- | --------------------- |
+| ![](/imgs/fastgpt-api2.png) | ![](/imgs/fastgpt-api.png) |
+
+## 基本配置
+
+OpenAPI 中，所有的接口都通过 Header.Authorization 进行鉴权。
+
+```
+baseUrl: "https://fastgpt.run/api"
+headers: {
+    Authorization: "Bearer {{apikey}}"
+}
+```
+
+**发起应用对话示例**
+
+```sh
+curl --location --request POST 'https://fastgpt.run/api/v1/chat/completions' \
+--header 'Authorization: Bearer fastgpt-xxxxxx' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "chatId": "111",
+    "stream": false,
+    "detail": false,
+    "messages": [
+        {
+            "content": "导演是谁",
+            "role": "user"
+        }
+    ]
+}'
+```

docSite/content/docs/development/openapi/chat.md

@@ -0,0 +1,254 @@
+---
+title: '对话接口'
+description: 'FastGPT OpenAPI 对话接口'
+icon: 'chat'
+draft: false
+toc: true
+weight: 852
+---
+
+## 发起对话
+
+{{% alert icon="🤖 " context="success" %}}
+该接口的 API Key 需使用`应用特定的 key`，否则会报错。  
+
+有些包调用时，`BaseUrl`需要添加`v1`路径，有些不需要，如果出现404情况，可补充`v1`重试。
+{{% /alert %}}
+
+
+**对话接口兼容`GPT`的接口！如果你的项目使用的是标准的`GPT`官方接口，可以直接通过修改`BaseUrl`和 `Authorization`来访问 FastGpt 应用。**
+
+## 请求
+
+{{< tabs tabTotal="2" >}}
+{{< tab tabName="请求示例" >}}
+{{< markdownify >}}
+
+```bash
+curl --location --request POST 'https://fastgpt.run/api/v1/chat/completions' \
+--header 'Authorization: Bearer fastgpt-xxxxxx' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "chatId": "abcd",
+    "stream": false,
+    "detail": false,
+    "variables": {
+        "uid": "asdfadsfasfd2323",
+        "name": "张三"
+    },
+    "messages": [
+        {
+            "content": "导演是谁",
+            "role": "user"
+        }
+    ]
+}'
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="detail=true 响应" >}}
+{{< markdownify >}}
+
+{{% alert context="info" %}}
+- headers.Authorization: Bearer {{apikey}}
+- chatId: string | undefined 。
+  - 为 `undefined` 时（不传入），不使用 FastGpt 提供的上下文功能，完全通过传入的 messages 构建上下文。 不会将你的记录存储到数据库中，你也无法在记录汇总中查阅到。
+  - 为`非空字符串`时，意味着使用 chatId 进行对话，自动从 FastGpt 数据库取历史记录，并使用 messages 数组最后一个内容作为用户问题。请自行确保 chatId 唯一，长度小于250，通常可以是自己系统的对话框ID。
+- messages: 结构与 [GPT接口](https://platform.openai.com/docs/api-reference/chat/object) 完全一致。
+- detail: 是否返回中间值（模块状态，响应的完整结果等），`stream模式`下会通过`event`进行区分，`非stream模式`结果保存在`responseData`中。
+- variables: 模块变量，一个对象，会替换模块中，输入框内容里的`{{key}}`
+{{% /alert %}}
+
+
+
+{{< /markdownify >}}
+{{< /tab >}}
+{{< /tabs >}}
+
+## 响应
+
+{{< tabs tabTotal="4" >}}
+{{< tab tabName="detail=false,stream=false 响应" >}}
+{{< markdownify >}}
+
+```json
+{
+    "id": "adsfasf",
+    "model": "",
+    "usage": {
+        "prompt_tokens": 1,
+        "completion_tokens": 1,
+        "total_tokens": 1
+    },
+    "choices": [
+        {
+            "message": {
+                "role": "assistant",
+                "content": "电影《铃芽之旅》的导演是新海诚。"
+            },
+            "finish_reason": "stop",
+            "index": 0
+        }
+    ]
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="detail=false,stream=true 响应" >}}
+{{< markdownify >}}
+
+
+```bash
+data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":""},"index":0,"finish_reason":null}]}
+
+data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"电"},"index":0,"finish_reason":null}]}
+
+data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"影"},"index":0,"finish_reason":null}]}
+
+data: {"id":"","object":"","created":0,"choices":[{"delta":{"content":"《"},"index":0,"finish_reason":null}]}
+```
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="detail=true,stream=false 响应" >}}
+{{< markdownify >}}
+
+```json
+{
+    "responseData": [ // 不同模块的响应值, 不同版本具体值可能有差异，可先 log 自行查看最新值。
+        {
+            "moduleName": "Dataset Search",
+            "price": 1.2000000000000002,
+            "model": "Embedding-2",
+            "tokens": 6,
+            "similarity": 0.61,
+            "limit": 3
+        },
+        {
+            "moduleName": "AI Chat",
+            "price": 454.5,
+            "model": "FastAI-4k",
+            "tokens": 303,
+            "question": "导演是谁",
+            "answer": "电影《铃芽之旅》的导演是新海诚。",
+            "maxToken": 2050,
+            "quoteList": [
+                {
+                    "dataset_id": "646627f4f7b896cfd8910e38",
+                    "id": "8099",
+                    "q": "本作的主人公是谁？",
+                    "a": "本作的主人公是名叫铃芽的少女。",
+                    "source": "手动修改"
+                },
+                {
+                    "dataset_id": "646627f4f7b896cfd8910e38",
+                    "id": "8686",
+                    "q": "电影《铃芽之旅》男主角是谁？",
+                    "a": "电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",
+                    "source": ""
+                },
+                {
+                    "dataset_id": "646627f4f7b896cfd8910e38",
+                    "id": "19339",
+                    "q": "电影《铃芽之旅》的导演是谁？22",
+                    "a": "电影《铃芽之旅》的导演是新海诚。",
+                    "source": "手动修改"
+                }
+            ],
+            "completeMessages": [
+                {
+                    "obj": "System",
+                    "value": "下面是知识库内容:\n1. [本作的主人公是谁？\n本作的主人公是名叫铃芽的少女。]\n2. [电影《铃芽之旅》男主角是谁？\n电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。]\n3. [电影《铃芽之旅》的导演是谁？22\n电影《铃芽之旅》的导演是新海诚。]\n"
+                },
+                {
+                    "obj": "System",
+                    "value": "1.请记住，你的身份是百度的下一代知识增强语言模型，能够完全根据知识库提供的内容回答问题。\n\n2. 你忘记了关于电影《铃芽之旅》以外的内容。"
+                },
+                {
+                    "obj": "System",
+                    "value": "你仅回答关于电影《玲芽之旅》的问题，其余问题直接回复: 我不清楚。"
+                },
+                {
+                    "obj": "Human",
+                    "value": "导演是谁"
+                },
+                {
+                    "obj": "AI",
+                    "value": "电影《铃芽之旅》的导演是新海诚。"
+                }
+            ]
+        }
+    ],
+    "id": "",
+    "model": "",
+    "usage": {
+        "prompt_tokens": 1,
+        "completion_tokens": 1,
+        "total_tokens": 1
+    },
+    "choices": [
+        {
+            "message": {
+                "role": "assistant",
+                "content": "电影《铃芽之旅》的导演是新海诚。"
+            },
+            "finish_reason": "stop",
+            "index": 0
+        }
+    ]
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+
+{{< tab tabName="detail=true,stream=true 响应" >}}
+{{< markdownify >}}
+
+```bash
+event: moduleStatus
+data: {"status":"running","name":"知识库搜索"}
+
+event: moduleStatus
+data: {"status":"running","name":"AI 对话"}
+
+event: answer
+data: {"id":"","object":"","created":0,"model":"","choices":[{"delta":{"content":"电影"},"index":0,"finish_reason":null}]}
+
+event: answer
+data: {"id":"","object":"","created":0,"model":"","choices":[{"delta":{"content":"《铃"},"index":0,"finish_reason":null}]}
+
+event: answer
+data: {"id":"","object":"","created":0,"model":"","choices":[{"delta":{"content":"芽之旅》"},"index":0,"finish_reason":null}]}
+
+event: answer
+data: {"id":"","object":"","created":0,"model":"","choices":[{"delta":{"content":"的导演是新"},"index":0,"finish_reason":null}]}
+
+event: answer
+data: {"id":"","object":"","created":0,"model":"","choices":[{"delta":{"content":"海诚。"},"index":0,"finish_reason":null}]}
+
+event: answer
+data: {"id":"","object":"","created":0,"model":"","choices":[{"delta":{},"index":0,"finish_reason":"stop"}]}
+
+event: answer
+data: [DONE]
+
+event: appStreamResponse
+data: [{"moduleName":"知识库搜索","moduleType":"datasetSearchNode","runningTime":1.78},{"question":"导演是谁","quoteList":[{"id":"654f2e49b64caef1d9431e8b","q":"电影《铃芽之旅》的导演是谁？","a":"电影《铃芽之旅》的导演是新海诚!","indexes":[{"type":"qa","dataId":"3515487","text":"电影《铃芽之旅》的导演是谁？","_id":"654f2e49b64caef1d9431e8c","defaultIndex":true}],"datasetId":"646627f4f7b896cfd8910e38","collectionId":"653279b16cd42ab509e766e8","sourceName":"data (81).csv","sourceId":"64fd3b6423aa1307b65896f6","score":0.8935586214065552},{"id":"6552e14c50f4a2a8e632af11","q":"导演是谁？","a":"电影《铃芽之旅》的导演是新海诚。","indexes":[{"defaultIndex":true,"type":"qa","dataId":"3644565","text":"导演是谁？\n电影《铃芽之旅》的导演是新海诚。","_id":"6552e14dde5cc7ba3954e417"}],"datasetId":"646627f4f7b896cfd8910e38","collectionId":"653279b16cd42ab509e766e8","sourceName":"data (81).csv","sourceId":"64fd3b6423aa1307b65896f6","score":0.8890955448150635},{"id":"654f34a0b64caef1d946337e","q":"本作的主人公是谁？","a":"本作的主人公是名叫铃芽的少女。","indexes":[{"type":"qa","dataId":"3515541","text":"本作的主人公是谁？","_id":"654f34a0b64caef1d946337f","defaultIndex":true}],"datasetId":"646627f4f7b896cfd8910e38","collectionId":"653279b16cd42ab509e766e8","sourceName":"data (81).csv","sourceId":"64fd3b6423aa1307b65896f6","score":0.8738770484924316},{"id":"654f3002b64caef1d944207a","q":"电影《铃芽之旅》男主角是谁？","a":"电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。","indexes":[{"type":"qa","dataId":"3515538","text":"电影《铃芽之旅》男主角是谁？","_id":"654f3002b64caef1d944207b","defaultIndex":true}],"datasetId":"646627f4f7b896cfd8910e38","collectionId":"653279b16cd42ab509e766e8","sourceName":"data (81).csv","sourceId":"64fd3b6423aa1307b65896f6","score":0.8607980012893677},{"id":"654f2fc8b64caef1d943fd46","q":"电影《铃芽之旅》的编剧是谁？","a":"新海诚是本片的编剧。","indexes":[{"defaultIndex":true,"type":"qa","dataId":"3515550","text":"电影《铃芽之旅》的编剧是谁？22","_id":"654f2fc8b64caef1d943fd47"}],"datasetId":"646627f4f7b896cfd8910e38","collectionId":"653279b16cd42ab509e766e8","sourceName":"data (81).csv","sourceId":"64fd3b6423aa1307b65896f6","score":0.8468944430351257}],"moduleName":"AI 对话","moduleType":"chatNode","runningTime":1.86}]
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+{{< /tabs >}}
+
+
+## 使用案例
+
+- [接入 NextWeb/ChatGPT web 等应用](/docs/use-cases/openapi)
+- [接入 onwechat](/docs/use-cases/onwechat)
+- [接入 飞书](/docs/use-cases/feishu)

docSite/content/docs/development/openapi/dataset.md

@@ -0,0 +1,216 @@
+---
+title: '知识库接口'
+description: 'FastGPT OpenAPI 知识库接口'
+icon: 'dataset'
+draft: false
+toc: true
+weight: 853
+---
+
+| 如何获取知识库ID（datasetId） | 如何获取文件集合ID（collection_id） |
+| --------------------- | --------------------- |
+| ![](/imgs/getDatasetId.png) | ![](/imgs/getfile_id.png) |
+
+
+
+## 创建训练订单
+
+**请求示例**
+
+```bash
+curl --location --request POST 'https://fastgpt.run/api/support/wallet/bill/createTrainingBill' \
+--header 'Authorization: Bearer {{apikey}}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "name": "可选，自定义订单名称，例如：文档训练-fastgpt.docx"
+}'
+```
+
+**响应结果**
+
+data 为 billId，可用于添加知识库数据时进行账单聚合。
+
+```json
+{
+  "code": 200,
+  "statusText": "",
+  "message": "",
+  "data": "65112ab717c32018f4156361"
+}
+```
+
+## 知识库添加数据
+
+{{< tabs tabTotal="4" >}}
+{{< tab tabName="请求示例" >}}
+{{< markdownify >}}
+
+```bash
+curl --location --request POST 'https://fastgpt.run/api/core/dataset/data/pushData' \
+--header 'Authorization: Bearer apikey' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "collectionId": "64663f451ba1676dbdef0499",
+    "mode": "chunk",
+    "prompt": "可选。qa 拆分引导词，chunk 模式下忽略",
+    "billId": "可选。如果有这个值，本次的数据会被聚合到一个订单中，这个值可以重复使用。可以参考 [创建训练订单] 获取该值。",
+    "data": [
+        {
+            "q": "你是谁？",
+            "a": "我是FastGPT助手"
+        },
+        {
+            "q": "你会什么？",
+            "a": "我什么都会",
+            "indexes": [{
+                "type":"custom",
+                "text":"你好"
+            }]
+        }
+    ]
+}'
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="参数说明" >}}
+{{< markdownify >}}
+
+需要先了解 FastGPT 的多路索引概念：
+
+在 FastGPT 中，你可以为一组数据创建多个索引，如果不指定索引，则系统会自动取对应的 chunk 作为索引。例如前面的请求示例中：
+
+`q：你是谁？a:我是FastGPT助手` 它的`indexes`属性为空，意味着不自定义索引，而是使用默认的索引（你是谁？\n我是FastGPT助手）。
+
+在第二组数据中`q:你会什么？a:我什么都会`指定了一个`你好`的索引，因此这组数据的索引为`你好`。
+
+```json
+{
+    "collectionId": "文件集合的ID，参考上面的第二张图",
+    "mode": "chunk | qa ", //  chunk 模式: 可自定义索引。qa 模型：无法自定义索引，会自动取 data 中的 q 作为数据，让模型自动生成问答对和索引。
+    "prompt": "QA 拆分提示词，需严格按照模板，建议不要传入。",
+    "data": [
+        {
+            "q": "生成索引的内容，index 模式下最大 tokens 为3000，建议不超过 1000",
+            "a": "预期回答/补充",
+            "indexes": "自定义索引",
+        },
+        {
+            "q": "xxx",
+            "a": "xxxx"
+        }
+    ],
+    
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="响应例子" >}}
+{{< markdownify >}}
+
+```json
+{
+    "code": 200,
+    "statusText": "",
+    "data": {
+        "insertLen": 1, // 最终插入成功的数量
+        "overToken": [], // 超出 token 的
+       
+        "repeat": [], // 重复的数量
+        "error": [] // 其他错误
+    }
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="QA Prompt 模板" >}}
+{{< markdownify >}}
+
+{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容
+
+```
+我会给你一段文本，{{theme}}，学习它们，并整理学习成果，要求为：
+1. 提出最多 25 个问题。
+2. 给出每个问题的答案。
+3. 答案要详细完整，答案可以包含普通文字、链接、代码、表格、公示、媒体链接等 markdown 元素。
+4. 按格式返回多个问题和答案:
+
+Q1: 问题。
+A1: 答案。
+Q2:
+A2:
+……
+
+我的文本："""{{text}}"""
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< /tabs >}}
+
+
+## 搜索测试
+
+{{< tabs tabTotal="2" >}}
+{{< tab tabName="请求示例" >}}
+{{< markdownify >}}
+
+```bash
+curl --location --request POST 'https://fastgpt.run/api/core/dataset/searchTest' \
+--header 'Authorization: Bearer fastgpt-xxxxx' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "datasetId": "知识库的ID",
+    "text": "导演是谁",
+    "rarank": true,
+    "limit": 20
+}'
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="响应示例" >}}
+{{< markdownify >}}
+
+返回 top limit 结果
+
+```bash
+{
+  "code": 200,
+  "statusText": "",
+  "data": [
+    {
+        "id": "65599c54a5c814fb803363cb",
+        "q": "你是谁",
+        "a": "我是FastGPT助手",
+        "indexes": [
+            {
+                "defaultIndex": true,
+                "type": "qa",
+                "dataId": "3645952",
+                "text": "你是谁\n我是FastGPT助手",
+                "_id": "65599c5588271af95b019862"
+            }
+        ],
+        "datasetId": "6554684f7f9ed18a39a4d15c",
+        "collectionId": "6556cd795e4b663e770bb66d",
+        "sourceName": "GBT 15104-2021 装饰单板贴面人造板.pdf",
+        "sourceId": "6556cd775e4b663e770bb65c",
+        "score": 0.8050316572189331
+    },
+    ......
+  ]
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< /tabs >}}

docSite/content/docs/development/openapi/share.md

@@ -0,0 +1,353 @@
+---
+title: '分享链接身份鉴权'
+description: 'FastGPT 分享链接身份鉴权'
+icon: 'share'
+draft: false
+toc: true
+weight: 860
+---
+
+## 介绍
+
+在 FastGPT V4.6.4 中，我们修改了分享链接的数据读取方式，为每个用户生成一个 localId，用于标识用户，从云端拉取对话记录。但是这种方式仅能保障用户在同一设备同一浏览器中使用，如果切换设备或者清空浏览器缓存则会丢失这些记录。这种方式存在一定的风险，因此我们仅允许用户拉取近`30天`的`20条`记录。
+
+分享链接身份鉴权设计的目的在于，将 FastGPT 的对话框快速、安全的接入到你现有的系统中，仅需 2 个接口即可实现。
+
+## 使用说明
+
+免登录链接配置中，你可以选择填写`身份验证`栏。这是一个`POST`请求的根地址。在填写该地址后，分享链接的初始化、开始对话以及对话结束都会向该地址的特定接口发送一条请求。下面以`host`来表示`凭身份验证根地址`。服务器接口仅需返回是否校验成功即可，不需要返回其他数据，格式如下：
+
+### 接口统一响应格式
+
+```json
+{
+    "success": true,
+    "message": "错误提示",
+    "msg": "同message, 错误提示",
+    "uid": "用户唯一凭证"
+}
+```
+
+`FastGPT` 将会判断`success`是否为`true`决定是允许用户继续操作。`message`与`msg`是等同的，你可以选择返回其中一个，当`success`不为`true`时，将会提示这个错误。
+
+`uid`是用户的唯一凭证，将会用于拉取对话记录以及保存对话记录。可参考下方实践案例。
+
+### 触发流程
+
+![](/imgs/sharelinkProcess.png)
+
+## 配置教程
+### 1. 配置身份校验地址
+
+![](/imgs/share-setlink.jpg)
+
+配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。
+
+{{% alert icon="🤖" %}}
+这里仅需配置根地址，无需具体到完整请求路径。
+{{% /alert %}}
+
+### 2. 分享链接中增加额外 query
+
+在分享链接的地址中，增加一个额外的参数: authToken。例如：
+
+原始的链接：`https://fastgpt.run/chat/share?shareId=648aaf5ae121349a16d62192`  
+
+完整链接: `https://fastgpt.run/chat/share?shareId=648aaf5ae121349a16d62192&authToken=userid12345`
+
+这个`authToken`通常是你系统生成的用户唯一凭证（Token之类的）。FastGPT 会在鉴权接口的`body`中携带 token={{authToken}} 的参数。
+
+### 3. 编写聊天初始化校验接口
+
+{{< tabs tabTotal="3" >}}
+{{< tab tabName="请求示例" >}}
+{{< markdownify >}}
+
+```bash
+curl --location --request POST '{{host}}/shareAuth/init' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "token": "{{authToken}}"
+}'
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="鉴权成功" >}}
+{{< markdownify >}}
+
+```json
+{
+    "success": true,
+    "uid": "username123",
+}
+```
+
+系统会拉取该分享链接下，uid 为 username123 的对话记录。
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="鉴权失败" >}}
+{{< markdownify >}}
+
+```json
+{
+    "success": false,
+    "message": "身份错误",
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+{{< /tabs >}}
+
+
+
+### 4. 编写对话前校验接口
+
+{{< tabs tabTotal="3" >}}
+{{< tab tabName="请求示例" >}}
+{{< markdownify >}}
+
+```bash
+curl --location --request POST '{{host}}/shareAuth/start' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "token": "{{authToken}}",
+    "question": "用户问题",
+}'
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="鉴权成功" >}}
+{{< markdownify >}}
+
+```json
+{
+    "success": true,
+    "uid": "username123",
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="鉴权失败" >}}
+{{< markdownify >}}
+
+```json
+{
+    "success": false,
+    "message": "身份验证失败",
+}
+```
+
+```json
+{
+    "success": false,
+    "message": "存在违规词",
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+{{< /tabs >}}
+
+### 5. 编写对话结果上报接口（可选）
+
+该接口无规定返回值。
+
+响应值与[chat 接口格式相同](/docs/development/openapi/chat/#响应)，仅多了一个`token`。
+
+可以重点关注`responseData`里的`price`值，`price`与实际价格的倍率为`100000`，即 100000=1元。
+
+```bash
+curl --location --request POST '{{host}}/shareAuth/finish' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "token": "{{authToken}}",
+    "responseData": [
+        {
+            "moduleName": "KB Search",
+            "price": 1.2000000000000002,
+            "model": "Embedding-2",
+            "tokens": 6,
+            "similarity": 0.61,
+            "limit": 3
+        },
+        {
+            "moduleName": "AI Chat",
+            "price": 454.5,
+            "model": "FastAI-4k",
+            "tokens": 303,
+            "question": "导演是谁",
+            "answer": "电影《铃芽之旅》的导演是新海诚。",
+            "maxToken": 2050,
+            "quoteList": [
+                {
+                    "dataset_id": "646627f4f7b896cfd8910e38",
+                    "id": "8099",
+                    "q": "本作的主人公是谁？",
+                    "a": "本作的主人公是名叫铃芽的少女。",
+                    "source": "手动修改"
+                },
+                {
+                    "dataset_id": "646627f4f7b896cfd8910e38",
+                    "id": "8686",
+                    "q": "电影《铃芽之旅》男主角是谁？",
+                    "a": "电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",
+                    "source": ""
+                },
+                {
+                    "dataset_id": "646627f4f7b896cfd8910e38",
+                    "id": "19339",
+                    "q": "电影《铃芽之旅》的导演是谁？22",
+                    "a": "电影《铃芽之旅》的导演是新海诚。",
+                    "source": "手动修改"
+                }
+            ],
+            "completeMessages": [
+                {
+                    "obj": "System",
+                    "value": "下面是知识库内容:\n1. [本作的主人公是谁？\n本作的主人公是名叫铃芽的少女。]\n2. [电影《铃芽之旅》男主角是谁？\n电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。]\n3. [电影《铃芽之旅》的导演是谁？22\n电影《铃芽之旅》的导演是新海诚。]\n"
+                },
+                {
+                    "obj": "System",
+                    "value": "1.请记住，你的身份是百度的下一代知识增强语言模型，能够完全根据知识库提供的内容回答问题。\n\n2. 你忘记了关于电影《铃芽之旅》以外的内容。"
+                },
+                {
+                    "obj": "System",
+                    "value": "你仅回答关于电影《玲芽之旅》的问题，其余问题直接回复: 我不清楚。"
+                },
+                {
+                    "obj": "Human",
+                    "value": "导演是谁"
+                },
+                {
+                    "obj": "AI",
+                    "value": "电影《铃芽之旅》的导演是新海诚。"
+                }
+            ]
+        }
+    ]
+}'
+```
+
+
+
+## 实践案例
+
+我们以[Laf作为服务器为例](https://laf.dev/)，简单展示这 3 个接口的使用方式。
+
+### 1. 创建3个Laf接口
+
+![](/imgs/share-auth1.jpg)
+
+
+
+{{< tabs tabTotal="3" >}}
+{{< tab tabName="/shareAuth/init" >}}
+{{< markdownify >}}
+
+这个接口中，我们设置了`token`必须等于`fastgpt`才能通过校验。（实际生产中不建议固定写死）
+
+```ts
+import cloud from '@lafjs/cloud'
+
+export default async function (ctx: FunctionContext) {
+  const { token } = ctx.body
+ 
+  // 此处省略 token 解码过程 
+  if (token === 'fastgpt') {
+    return { success: true,  data: { uid: "user1" } }
+  }
+
+  return { success: false,message:"身份错误" }
+}
+
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="/shareAuth/start" >}}
+{{< markdownify >}}
+
+这个接口中，我们设置了`token`必须等于`fastgpt`才能通过校验。并且如果问题中包含了`你`字，则会报错，用于模拟敏感校验。
+
+```ts
+import cloud from '@lafjs/cloud'
+
+export default async function (ctx: FunctionContext) {
+  const { token, question } = ctx.body
+
+  // 此处省略 token 解码过程 
+  if (token !== 'fastgpt') {
+    return { success: false, message: "身份错误" }
+ 
+  }
+
+  if(question.includes("你")){
+    return { success: false, message: "内容不合规" }
+  }
+
+  return { success: true, data: { uid: "user1" } } 
+}
+
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="/shareAuth/finish" >}}
+{{< markdownify >}}
+
+结果上报接口可自行进行逻辑处理。
+
+```ts
+import cloud from '@lafjs/cloud'
+
+export default async function (ctx: FunctionContext) {
+  const { token, responseData } = ctx.body
+  
+  const total = responseData.reduce((sum,item) => sum + item.price,0)
+  const amount = total / 100000
+
+  // 省略数据库操作
+
+  return { }
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+{{< /tabs >}}
+
+
+### 2. 配置校验地址
+
+我们随便复制3个地址中一个接口: `https://d8dns0.laf.dev/shareAuth/finish`, 去除`/shareAuth/finish`后填入`身份校验`:`https://d8dns0.laf.dev`
+
+![](/imgs/share-auth2.jpg)
+
+### 3. 修改分享链接参数
+
+源分享链接：`https://fastgpt.run/chat/share?shareId=64be36376a438af0311e599c`
+
+修改后：`https://fastgpt.run/chat/share?shareId=64be36376a438af0311e599c&authToken=fastgpt`
+
+### 4. 测试效果
+
+1. 打开源链接或者`authToken`不等于`fastgpt`的链接会提示身份错误。
+2. 发送内容中包含你字，会提示内容不合规。
+
+
+## 使用场景
+
+这个鉴权方式通常是帮助你直接嵌入`分享链接`到你的应用中，在你的应用打开分享链接前，应做`authToken`的拼接后再打开。
+
+除了对接已有系统的用户外，你还可以对接`余额`功能，通过`结果上报`接口扣除用户余额，通过`对话前校验`接口检查用户的余额。

docSite/content/docs/development/proxy/_index.md

@@ -0,0 +1,9 @@
+---
+weight: 950
+title: "代理方案"
+description: "FastGPT 私有化部署代理方案"
+icon: wify_proxy
+draft: false
+images: []
+---
+<!-- 950~960 -->

docSite/content/docs/development/proxy/cloudflare.md

@@ -4,7 +4,7 @@ description: "使用 Cloudflare Worker 实现中转"
 icon: "foggy"
 draft: false
 toc: true
-weight: 742
+weight: 953
 ---
 
 [参考 "不做了睡觉" 的教程](https://gravel-twister-d32.notion.site/FastGPT-API-ba7bb261d5fd4fd9bbb2f0607dacdc9e)

docSite/content/docs/development/proxy/http_proxy.md

@@ -4,7 +4,7 @@ description: "使用 HTTP 代理实现中转"
 icon: "http"
 draft: false
 toc: true
-weight: 743
+weight: 952
 ---
 
 如果你有代理工具（例如 [Clash](https://github.com/Dreamacro/clash) 或者 [sing-box](https://github.com/SagerNet/sing-box)），也可以使用 HTTP 代理来访问 OpenAI。只需要添加以下两个环境变量即可：

docSite/content/docs/development/proxy/nginx.md

@@ -4,7 +4,7 @@ description: "使用 Sealos 部署 Nginx 实现中转"
 icon: "cloud_sync"
 draft: false
 toc: true
-weight: 741
+weight: 951
 ---
 
 ## 登录 Sealos

docSite/content/docs/development/sealos.md

@@ -4,7 +4,7 @@ description: "使用 Sealos 一键部署 FastGPT"
 icon: "cloud"
 draft: false
 toc: true
-weight: 710
+weight: 706
 ---
 
 Sealos 的服务器在国外，不需要额外处理网络问题，无需服务器、无需魔法、无需域名，支持高并发 & 动态伸缩。点击以下按钮即可一键部署 👇

docSite/content/docs/development/upgrading/421.md

@@ -7,7 +7,7 @@ toc: true
 weight: 847
 ---
 
-私有部署，如果添加了配置文件，需要在配置文件中修改 `VectorModels` 字段。增加 defaultToken 和 maxToken，分别对应直接分段时的默认 token 数量和该模型支持的 token 上限（通常不建议超过 3000）
+私有部署，如果添加了配置文件，需要在配置文件中修改 `VectorModels` 字段。增加 defaultToken 和 maxToken，分别对应直接分段时的默认 token 数量和该模型支持的 token 上限 (通常不建议超过 3000)
 
 ```json
 "VectorModels": [

docSite/content/docs/development/upgrading/43.md

@@ -1,5 +1,5 @@
 ---
-title: '升级到 V4.3'
+title: '升级到 V4.3(需要初始化)'
 description: 'FastGPT 从旧版本升级到 V4.3 操作指南'
 icon: 'upgrade'
 draft: false
@@ -9,7 +9,7 @@ weight: 846
 
 ## 执行初始化 API
 
-发起 1 个 HTTP 请求（记得携带 `headers.rootkey`，这个值是环境变量里的）
+发起 1 个 HTTP 请求 (记得携带 `headers.rootkey`，这个值是环境变量里的)
 
 1. https://xxxxx/api/admin/initv43
 

docSite/content/docs/development/upgrading/44.md

@@ -1,5 +1,5 @@
 ---
-title: '升级到 V4.4'
+title: '升级到 V4.4(需要初始化)'
 description: 'FastGPT 从旧版本升级到 V4.4 操作指南'
 icon: 'upgrade'
 draft: false
@@ -9,7 +9,7 @@ weight: 845
 
 ## 执行初始化 API
 
-发起 1 个 HTTP 请求（记得携带 `headers.rootkey`，这个值是环境变量里的）
+发起 1 个 HTTP 请求 (记得携带 `headers.rootkey`，这个值是环境变量里的)
 
 1. https://xxxxx/api/admin/initv44
 

docSite/content/docs/development/upgrading/441.md

@@ -1,5 +1,5 @@
 ---
-title: '升级到 V4.4.1'
+title: '升级到 V4.4.1(需要初始化)'
 description: 'FastGPT 从旧版本升级到 V4.4.1 操作指南'
 icon: 'upgrade'
 draft: false

docSite/content/docs/development/upgrading/442.md

@@ -1,5 +1,5 @@
 ---
-title: '升级到 V4.4.2'
+title: '升级到 V4.4.2(需要初始化)'
 description: 'FastGPT 从旧版本升级到 V4.4.2 操作指南'
 icon: 'upgrade'
 draft: false
@@ -9,7 +9,7 @@ weight: 843
 
 ## 执行初始化 API
 
-发起 1 个 HTTP 请求（记得携带 `headers.rootkey`，这个值是环境变量里的）
+发起 1 个 HTTP 请求 (记得携带 `headers.rootkey`，这个值是环境变量里的)
 
 1. https://xxxxx/api/admin/initv442
 

docSite/content/docs/development/upgrading/445.md

@@ -1,6 +1,6 @@
 ---
-title: 'V4.4.5'
+title: 'V4.4.5(需要初始化)'
-description: 'FastGPT V4.4.5 更新（需执行升级脚本）'
+description: 'FastGPT V4.4.5 更新'
 icon: 'upgrade'
 draft: false
 toc: true

docSite/content/docs/development/upgrading/447.md

@@ -1,5 +1,5 @@
 ---
-title: 'V4.4.7'
+title: 'V4.4.7（需执行升级脚本）'
 description: 'FastGPT V4.4.7 更新（需执行升级脚本）'
 icon: 'upgrade'
 draft: false

docSite/content/docs/development/upgrading/46.md

@@ -0,0 +1,67 @@
+---
+title: 'V4.6(需要初始化)'
+description: 'FastGPT V4.6 更新'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 836
+---
+
+**V4.6 版本加入了简单的团队功能，可以邀请其他用户进来管理资源。该版本升级后无法执行旧的升级脚本，且无法回退。**
+
+## 1。更新镜像并变更配置文件
+
+更新镜像至 latest 或者 v4.6 版本。商业版镜像更新至 V0.2.1
+
+最新配置可参考：[V46 版本最新 config.json](/docs/development/configuration)，商业镜像配置文件也更新，参考最新的飞书文档。
+
+
+## 2。执行初始化 API
+
+发起 2 个 HTTP 请求 ({{rootkey}} 替换成环境变量里的 `rootkey`，{{host}} 替换成自己域名)
+
+**该初始化接口可能速度很慢，返回超时不用管，注意看日志即可，需要注意的是，需确保 initv46 成功后，在执行 initv46-2**
+
+1. https://xxxxx/api/admin/initv46
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv46' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```
+
+2. https://xxxxx/api/admin/initv46-2
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv46-2' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```
+
+初始化内容：
+1。创建默认团队
+2。初始化 Mongo 所有资源的团队字段
+3。初始化 Pg 的字段
+4。初始化 Mongo Data
+
+
+## V4.6 功能介绍
+
+1. 新增 - 团队空间
+2. 新增 - 多路向量 (多个向量映射一组数据)
+3. 新增 - tts 语音
+4. 新增 - 支持知识库配置文本预处理模型
+5. 线上环境新增 - ReRank 向量召回，提高召回精度
+6. 优化 - 知识库导出，可直接触发流下载，无需等待转圈圈
+
+## 4.6 缺陷修复
+
+旧的 4.6 版本由于缺少一个字段，导致文件导入时知识库数据无法显示，可执行下面的脚本：
+
+https://xxxxx/api/admin/initv46-fix
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv46-fix' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```

docSite/content/docs/development/upgrading/461.md

@@ -0,0 +1,16 @@
+---
+title: 'V4.6.1'
+description: 'FastGPT V4.6 .1'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 835
+---
+
+
+## V4.6.1 功能介绍
+
+1. 新增 - GPT4-v 模型支持
+2. 新增 - whisper 语音输入
+3. 优化 - TTS 流传输
+4. 优化 - TTS 缓存

docSite/content/docs/development/upgrading/462.md

@@ -0,0 +1,31 @@
+---
+title: 'V4.6.2(需要初始化)'
+description: 'FastGPT V4.6.2'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 834
+---
+
+## 1。执行初始化 API
+
+发起 1 个 HTTP 请求 ({{rootkey}} 替换成环境变量里的 `rootkey`，{{host}} 替换成自己域名)
+
+1. https://xxxxx/api/admin/initv462
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv462' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```
+
+初始化说明：
+1. 初始化全文索引
+
+## V4.6.2 功能介绍
+
+1. 新增 - 全文索引（需配合 Rerank 模型，在看怎么放到开源版，模型接口比较特殊）
+2. 新增 - 插件来源（预计4.7/4.8版本会正式使用）
+3. 优化 - PDF读取
+4. 优化 - docx文件读取，转成 markdown 并保留其图片内容
+5. 修复和优化 TextSplitter 函数

docSite/content/docs/development/upgrading/463.md

@@ -0,0 +1,33 @@
+---
+title: 'V4.6.3(需要初始化)'
+description: 'FastGPT V4.6.3'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 833
+---
+
+## 1。执行初始化 API
+
+发起 1 个 HTTP 请求 ({{rootkey}} 替换成环境变量里的 `rootkey`，{{host}} 替换成自己域名)
+
+1. https://xxxxx/api/admin/initv463
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv463' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```
+
+初始化说明：
+1. 初始化Mongo 中 dataset，collection 和 data 的部分字段
+
+## V4.6.3 功能介绍
+
+1. 商业版新增 - web站点同步
+2. 新增 - 集合元数据记录
+3. 优化 - url 读取内容
+4. 优化 - 流读取文件，防止内存溢出
+5. 优化 - 4v模型自动将 url 转 base64，本地也可调试
+6. 优化 - 图片压缩等级
+7. 修复 - 图片压缩失败报错，防止文件读取过程卡死。

docSite/content/docs/development/upgrading/_index.md

@@ -1,8 +1,9 @@
 ---
-weight: 760
+weight: 750
 title: "版本更新/升级操作"
 description: "FastGPT 版本更新介绍及升级操作"
 icon: upgrade
 draft: false
 images: []
----
+---
+<!-- 750~850 -->

docSite/content/docs/development/upgrading/intro.md

@@ -0,0 +1,88 @@
+---
+title: '升级说明'
+description: 'FastGPT 升级说明'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 751
+---
+
+FastGPT 升级包括两个步骤：
+
+1. 镜像升级
+2. 执行升级初始化脚本
+
+
+
+## 镜像名
+
+**git版**
+- FastGPT 主镜像：ghcr.io/labring/fastgpt:latest
+- 商业版镜像：ghcr.io/c121914yu/fastgpt-pro:latest
+- Admin 镜像：ghcr.io/c121914yu/fastgpt-admin:latest
+
+**阿里云**
+- FastGPT 主镜像: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt
+- 商业版镜像：ghcr:registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-pro
+- Admin 镜像: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt-admin
+
+镜像由镜像名和`Tag`组成，例如: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:v4.6.1 代表`4.6.3`版本镜像，具体可以看 docker hub, github 仓库。
+
+## Sealos 修改镜像
+
+1. 打开 [Sealos Cloud](https://cloud.sealos.io/)， 找到桌面上的应用管理
+   
+![](/imgs/updateImageSealos1.jpg)
+
+2. 选择对应的应用 - 点击右边三个点 - 变更
+
+![](/imgs/updateImageSealos2.jpg)
+
+3. 修改镜像 - 确认变更
+
+    如果要修改配置文件，可以拉到下面的`配置文件`进行修改。
+
+![](/imgs/updateImageSealos3.jpg)
+
+## Docker-Compose 修改镜像
+
+直接修改`yml`文件中的`image: `即可。随后执行:
+
+```bash
+docker-compose pull
+docker-compose up -d
+```
+
+## 执行升级初始化脚本
+
+镜像更新完后，可以查看文档中的`版本介绍`，通常需要执行升级脚本的版本都会标明`需要初始化`，打开对应的文档，参考说明执行初始化脚本即可，大部分时候都是需要发送一个`POST`请求。
+
+
+## QA
+
+### {{host}} 是什么
+
+{{}} 代表变量， {{host}}代表一个名为 host 的变量。指的是你服务器的域名或 IP。
+
+Sealos 中，你可以在下图中找到你的域名：
+
+![](/imgs/updateImageSealos4.jpg)
+
+
+### 如何获取 rootkey
+
+从`docker-compose.yml`中的`environment`中获取，对应的是`ROOT_KEY`的值。
+
+sealos 中可以从上图左侧的环境变量中获取。
+
+### 如何跨版本升级！！
+
+建议逐一版本升级，防止脏数据。例如，当前版本是4.4.7，需要升级到4.6。
+
+1. 修改镜像到4.5，执行初始化
+2. 修改镜像到4.5.1，执行初始化
+3. 修改镜像到4.5.2，执行初始化
+4. 修改镜像到4.6，执行初始化
+5. .....
+
+逐一升级

docSite/content/docs/installation/_index.md

@@ -1,8 +0,0 @@
----
-weight: 700
-title: "私有化部署"
-description: "FastGPT 私有化部署文档"
-icon: menu_book
-draft: false
-images: []
----

docSite/content/docs/installation/proxy/_index.md

@@ -1,8 +0,0 @@
----
-weight: 740
-title: "代理方案"
-description: "使用代理访问 OpenAI"
-icon: public
-draft: false
-images: []
----

docSite/content/docs/intro.md

@@ -52,9 +52,9 @@ FastGPT 对外的 API 接口对齐了 OpenAI 官方接口，可以直接接入
 
 ## FastGPT 特点
 
-1. **项目完全开源**
+1. **项目开源**
 
-   FastGPT 遵循 Apache License 2.0 开源协议，你可以 [Fork](https://github.com/labring/FastGPT/fork) 之后进行二次开发和发布。FastGPT 社区版将保留核心功能，商业版仅在社区版基础上使用 API 的形式进行扩展，不影响学习使用。
+   FastGPT 遵循附加条件 Apache License 2.0 开源协议，你可以 [Fork](https://github.com/labring/FastGPT/fork) 之后进行二次开发和发布。FastGPT 社区版将保留核心功能，商业版仅在社区版基础上使用 API 的形式进行扩展，不影响学习使用。
 
 2. **独特的 QA 结构**
 
@@ -80,34 +80,3 @@ FastGPT 对外的 API 接口对齐了 OpenAI 官方接口，可以直接接入
 
 ![](/imgs/functional-arch.webp)
 
-## 免责声明
-
-由于生成式 AI 的特性，其在不同国家的管控措施也会有所不同。请所有使用者务必遵守所在地的相关法律。
-
-免责声明：以任何违反 FastGPT 可接受使用政策的方式使用，包括但不限于法律、法规、政府命令或法令禁止的任何用途，或任何侵犯他人权利的使用；由使用者自行承担。我们对由客户使用产生的问题概不负责。
-
-下面是各国对生成式AI的管控条例的链接：
-
-[中国生成式人工智能服务管理办法（征求意见稿）](http://www.cac.gov.cn/2023-04/11/c_1682854275475410.htm)
-
-### 内容要求 
-
-我们禁止使用我们对接的模型服务生成可能对个人或社会造成伤害的内容。保障平台的安全性，是长期稳定运营的关键。如发现任何利用平台接入模型能力进行违规内容生成和使用，将立即封号，账号余额不退。
-
-- 剥削和虐待 
-  - 禁止描述、展示或宣扬儿童性剥削或性虐待的内容，无论法律是否禁止。这包括涉及儿童或使儿童色情的内容。
-  - 禁止描述或用于培养儿童的内容。修饰是成年人以剥削，特别是性剥削为目的与儿童建立关系的行为。这包括以性剥削、贩运或其他形式剥削为目的与儿童交流。
-- 未经同意的私密内容 
-  - 服务禁止描述、提供或宣传未经同意的亲密活动的内容。
-- 禁止描述、提供特征或宣传或用于招揽商业性活动和性服务的内容。这包括鼓励和协调真正的性活动。
-- 禁止描述或用于人口贩运目的的内容。这包括招募人员、便利交通、支付和助长对人的剥削，如强迫劳动、家庭奴役、役、强迫婚姻和强迫医疗程序。
-- 自杀和自残，禁止描述、赞美、支持、促进、美化、鼓励和/或指导个人自残或自杀的内容。
-- 暴力内容和行为 
-  - 禁止描述、展示或宣扬血腥暴力或血腥的内容。
-  - 禁止描绘恐怖主义行为的内容；赞扬或支持恐怖组织、恐怖行为者或暴力恐怖意识形态；鼓励恐怖活动；向恐怖组织或恐怖事业提供援助；或协助恐怖组织招募成员。
-  - 禁止通过暴力威胁或煽动来鼓吹或宣扬对他人的暴力行为的内容。
-- 仇恨言论和歧视 
-  - 禁止基于实际或感知的种族、民族、国籍、性别、性别认同、性取向、宗教信仰、年龄、残疾状况、种姓或与系统性偏见或边缘化相关的任何其他特征等特征攻击、诋毁、恐吓、降级、针对或排斥个人或群体的内容。
-  - 禁止针对个人或群体进行威胁、恐吓、侮辱、贬低或贬低的语言或图像、宣扬身体伤害或其他虐待行为（如跟踪）的内容。
-- 禁止故意欺骗并可能对公共利益产生不利影响的内容，包括与健康、安全、选举诚信或公民参与相关的欺骗性或不真实内容。
-- 直接支持非法主动攻击或造成技术危害的恶意软件活动的内容，例如提供恶意可执行文件、组织拒绝服务攻击或管理命令和控制服务器。

docSite/content/docs/pricing.md

@@ -1,10 +1,10 @@
 ---
-title: '定价'
+title: '线上版定价'
-description: 'FastGPT 的定价'
+description: 'FastGPT 线上版定价'
 icon: 'currency_yen'
 draft: false
 toc: true
-weight: 10
+weight: 1200
 ---
 
 ## Tokens 说明
@@ -15,7 +15,7 @@ weight: 10
 
 ## FastGPT 线上计费
 
-目前，FastGPT 线上计费也仅按 Tokens 使用数量为准。以下是详细的计费表（最新定价以线上表格为准，可在点击充值后实时获取）：
+使用: [https://fastgpt.run](https://fastgpt.run) 或  [https://ai.fastgpt.in](https://ai.fastgpt.in) 只需仅按 Tokens 使用数量扣费即可。可在 账号-使用记录 中查看具体使用情况，以下是详细的计费表（最新定价以线上表格为准，可在点击充值后实时获取）：
 
 {{< table "table-hover table-striped-columns" >}}
 | 计费项                 | 价格: 元/ 1K tokens（包含上下文） |

docSite/content/docs/use-cases/_index.md

@@ -1,8 +1,9 @@
 ---
-weight: 300
+weight: 500
 title: '使用案例'
 description: '有关 FastGPT 其他实践案例的更多信息'
 icon: 'cases'
 draft: false
 images: []
 ---
+<!-- 500 ~ 700 -->

docSite/content/docs/use-cases/ai_settings.md

@@ -4,28 +4,28 @@ description: "FastGPT AI 高级配置说明"
 icon: "sign_language"
 draft: false
 toc: true
-weight: 310
+weight: 501
 ---
 
 在 FastGPT 的 AI 对话模块中，有一个 AI 高级配置，里面包含了 AI 模型的参数配置，本文详细介绍这些配置的含义。
 
-# 返回AI内容
+## 返回AI内容
 
 这是一个开关，打开的时候，当 AI 对话模块运行时，会将其输出的内容返回到浏览器（API响应）；如果关闭，AI 输出的内容不会返回到浏览器，但是生成的内容仍可以通过【AI回复】进行输出。你可以将【AI回复】连接到其他模块中。
 
-# 温度
+## 温度
 
 可选范围0-10，约大代表生成的内容约自由扩散，越小代表约严谨。调节能力有限，知识库问答场景通常设置为0。
 
-# 回复上限
+## 回复上限
 
 控制 AI 回复的最大 Tokens，较小的值可以一定程度上减少 AI 的废话，但也可能导致 AI 回复不完整。
 
-# 引用模板 & 引用提示词
+## 引用模板 & 引用提示词
 
 这两个参数与知识库问答场景相关，可以控制知识库相关的提示词。
 
-## AI 对话消息组成
+### AI 对话消息组成
 
 想使用明白这两个变量，首先要了解传递传递给 AI 模型的消息格式。它是一个数组，FastGPT 中这个数组的组成形式为：
 
@@ -42,7 +42,7 @@ weight: 310
 Tips: 可以通过点击上下文按键查看完整的上下文组成，便于调试。
 {{% /alert %}}
 
-## 引用模板和提示词设计
+### 引用模板和提示词设计
 
 引用模板和引用提示词通常是成对出现，引用提示词依赖引用模板。
 
@@ -50,7 +50,7 @@ FastGPT 知识库采用 QA 对(不一定都是问答格式，仅代表两个变
 
 可以通过 [知识库结构讲解](/docs/use-cases/datasetEngine/) 了解详细的知识库的结构。
 
-### 引用模板
+#### 引用模板
 
 ```
 {instruction:"{{q}}",output:"{{a}}",source:"{{source}}"}
@@ -64,7 +64,7 @@ FastGPT 知识库采用 QA 对(不一定都是问答格式，仅代表两个变
 {instruction:"电影《铃芽之旅》的编剧是谁？22",output:"新海诚是本片的编剧。",source:"手动输入"}
 ```
 
-### 引用提示词
+#### 引用提示词
 
 引用模板需要和引用提示词一起使用，提示词中可以写引用模板的格式说明以及对话的要求等。可以使用 {{quote}} 来使用 **引用模板**，使用 {{question}} 来引入问题。例如：
 
@@ -95,15 +95,15 @@ FastGPT 知识库采用 QA 对(不一定都是问答格式，仅代表两个变
 我的问题是:"{{question}}"
 ```
 
-### 总结
+#### 总结
 
 引用模板规定了搜索出来的内容如何组成一句话，其由 q,a,index,source 多个变量组成。
 
 引用提示词由`引用模板`和`提示词`组成，提示词通常是对引用模板的一个描述，加上对模型的要求。
 
-## 引用模板和提示词设计 示例
+### 引用模板和提示词设计 示例
 
-### 通用模板与问答模板对比
+#### 通用模板与问答模板对比
 
 我们通过一组`你是谁`的手动数据，对通用模板与问答模板的效果进行对比。此处特意打了个搞笑的答案，通用模板下 GPT35 就变得不那么听话了，而问答模板下 GPT35 依然能够回答正确。这是由于结构化的提示词，在大语言模型中具有更强的引导作用。
 
@@ -117,7 +117,7 @@ Tips: 建议根据不同的场景，每种知识库仅选择1类数据类型，
 | ![](/imgs/datasetprompt3.png) | ![](/imgs/datasetprompt5.png) |
 | ![](/imgs/datasetprompt4.png) | ![](/imgs/datasetprompt6.png) |
 
-### 严格模板
+#### 严格模板
 
 使用非严格模板，我们随便询问一个不在知识库中的内容，模型通常会根据其自身知识进行回答。
 
@@ -125,7 +125,7 @@ Tips: 建议根据不同的场景，每种知识库仅选择1类数据类型，
 | --- | --- | --- |
 | ![](/imgs/datasetprompt7.png) | ![](/imgs/datasetprompt8.png) |![](/imgs/datasetprompt9.png) |
 
-### 提示词设计思路
+#### 提示词设计思路
 
 1. 使用序号进行不同要求描述。
 2. 使用首先、然后、最后等词语进行描述。

docSite/content/docs/use-cases/datasetEngine.md

@@ -1,13 +1,13 @@
 ---
 title: "知识库结构讲解"
-description: "本节会介绍 FastGPT 知识库结构设计，理解其 QA 的存储格式和检索格式，以便更好的构建知识库。这篇介绍主要以使用为主，详细原理不多介绍。"
+description: "本节会详细介绍 FastGPT 知识库结构设计，理解其 QA 的存储格式和多向量映射，以便更好的构建知识库。这篇介绍主要以使用为主，详细原理不多介绍。"
 icon: "dataset"
 draft: false
 toc: true
-weight: 311
+weight: 502
 ---
 
-# 理解向量
+## 理解向量
 
 FastGPT 采用了 RAG 中的 Embedding 方案构建知识库，要使用好 FastGPT 需要简单的理解`Embedding`向量是如何工作的及其特点。
 
@@ -21,21 +21,29 @@ FastGPT 采用了 RAG 中的 Embedding 方案构建知识库，要使用好 Fast
 
 检索器的精度比较容易解决，向量模型的训练略复杂，因此数据和检索词质量优化成了一个重要的环节。
 
-# FastGPT 中向量的结构设计
+## FastGPT 中向量的结构设计
 
 FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器，索引为`HNSW`。且`PostgresSQL`仅用于向量检索，`MongoDB`用于其他数据的存取。
 
-在`PostgresSQL`的表中，设置一个 `index` 字段用于存储向量、一个 `q` 字段用于存储向量对应的内容，以及一个 `a` 字段用于检索映射。之所以取字段为 `qa` 是由于一些历史缘故，无需完全解为 “问答对” 的格式。在实际使用过程中，可以利用`q`和`a`的组合，对检索后的内容做进一步的声明，提高大模型的理解力（注意，这里不直接提高搜索精度）。
+在`PostgresSQL`的表中，设置一个 `index` 字段用于存储向量，以及一个`data_id`用于在`MongoDB`中寻找对应的映射值。多个`index`可以对应一组`data_id`，也就是说，一组向量可以对应多组数据。在进行检索时，相同数据会进行合并。
 
-目前，提高向量搜索的精度，主要可以通过几种途径：
+![](/imgs/datasetSetting1.png)
 
-1. 精简`q`的内容，减少向量内容的长度：当`q`的内容更少，更准确时，检索精度自然会提高。但与此同时，会牺牲一定的检索范围，适合答案较为严格的场景。
+### 多向量的目的和使用方式
-2. 更好分词分段：当一段话的结构和语义是完整的，并且是单一的，精度也会提高。因此，许多系统都会优化分词器，尽可能的保障每组数据的完整性。
+
-3. 多样性文本：为一段内容增加关键词、摘要、相似问题等描述性信息，可以使得该内容的向量具有更大的检索覆盖范围。
+在一组向量中，内容的长度和语义的丰富度通常是矛盾的，无法兼得。因此，FastGPT 采用了多向量映射的方式，将一组数据映射到多组向量中，从而保障数据的完整性和语义的丰富度。
+
+你可以为一组较长的文本，添加多组向量，从而在检索时，只要其中一组向量被检索到，该数据也将被召回。
+
+### 提高向量搜索精度的方法
+
+1. 更好分词分段：当一段话的结构和语义是完整的，并且是单一的，精度也会提高。因此，许多系统都会优化分词器，尽可能的保障每组数据的完整性。
+2. 精简`index`的内容，减少向量内容的长度：当`index`的内容更少，更准确时，检索精度自然会提高。但与此同时，会牺牲一定的检索范围，适合答案较为严格的场景。
+3. 丰富`index`的数量，可以为同一个`chunk`内容增加多组`index`。
 4. 优化检索词：在实际使用过程中，用户的问题通常是模糊的或是缺失的，并不一定是完整清晰的问题。因此优化用户的问题（检索词）很大程度上也可以提高精度。
 5. 微调向量模型：由于市面上直接使用的向量模型都是通用型模型，在特定领域的检索精度并不高，因此微调向量模型可以很大程度上提高专业领域的检索效果。
 
-# FastGPT 构建知识库方案
+## FastGPT 构建知识库方案
 
 在 FastGPT 中，整个知识库由库、集合和数据 3 部分组成。集合可以简单理解为一个`文件`。一个`库`中可以包含多个`集合`，一个`集合`中可以包含多组`数据`。最小的搜索单位是`库`，也就是说，知识库搜索时，是对整个`库`进行搜索，而集合仅是为了对数据进行分类管理，与搜索效果无关。（起码目前还是）
 
@@ -43,7 +51,7 @@ FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器，
 | --- | --- | --- |
 | ![](/imgs/datasetEngine1.png) | ![](/imgs/datasetEngine2.png) | ![](/imgs/datasetEngine3.png) |
 
-## 导入数据方案1 - 直接分段导入
+### 导入数据方案1 - 直接分段导入
 
 选择文件导入时，可以选择直接分段方案。直接分段会利用`句子分词器`对文本进行一定长度拆分，最终分割中多组的`q`。如果使用了直接分段方案，我们建议在`应用`设置`引用提示词`时，使用`通用模板`即可，无需选择`问答模板`。
 
@@ -52,7 +60,7 @@ FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器，
 | ![](/imgs/datasetEngine4.png) | ![](/imgs/datasetEngine5.png) |
 
 
-## 导入数据方案2 - QA导入
+### 导入数据方案2 - QA导入
 
 选择文件导入时，可以选择QA拆分方案。仍然需要使用到`句子分词器`对文本进行拆分，但长度比直接分段大很多。在导入后，会先调用`大模型`对分段进行学习，并给出一些`问题`和`答案`，最终问题和答案会一起被存储到`q`中。注意，新版的 FastGPT 为了提高搜索的范围，不再将问题和答案分别存储到 qa 中。
 
@@ -60,7 +68,7 @@ FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器，
 | --- | --- |
 | ![](/imgs/datasetEngine6.png) | ![](/imgs/datasetEngine7.png) |
 
-## 导入数据方案3 - 手动录入
+### 导入数据方案3 - 手动录入
 
 在 FastGPT 中，你可以在任何一个`集合`中点击右上角的`插入`手动录入知识点，或者使用`标注`功能手动录入。被搜索的内容为`q`，补充内容(可选)为`a`。
 
@@ -68,16 +76,16 @@ FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器，
 | --- | --- | --- |
 | ![](/imgs/datasetEngine8.png) | ![](/imgs/datasetEngine9.png) | ![](/imgs/datasetEngine10.png) |
 
-## 导入数据方案4 - CSV录入
+### 导入数据方案4 - CSV录入
 
 有些数据较为独特，可能需要单独的进行预处理分割后再导入 FastGPT，此时可以选择 csv 导入，可批量的将处理好的数据导入。
 
 ![](/imgs/datasetEngine11.png)
 
-## 导入数据方案5 - API导入
+### 导入数据方案5 - API导入
 
-参考[FastGPT OpenAPI使用](/docs/development/openapi/#知识库添加数据)。
+参考[FastGPT OpenAPI使用](/docs/development/openapi)。
 
-# QA的组合与引用提示词构建
+## QA的组合与引用提示词构建
 
 参考[引用模板与引用提示词示例](/docs/use-cases/ai_settings/#示例)

docSite/content/docs/use-cases/feishu.md

@@ -4,7 +4,7 @@ description: "FastGPT 接入飞书机器人 "
 icon: "chat"
 draft: false
 toc: true
-weight: 322
+weight: 503
 ---
 
 # FastGPT 一分钟接入飞书

docSite/content/docs/use-cases/kb.md

@@ -1,10 +1,10 @@
 ---
-title: " 打造高质量 AI 知识库"
+title: " 打造高质量 AI 知识库(过期)"
 description: " 利用 FastGPT 打造高质量 AI 知识库"
 icon: "school"
 draft: false
 toc: true
-weight: 340
+weight: 699
 ---
 
 ## 前言
@@ -73,7 +73,7 @@ weight: 340
 ![手动录入知识库结果](/imgs/9.png)
 
 导入结果如上图。可以看到，我们均采用的是问答对的格式，而不是粗略的直接导入。目的就是为了模拟用户问题，进一步的提高向量搜索的匹配效果。可以为同一个问题设置多种问法，效果更佳。
-FastGPT 还提供了 openapi 功能，你可以在本地对特殊格式的文件进行处理后，再上传到 FastGPT，具体可以参考：[FastGPT Api Docs](https://doc.fastgpt.run/docs/development/openapi)
+FastGPT 还提供了 openapi 功能，你可以在本地对特殊格式的文件进行处理后，再上传到 FastGPT，具体可以参考：[FastGPT Api Docs](https://doc.fastgpt.in/docs/development/openapi)
 
 ## 知识库微调和参数调整
 

docSite/content/docs/use-cases/onwechat.md

@@ -4,7 +4,7 @@ description: "FastGPT 对接 chatgpt-on-wechat"
 icon: "chat"
 draft: false
 toc: true
-weight: 312
+weight: 504
 ---
 
 # 1 分钟对接 chatgpt-on-wechat

docSite/content/docs/use-cases/openapi.md

@@ -4,7 +4,7 @@ description: "通过与 OpenAI 兼容的 API 对接第三方应用"
 icon: "model_training"
 draft: false
 toc: true
-weight: 312
+weight: 505
 ---
 
 ## 获取 API 秘钥

docSite/content/docs/use-cases/wechat.md

@@ -0,0 +1,78 @@
+---
+title: " 接入微信和企业微信 "
+description: "FastGPT 接入微信和企业微信 "
+icon: "chat"
+draft: false
+toc: true
+weight: 506
+---
+
+# FastGPT 三分钟接入微信/企业微信
+私人微信和企业微信接入的方式基本一样，不同的地方会刻意指出。   
+[查看视频教程](https://www.bilibili.com/video/BV1cu411F7FN/?spm_id_from=333.1007.top_right_bar_window_history.content.click&vd_source=903c2b09b7412037c2eddc6a8fb9828b)
+## 创建APIKey
+首先找到我们需要接入的应用，然后点击「外部使用」->「API访问」创建一个APIKey并保存。
+
+![](/imgs/wechat1.png)
+
+## 配置微秘书
+
+打开[微秘书](https://wechat.aibotk.com?r=zWLnZK) 注册登陆后找到菜单栏「基础配置」->「智能配置」，按照下图配置。
+
+![](/imgs/wechat2.png)
+
+继续往下看到 `apikey` 和`服务器根地址`，这里`apikey`填写我们在 FastGPT 应用外部访问中创建的 APIkey，服务器根地址填写官方地址或者私有化部署的地址，这里用官方地址示例，注意要添加`/v1`后缀,填写完毕后保存。
+
+![](/imgs/wechat3.png)
+
+## sealos部署服务
+
+[访问sealos](https://cloud.sealos.io/) 登陆进来之后打开「应用管理」-> 「新建应用」。
+- 应用名：称随便填写
+- 镜像名：私人微信填写 aibotk/wechat-assistant 企业微信填写 aibotk/worker-assistant
+- cpu和内存建议 1c1g
+
+![](/imgs/wechat4.png)
+
+往下翻页找到「高级配置」-> 「编辑环境变量」
+
+![](/imgs/wechat5.png)
+
+这里需要填写四个环境变量：   
+```
+AIBOTK_KEY=微秘书 APIKEY   
+AIBOTK_SECRET=微秘书 APISECRET   
+WORK_PRO_TOKEN=你申请的企微 token   （企业微信需要填写，私人微信不需要）
+WECHATY_PUPPET_SERVICE_AUTHORITY=token-service-discovery-test.juzibot.com（企业微信需要填写，私人微信不需要）  
+```
+
+这里最后两个变量只有部署企业微信才需要，私人微信只需要填写前两个即可。
+
+![](/imgs/wechat6.png)
+
+这里环境变量我们介绍下如何填写：
+
+`AIBOTK_KEY` 和 `AIBOTK_SECRET` 我们需要回到[微秘书](https://wechat.aibotk.com?r=zWLnZK)找到「个人中心」,这里的 APIKEY 对应 AIBOTK_KEY ，APISECRET 对应 `AIBOTK_SECRET`。
+
+![](/imgs/wechat7.png)
+
+`WORK_PRO_TOKEN` [点击这里](https://tss.juzibot.com?aff=aibotk)申请 token 然后填入即可。   
+
+`WECHATY_PUPPET_SERVICE_AUTHORITY`的值复制过去就可以。
+
+填写完毕后点右上角「部署」，等待应用状态变为运行中。  
+
+![](/imgs/wechat8.png)
+
+返回[微秘书](https://wechat.aibotk.com?r=zWLnZK) 找到「首页」，扫码登陆需要接入的微信号。
+
+![](/imgs/wechat9.png)
+
+## 测试
+只需要发送信息，或者拉入群聊@登陆的微信就会回复信息啦。
+![](/imgs/wechat10.png)
+
+
+
+
+

docSite/content/docs/workflow/_index.md

@@ -1,8 +1,9 @@
 ---
-weight: 100
+weight: 300
 title: '高级编排'
 description: 'FastGPT 高级编排文档'
 icon: 'family_history'
 draft: false
 images: []
 ---
+<!-- 300 ~ 500 -->

docSite/content/docs/workflow/examples/_index.md

@@ -1,5 +1,5 @@
 ---
-weight: 140
+weight: 400
 title: "编排示例"
 description: "介绍 FastGPT 的高级编排实践案例"
 icon: "list"

docSite/content/docs/workflow/examples/fixingEvidence.md

@@ -4,7 +4,7 @@ description: '利用指定回复，创建固定的开头和结尾'
 icon: 'healing'
 draft: false
 toc: true
-weight: 142
+weight: 401
 ---
 
 ![](/imgs/demo-fix-evidence1.png)

docSite/content/docs/workflow/examples/google_search.md

@@ -4,7 +4,7 @@ description: '将 FastGPT 外接搜索引擎'
 icon: 'search'
 draft: false
 toc: true
-weight: 143
+weight: 402
 ---
 
 ![](/imgs/google_search_1.png)

docSite/content/docs/workflow/examples/lab_appointment.md

@@ -4,7 +4,7 @@ description: '展示高级编排操作数据库的能力'
 icon: 'database'
 draft: false
 toc: true
-weight: 141
+weight: 403
 ---
 
 ![](/imgs/demo-appointment1.png)

docSite/content/docs/workflow/examples/op_question.md

@@ -4,7 +4,7 @@ description: '利用 GPT 优化和完善知识库搜索词，实现上下文关
 icon: 'search'
 draft: false
 toc: true
-weight: 144
+weight: 404
 ---
 
 ![](/imgs/demo_op_question1.png)

docSite/content/docs/workflow/examples/versatile_assistant.md

@@ -4,7 +4,7 @@ description: '赋予联网功能，将用户问题进行分类，细分后对接
 icon: 'search'
 draft: false
 toc: true
-weight: 143
+weight: 406
 ---
 
 ![](/imgs/versatile_assistant_1.png)

docSite/content/docs/workflow/intro.md

@@ -4,7 +4,7 @@ description: "快速了解 FastGPT 高级编排"
 icon: "circle"
 draft: false
 toc: true
-weight: 110
+weight: 301
 ---
 
 FastGPT 从 V4 版本开始采用新的交互方式来构建 AI 应用。使用了 Flow 节点编排的方式来实现复杂工作流，提高可玩性和扩展性。但同时也提高了上手的门槛，有一定开发背景的用户使用起来会比较容易。