fix: img compress (#546)

* Fix: Update Custom Chat Title Based on chatId

* remove `new:true` option

* Update update.ts

---------

Co-authored-by: Archer <545436317@qq.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

@@ -1,7 +1,7 @@
 # Install dependencies only when needed
 FROM node:18.15-alpine AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
-RUN apk add --no-cache libc6-compat && npm install -g pnpm
+RUN apk add libc6-compat && npm install -g pnpm
 WORKDIR /app
 
 ARG name

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 插件)
@@ -98,12 +107,20 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 * [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",
-  "rules": {
-    "adjustedFullWidthPunctuation": ""
-  }
-}
+    "preset": "default",
+    "rules": {
+      "adjustedFullWidthPunctuation": ""
+    }
+  }

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

@@ -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/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,
-    "price": 0,
-    "quoteMaxToken": 4000,
-    "maxTemperature": 1.2,
+    "maxContext": 4000,
+    "maxResponse": 4000,
+    "quoteMaxToken": 2000,
+    "maxTemperature": 1,
+    "vision": false, 
     "defaultSystemChatPrompt": ""
   }
 ]

docSite/content/docs/development/configuration.md

@@ -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", // 实际调用的模型
-      "name": "GPT35-4k", // 展示的名字
-      "maxToken": 4000, // 最大token，均按 gpt35 计算
-      "quoteMaxToken": 2000, // 引用内容最大 token
-      "maxTemperature": 1.2, // 最大温度
-      "price": 0,
+      "model": "gpt-3.5-turbo-1106",
+      "name": "GPT35-1106",
+      "price": 0, // 除以 100000 后等于1个token的价格
+      "maxContext": 16000, // 最大上下文长度
+      "maxResponse": 4000, // 最大回复长度
+      "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",
-      "name": "GPT35-16k",
-      "maxToken": 16000,
-      "price": 0,
-      "functionCall": true,
-      "functionPrompt": ""
-    },
-    {
-      "model": "gpt-4",
-      "name": "GPT4-8k",
-      "maxToken": 8000,
+      "model": "gpt-3.5-turbo-1106",
+      "name": "GPT35-1106",
+      "maxContext": 16000,
+      "maxResponse": 4000,
       "price": 0,
       "functionCall": true,
       "functionPrompt": ""
     }
   ],
-  "QGModels": [ // Question Generation: 生成下一步指引模型
-    { 
-      "model": "gpt-3.5-turbo",
-      "name": "GPT35-4k",
-      "maxToken": 4000,
+  "QGModels": [ // 生成下一步指引
+    {
+      "model": "gpt-3.5-turbo-1106",
+      "name": "GPT35-1106",
+      "maxContext": 1600,
+      "maxResponse": 4000,
       "price": 0
     }
   ],
-  "VectorModels": [
+  "VectorModels": [ // 向量模型
     {
       "model": "text-embedding-ada-002",
       "name": "Embedding-2",
-      "price": 0,
-      "defaultToken": 500,
+      "price": 0.2,
+      "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/intro.md

@@ -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/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,8 @@
+---
+weight: 560
+title: "OpenAPI 接口文档"
+description: "FastGPT OpenAPI 文档"
+icon: api
+draft: false
+images: []
+---

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: 561
+---
+
+## 使用说明
+
+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: 562
+---
+
+## 发起对话
+
+{{% 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: 563
+---
+
+| 如何获取知识库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,257 @@
+---
+title: '分享链接鉴权'
+description: 'FastGPT 分享链接鉴权'
+icon: 'share'
+draft: false
+toc: true
+weight: 564
+---
+
+## 使用说明
+
+分享链接鉴权设计的目的在于，将 FastGPT 的对话框安全的接入你现有的系统中。
+
+免登录链接配置中，增加了`凭证校验服务器`后，使用分享链接时会向服务器发起请求，校验链接是否可用，并在每次对话结束后，向服务器发送对话结果。下面以`host`来表示`凭证校验服务器`。服务器接口仅需返回是否校验成功即可，不需要返回其他数据，格式如下：
+
+```json
+{
+    "success": true,
+    "message": "错误提示",
+    "msg": "同message, 错误提示"
+}
+```
+
+![](/imgs/sharelinkProcess.png)
+
+## 配置校验地址和校验token
+
+### 1. 配置校验地址的`BaseURL`、
+
+![](/imgs/share-setlink.jpg)
+
+配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。
+
+### 2. 分享链接中增加额外 query
+
+在分享链接的地址中，增加一个额外的参数: authToken。例如：
+
+原始的链接：https://fastgpt.run/chat/share?shareId=648aaf5ae121349a16d62192  
+完整链接: https://fastgpt.run/chat/share?shareId=648aaf5ae121349a16d62192&authToken=userid12345
+
+这个`token`通常是你系统生成的，在发出校验请求时，FastGPT 会在`body`中携带 token={{authToken}} 的参数。
+
+## 聊天初始化校验
+
+**FastGPT 发出的请求**
+
+```bash
+curl --location --request POST '{{host}}/shareAuth/init' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "token": "sintdolore"
+}'
+```
+
+**响应示例**
+
+```json
+{
+    "success": false,
+    "message": "分享链接无效",
+}
+```
+
+## 对话前校验
+
+**FastGPT 发出的请求**
+
+```bash
+curl --location --request POST '{{host}}/shareAuth/start' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "token": "sintdolore",
+    "question": "用户问题",
+}'
+```
+
+**响应示例**
+
+```json
+{
+    "success": true
+}
+```
+
+## 对话结果上报
+
+```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`。
+
+**此接口无需响应值**
+
+## 使用示例
+
+我们以[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
+
+  if (token === 'fastgpt') {
+    return { success: true }
+  }
+
+  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
+  console.log(token, question, 'start')
+
+  if (token !== 'fastgpt') {
+    return { success: false, message: "身份错误" }
+ 
+  }
+
+  if(question.includes("你")){
+    return { success: false, message: "内容不合规" }
+  }
+
+  return { success: true } 
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+
+{{< tab tabName="/shareAuth/finish" >}}
+{{< markdownify >}}
+
+结果上报接口可自行进行逻辑处理。
+
+```ts
+import cloud from '@lafjs/cloud'
+
+export default async function (ctx: FunctionContext) {
+  const { token, responseData } = ctx.body
+  console.log(token,responseData,'=====')
+  return { }
+}
+```
+
+{{< /markdownify >}}
+{{< /tab >}}
+{{< /tabs >}}
+
+
+### 2. 配置校验地址
+
+我们随便复制3个地址中一个接口：https://d8dns0.laf.dev/shareAuth/finish , 去除 /shareAuth/finish 后填入 FastGPT 中: https://d8dns0.laf.dev
+
+![](/imgs/share-auth2.jpg)
+
+### 3. 修改分享链接参数
+
+源分享链接：[https://fastgpt.run/chat/share?shareId=64be36376a438af0311e599c](https://fastgpt.run/chat/share?shareId=64be36376a438af0311e599c)
+
+修改后：[https://fastgpt.run/chat/share?shareId=64be36376a438af0311e599c&authToken=fastgpt](https://fastgpt.run/chat/share?shareId=64be36376a438af0311e599c&authToken=fastgpt)
+
+### 4. 测试效果
+
+1. 打开源链接或者`authToken`不等于 `fastgpt`的链接会提示身份错误。
+2. 发送内容中包含你字，会提示内容不合规。

docSite/content/docs/installation/docker.md

@@ -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/installation/one-api.md

@@ -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/installation/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/installation/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/installation/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/installation/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/installation/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/installation/upgrading/445.md

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

docSite/content/docs/installation/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/installation/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/installation/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/installation/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/installation/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/pricing.md

@@ -1,10 +1,10 @@
 ---
-title: '定价'
-description: 'FastGPT 的定价'
+title: '线上版定价'
+description: 'FastGPT 线上版定价'
 icon: 'currency_yen'
 draft: false
 toc: true
-weight: 10
+weight: 11
 ---
 
 ## 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/ai_settings.md

@@ -9,23 +9,23 @@ weight: 310
 
 在 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
 ---
 
-# 理解向量
+## 理解向量
 
 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/#知识库添加数据)。
 
-# QA的组合与引用提示词构建
+## QA的组合与引用提示词构建
 
 参考[引用模板与引用提示词示例](/docs/use-cases/ai_settings/#示例)

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

@@ -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/wechat.md

@@ -0,0 +1,78 @@
+---
+title: " 接入微信和企业微信 "
+description: "FastGPT 接入微信和企业微信 "
+icon: "chat"
+draft: false
+toc: true
+weight: 322
+---
+
+# 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)
+
+
+
+
+

package.json

@@ -8,12 +8,14 @@
     "format-doc": "zhlint --dir ./docSite *.md --fix"
   },
   "devDependencies": {
+    "@types/multer": "^1.4.10",
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.1",
-    "prettier": "^3.0.3",
     "i18next": "^22.5.1",
+    "lint-staged": "^13.2.1",
+    "next-i18next": "^13.3.0",
+    "prettier": "^3.0.3",
     "react-i18next": "^12.3.1",
-    "next-i18next": "^13.3.0"
+    "zhlint": "^0.7.1"
   },
   "lint-staged": {
     "./**/**/*.{ts,tsx,scss}": "npm run format-code",
@@ -21,5 +23,9 @@
   },
   "engines": {
     "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "multer": "1.4.5-lts.1",
+    "openai": "4.16.1"
   }
 }

packages/global/common/bill/constants.ts

@@ -1 +0,0 @@
-export const PRICE_SCALE = 100000;

packages/global/common/bill/tools.ts

@@ -1,9 +0,0 @@
-/* bill common  */
-import { PRICE_SCALE } from './constants';
-
-/**
- * dataset price / PRICE_SCALE = real price
- */
-export const formatPrice = (val = 0, multiple = 1) => {
-  return Number(((val / PRICE_SCALE) * multiple).toFixed(10));
-};

packages/global/common/bill/types/billReq.d.ts

@@ -1,3 +0,0 @@
-export type CreateTrainingBillType = {
-  name: string;
-};

packages/global/common/error/code/app.ts

@@ -0,0 +1,28 @@
+import { ErrType } from '../errorCode';
+
+/* dataset: 502000 */
+export enum AppErrEnum {
+  unExist = 'unExist',
+  unAuthApp = 'unAuthApp'
+}
+const appErrList = [
+  {
+    statusText: AppErrEnum.unExist,
+    message: '应用不存在'
+  },
+  {
+    statusText: AppErrEnum.unAuthApp,
+    message: '无权操作该应用'
+  }
+];
+export default appErrList.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 502000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${AppErrEnum}`>);

packages/global/common/error/code/chat.ts

@@ -0,0 +1,23 @@
+import { ErrType } from '../errorCode';
+
+/* dataset: 504000 */
+export enum ChatErrEnum {
+  unAuthChat = 'unAuthChat'
+}
+const errList = [
+  {
+    statusText: ChatErrEnum.unAuthChat,
+    message: '无权操作该对话记录'
+  }
+];
+export default errList.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 504000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${ChatErrEnum}`>);

packages/global/common/error/code/dataset.ts

@@ -0,0 +1,43 @@
+import { ErrType } from '../errorCode';
+
+/* dataset: 501000 */
+export enum DatasetErrEnum {
+  unAuthDataset = 'unAuthDataset',
+  unCreateCollection = 'unCreateCollection',
+  unAuthDatasetCollection = 'unAuthDatasetCollection',
+  unAuthDatasetData = 'unAuthDatasetData',
+  unAuthDatasetFile = 'unAuthDatasetFile'
+}
+const datasetErr = [
+  {
+    statusText: DatasetErrEnum.unAuthDataset,
+    message: '无权操作该知识库'
+  },
+  {
+    statusText: DatasetErrEnum.unAuthDatasetCollection,
+    message: '无权操作该数据集'
+  },
+  {
+    statusText: DatasetErrEnum.unAuthDatasetData,
+    message: '无权操作该数据'
+  },
+  {
+    statusText: DatasetErrEnum.unAuthDatasetFile,
+    message: '无权操作该文件'
+  },
+  {
+    statusText: DatasetErrEnum.unCreateCollection,
+    message: '无权创建数据集'
+  }
+];
+export default datasetErr.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 501000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${DatasetErrEnum}`>);

packages/global/common/error/code/openapi.ts

@@ -0,0 +1,28 @@
+import { ErrType } from '../errorCode';
+
+/* dataset: 506000 */
+export enum OpenApiErrEnum {
+  unExist = 'unExist',
+  unAuth = 'unAuth'
+}
+const errList = [
+  {
+    statusText: OpenApiErrEnum.unExist,
+    message: 'Api Key 不存在'
+  },
+  {
+    statusText: OpenApiErrEnum.unAuth,
+    message: '无权操作该 Api Key'
+  }
+];
+export default errList.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 506000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${OpenApiErrEnum}`>);

packages/global/common/error/code/outLink.ts

@@ -0,0 +1,34 @@
+import { ErrType } from '../errorCode';
+
+/* dataset: 505000 */
+export enum OutLinkErrEnum {
+  unExist = 'unExist',
+  unAuthLink = 'unAuthLink',
+  linkUnInvalid = 'linkUnInvalid'
+}
+const errList = [
+  {
+    statusText: OutLinkErrEnum.unExist,
+    message: '分享链接不存在'
+  },
+  {
+    statusText: OutLinkErrEnum.unAuthLink,
+    message: '分享链接无效'
+  },
+  {
+    code: 501,
+    statusText: OutLinkErrEnum.linkUnInvalid,
+    message: '分享链接无效'
+  }
+];
+export default errList.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: cur?.code || 505000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${OutLinkErrEnum}`>);

packages/global/common/error/code/plugin.ts

@@ -0,0 +1,28 @@
+import { ErrType } from '../errorCode';
+
+/* dataset: 507000 */
+export enum PluginErrEnum {
+  unExist = 'unExist',
+  unAuth = 'unAuth'
+}
+const errList = [
+  {
+    statusText: PluginErrEnum.unExist,
+    message: '插件不存在'
+  },
+  {
+    statusText: PluginErrEnum.unAuth,
+    message: '无权操作该插件'
+  }
+];
+export default errList.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 507000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${PluginErrEnum}`>);

packages/global/common/error/code/team.ts

@@ -0,0 +1,22 @@
+import { ErrType } from '../errorCode';
+
+/* team: 500000 */
+export enum TeamErrEnum {
+  teamOverSize = 'teamOverSize',
+  unAuthTeam = 'unAuthTeam'
+}
+const teamErr = [
+  { statusText: TeamErrEnum.teamOverSize, message: 'error.team.overSize' },
+  { statusText: TeamErrEnum.unAuthTeam, message: '无权操作该团队' }
+];
+export default teamErr.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 500000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${TeamErrEnum}`>);

packages/global/common/error/code/user.ts

@@ -0,0 +1,26 @@
+import { ErrType } from '../errorCode';
+
+/* team: 503000 */
+export enum UserErrEnum {
+  unAuthUser = 'unAuthUser',
+  unAuthRole = 'unAuthRole',
+  binVisitor = 'binVisitor',
+  balanceNotEnough = 'balanceNotEnough'
+}
+const errList = [
+  { statusText: UserErrEnum.unAuthUser, message: '找不到该用户' },
+  { statusText: UserErrEnum.binVisitor, message: '您的身份校验未通过' },
+  { statusText: UserErrEnum.binVisitor, message: '您当前身份为游客，无权操作' },
+  { statusText: UserErrEnum.balanceNotEnough, message: '账号余额不足~' }
+];
+export default errList.reduce((acc, cur, index) => {
+  return {
+    ...acc,
+    [cur.statusText]: {
+      code: 503000 + index,
+      statusText: cur.statusText,
+      message: cur.message,
+      data: null
+    }
+  };
+}, {} as ErrType<`${UserErrEnum}`>);

packages/global/common/error/errorCode.ts

@@ -1,3 +1,12 @@
+import appErr from './code/app';
+import chatErr from './code/chat';
+import datasetErr from './code/dataset';
+import openapiErr from './code/openapi';
+import pluginErr from './code/plugin';
+import outLinkErr from './code/outLink';
+import teamErr from './code/team';
+import userErr from './code/user';
+
 export const ERROR_CODE: { [key: number]: string } = {
   400: '请求失败',
   401: '无权访问',
@@ -27,10 +36,19 @@ export enum ERROR_ENUM {
   insufficientQuota = 'insufficientQuota',
   unAuthModel = 'unAuthModel',
   unAuthApiKey = 'unAuthApiKey',
-  unAuthDataset = 'unAuthDataset',
-  unAuthDatasetCollection = 'unAuthDatasetCollection',
   unAuthFile = 'unAuthFile'
 }
+
+export type ErrType<T> = Record<
+  string,
+  {
+    code: number;
+    statusText: T;
+    message: string;
+    data: null;
+  }
+>;
+
 export const ERROR_RESPONSE: Record<
   any,
   {
@@ -55,15 +73,10 @@ export const ERROR_RESPONSE: Record<
   [ERROR_ENUM.unAuthModel]: {
     code: 511,
     statusText: ERROR_ENUM.unAuthModel,
-    message: '无权使用该模型',
-    data: null
-  },
-  [ERROR_ENUM.unAuthDataset]: {
-    code: 512,
-    statusText: ERROR_ENUM.unAuthDataset,
-    message: '无权使用该知识库',
+    message: '无权操作该模型',
     data: null
   },
+
   [ERROR_ENUM.unAuthFile]: {
     code: 513,
     statusText: ERROR_ENUM.unAuthFile,
@@ -76,10 +89,12 @@ export const ERROR_RESPONSE: Record<
     message: 'Api Key 不合法',
     data: null
   },
-  [ERROR_ENUM.unAuthDatasetCollection]: {
-    code: 515,
-    statusText: ERROR_ENUM.unAuthDatasetCollection,
-    message: '无权使用该知识库文件',
-    data: null
-  }
+  ...appErr,
+  ...chatErr,
+  ...datasetErr,
+  ...openapiErr,
+  ...outLinkErr,
+  ...teamErr,
+  ...userErr,
+  ...pluginErr
 };

packages/global/common/file/api.d.ts

@@ -0,0 +1,8 @@
+export type UrlFetchParams = {
+  urlList: string[];
+  selector?: string;
+};
+export type UrlFetchResponse = {
+  url: string;
+  content: string;
+}[];

packages/global/common/file/constants.ts

@@ -0,0 +1,5 @@
+export enum BucketNameEnum {
+  dataset = 'dataset'
+}
+
+export const FileBaseUrl = '/api/common/file/read';

packages/global/common/file/tools.ts

@@ -1,3 +1,8 @@
+import axios from 'axios';
+import { UrlFetchParams, UrlFetchResponse } from './api.d';
+import { htmlToMarkdown } from '../string/markdown';
+import * as cheerio from 'cheerio';
+
 export const formatFileSize = (bytes: number): string => {
   if (bytes === 0) return '0 B';
 
@@ -7,3 +12,84 @@ export const formatFileSize = (bytes: number): string => {
 
   return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
 };
+
+export const cheerioToHtml = ({
+  fetchUrl,
+  $,
+  selector
+}: {
+  fetchUrl: string;
+  $: cheerio.CheerioAPI;
+  selector?: string;
+}) => {
+  // get origin url
+  const originUrl = new URL(fetchUrl).origin;
+
+  // remove i element
+  $('i,script').remove();
+
+  // remove empty a element
+  $('a')
+    .filter((i, el) => {
+      return $(el).text().trim() === '' && $(el).children().length === 0;
+    })
+    .remove();
+
+  // if link,img startWith /, add origin url
+  $('a').each((i, el) => {
+    const href = $(el).attr('href');
+    if (href && href.startsWith('/')) {
+      $(el).attr('href', originUrl + href);
+    }
+  });
+  $('img').each((i, el) => {
+    const src = $(el).attr('src');
+    if (src && src.startsWith('/')) {
+      $(el).attr('src', originUrl + src);
+    }
+  });
+
+  return $(selector || 'body').html();
+};
+export const urlsFetch = async ({
+  urlList,
+  selector
+}: UrlFetchParams): Promise<UrlFetchResponse> => {
+  urlList = urlList.filter((url) => /^(http|https):\/\/[^ "]+$/.test(url));
+
+  const response = (
+    await Promise.all(
+      urlList.map(async (url) => {
+        try {
+          const fetchRes = await axios.get(url, {
+            timeout: 30000
+          });
+
+          const $ = cheerio.load(fetchRes.data);
+
+          const md = htmlToMarkdown(
+            cheerioToHtml({
+              fetchUrl: url,
+              $,
+              selector
+            })
+          );
+
+          return {
+            url,
+            content: md
+          };
+        } catch (error) {
+          console.log(error, 'fetch error');
+
+          return {
+            url,
+            content: ''
+          };
+        }
+      })
+    )
+  ).filter((item) => item.content);
+
+  return response;
+};

packages/global/common/file/type.d.ts

@@ -0,0 +1,8 @@
+import { BucketNameEnum } from './constants';
+
+export type FileTokenQuery = {
+  bucketName: `${BucketNameEnum}`;
+  teamId: string;
+  tmbId: string;
+  fileId: string;
+};

packages/global/common/plugin/types/pluginRes.d.ts

@@ -1,4 +0,0 @@
-export type FetchResultItem = {
-  url: string;
-  content: string;
-};

packages/global/common/string/markdown.ts

@@ -0,0 +1,97 @@
+import { simpleText } from './tools';
+import { NodeHtmlMarkdown } from 'node-html-markdown';
+
+/* Delete redundant text in markdown */
+export const simpleMarkdownText = (rawText: string) => {
+  rawText = simpleText(rawText);
+
+  // Remove a line feed from a hyperlink or picture
+  rawText = rawText.replace(/\[([^\]]+)\]\((.+?)\)/g, (match, linkText, url) => {
+    const cleanedLinkText = linkText.replace(/\n/g, ' ').trim();
+
+    if (!url) {
+      return '';
+    }
+
+    return `[${cleanedLinkText}](${url})`;
+  });
+
+  // replace special \.* ……
+  const reg1 = /\\([-.!`_(){}\[\]])/g;
+  if (reg1.test(rawText)) {
+    rawText = rawText.replace(/\\([`!*()+-_\[\]{}\\.])/g, '$1');
+  }
+
+  // replace \\n
+  rawText = rawText.replace(/\\\\n/g, '\\n');
+
+  // Remove headings and code blocks front spaces
+  ['####', '###', '##', '#', '```', '~~~'].forEach((item) => {
+    const reg = new RegExp(`\\n\\s*${item}`, 'g');
+    if (reg.test(rawText)) {
+      rawText = rawText.replace(new RegExp(`\\n\\s*(${item})`, 'g'), '\n$1');
+    }
+  });
+
+  return rawText.trim();
+};
+
+/* html string to markdown */
+export const htmlToMarkdown = (html?: string | null) => {
+  if (!html) return '';
+
+  const surround = (source: string, surroundStr: string) => `${surroundStr}${source}${surroundStr}`;
+
+  const nhm = new NodeHtmlMarkdown(
+    {
+      codeFence: '```',
+      codeBlockStyle: 'fenced',
+      ignore: ['i', 'script']
+    },
+    {
+      code: ({ node, parent, options: { codeFence, codeBlockStyle }, visitor }) => {
+        const isCodeBlock = ['PRE', 'WRAPPED-PRE'].includes(parent?.tagName!);
+
+        if (!isCodeBlock) {
+          return {
+            spaceIfRepeatingChar: true,
+            noEscape: true,
+            postprocess: ({ content }) => {
+              // Find longest occurring sequence of running backticks and add one more (so content is escaped)
+              const delimiter =
+                '`' + (content.match(/`+/g)?.sort((a, b) => b.length - a.length)?.[0] || '');
+              const padding = delimiter.length > 1 ? ' ' : '';
+
+              return surround(surround(content, padding), delimiter);
+            }
+          };
+        }
+
+        /* Handle code block */
+        if (codeBlockStyle === 'fenced') {
+          const language =
+            node.getAttribute('class')?.match(/language-(\S+)/)?.[1] ||
+            parent?.getAttribute('class')?.match(/language-(\S+)/)?.[1] ||
+            '';
+
+          return {
+            noEscape: true,
+            prefix: `${codeFence}${language}\n`,
+            postfix: `\n${codeFence}\n`,
+            childTranslators: visitor.instance.codeBlockTranslators
+          };
+        }
+
+        return {
+          noEscape: true,
+          postprocess: ({ content }) => content.replace(/^/gm, '    '),
+          childTranslators: visitor.instance.codeBlockTranslators
+        };
+      }
+    }
+  );
+
+  const markdown = nhm.translate(html).trim();
+
+  return simpleMarkdownText(markdown);
+};

packages/global/common/string/textSplitter.ts

@@ -0,0 +1,228 @@
+import { getErrText } from '../error/utils';
+import { countPromptTokens } from './tiktoken';
+
+/**
+ * text split into chunks
+ * chunkLen - one chunk len. max: 3500
+ * overlapLen - The size of the before and after Text
+ * chunkLen > overlapLen
+ * markdown
+ */
+export const splitText2Chunks = (props: {
+  text: string;
+  chunkLen: number;
+  overlapRatio?: number;
+}): {
+  chunks: string[];
+  tokens: number;
+  overlapRatio?: number;
+} => {
+  let { text = '', chunkLen, overlapRatio = 0.2 } = props;
+  const splitMarker = 'SPLIT_HERE_SPLIT_HERE';
+  const codeBlockMarker = 'CODE_BLOCK_LINE_MARKER';
+  const overlapLen = Math.round(chunkLen * overlapRatio);
+
+  // replace code block all \n to codeBlockMarker
+  text = text.replace(/(```[\s\S]*?```|~~~[\s\S]*?~~~)/g, function (match) {
+    return match.replace(/\n/g, codeBlockMarker);
+  });
+
+  // The larger maxLen is, the next sentence is less likely to trigger splitting
+  const stepReges: { reg: RegExp; maxLen: number }[] = [
+    { reg: /^(#\s[^\n]+)\n/gm, maxLen: chunkLen * 1.4 },
+    { reg: /^(##\s[^\n]+)\n/gm, maxLen: chunkLen * 1.4 },
+    { reg: /^(###\s[^\n]+)\n/gm, maxLen: chunkLen * 1.4 },
+    { reg: /^(####\s[^\n]+)\n/gm, maxLen: chunkLen * 1.4 },
+
+    { reg: /([\n](`))/g, maxLen: chunkLen * 4 }, // code block
+    { reg: /([\n](?![\*\-|>0-9]))/g, maxLen: chunkLen * 1.8 }, // (?![\*\-|>`0-9]): markdown special char
+    { reg: /([\n])/g, maxLen: chunkLen * 1.4 },
+
+    { reg: /([。]|([a-zA-Z])\.\s)/g, maxLen: chunkLen * 1.4 },
+    { reg: /([！]|!\s)/g, maxLen: chunkLen * 1.4 },
+    { reg: /([？]|\?\s)/g, maxLen: chunkLen * 1.6 },
+    { reg: /([；]|;\s)/g, maxLen: chunkLen * 1.8 },
+    { reg: /([，]|,\s)/g, maxLen: chunkLen * 2 }
+  ];
+
+  // if use markdown title split, Separate record title title
+  const getSplitTexts = ({ text, step }: { text: string; step: number }) => {
+    if (step >= stepReges.length) {
+      return [
+        {
+          text,
+          title: ''
+        }
+      ];
+    }
+    const isMarkdownSplit = step <= 3;
+    const { reg } = stepReges[step];
+
+    const splitTexts = text
+      .replace(reg, isMarkdownSplit ? `${splitMarker}$1` : `$1${splitMarker}`)
+      .split(`${splitMarker}`)
+      .filter((part) => part.trim());
+
+    return splitTexts
+      .map((text) => {
+        const matchTitle = isMarkdownSplit ? text.match(reg)?.[0] || '' : '';
+
+        return {
+          text: isMarkdownSplit ? text.replace(matchTitle, '') : text,
+          title: matchTitle
+        };
+      })
+      .filter((item) => item.text.trim());
+  };
+
+  const getOneTextOverlapText = ({ text, step }: { text: string; step: number }): string => {
+    const forbidOverlap = step <= 6;
+    const maxOverlapLen = chunkLen * 0.4;
+
+    // step >= stepReges.length: Do not overlap incomplete sentences
+    if (forbidOverlap || overlapLen === 0 || step >= stepReges.length) return '';
+
+    const splitTexts = getSplitTexts({ text, step });
+    let overlayText = '';
+
+    for (let i = splitTexts.length - 1; i >= 0; i--) {
+      const currentText = splitTexts[i].text;
+      const newText = currentText + overlayText;
+      const newTextLen = newText.length;
+
+      if (newTextLen > overlapLen) {
+        if (newTextLen > maxOverlapLen) {
+          const text = getOneTextOverlapText({ text: newText, step: step + 1 });
+          return text || overlayText;
+        }
+        return newText;
+      }
+
+      overlayText = newText;
+    }
+    return overlayText;
+  };
+
+  const splitTextRecursively = ({
+    text = '',
+    step,
+    lastText,
+    mdTitle = ''
+  }: {
+    text: string;
+    step: number;
+    lastText: string;
+    mdTitle: string;
+  }): string[] => {
+    const isMarkdownSplit = step <= 3;
+
+    // mini text
+    if (text.length <= chunkLen) {
+      return [text];
+    }
+
+    // oversize
+    if (step >= stepReges.length) {
+      if (text.length < chunkLen * 3) {
+        return [text];
+      }
+      // use slice-chunkLen to split text
+      const chunks: string[] = [];
+      for (let i = 0; i < text.length; i += chunkLen - overlapLen) {
+        chunks.push(`${mdTitle}${text.slice(i, i + chunkLen)}`);
+      }
+      return chunks;
+    }
+
+    const { maxLen } = stepReges[step];
+    const minChunkLen = chunkLen * 0.7;
+
+    // split text by special char
+    const splitTexts = getSplitTexts({ text, step });
+
+    const chunks: string[] = [];
+    for (let i = 0; i < splitTexts.length; i++) {
+      const item = splitTexts[i];
+      const currentTitle = `${mdTitle}${item.title}`;
+
+      const currentText = item.text;
+      const currentTextLen = currentText.length;
+      const lastTextLen = lastText.length;
+      const newText = lastText + currentText;
+      const newTextLen = lastTextLen + currentTextLen;
+
+      // newText is too large(now, The lastText must be smaller than chunkLen)
+      if (newTextLen > maxLen) {
+        // lastText greater minChunkLen, direct push it to chunks, not add to next chunk. (large lastText)
+        if (lastTextLen > minChunkLen) {
+          chunks.push(`${currentTitle}${lastText}`);
+          lastText = getOneTextOverlapText({ text: lastText, step }); // next chunk will start with overlayText
+          i--;
+
+          continue;
+        }
+
+        // split new Text, split chunks must will greater 1 (small lastText)
+        const innerChunks = splitTextRecursively({
+          text: newText,
+          step: step + 1,
+          lastText: '',
+          mdTitle: currentTitle
+        });
+        const lastChunk = innerChunks[innerChunks.length - 1];
+        // last chunk is too small, concat it to lastText
+        if (!isMarkdownSplit && lastChunk.length < minChunkLen) {
+          chunks.push(...innerChunks.slice(0, -1));
+          lastText = lastChunk;
+        } else {
+          chunks.push(...innerChunks);
+          // compute new overlapText
+          lastText = getOneTextOverlapText({
+            text: lastChunk,
+            step
+          });
+        }
+        continue;
+      }
+
+      // size less than chunkLen, push text to last chunk. now, text definitely less than maxLen
+      lastText = newText;
+
+      // markdown paragraph block: Direct addition; If the chunk size reaches, add a chunk
+      if (isMarkdownSplit || newTextLen >= chunkLen) {
+        chunks.push(`${currentTitle}${lastText}`);
+
+        lastText = isMarkdownSplit ? '' : getOneTextOverlapText({ text: lastText, step });
+      }
+    }
+
+    /* If the last chunk is independent, it needs to be push chunks. */
+    if (lastText && chunks[chunks.length - 1] && !chunks[chunks.length - 1].endsWith(lastText)) {
+      if (lastText.length < chunkLen * 0.4) {
+        chunks[chunks.length - 1] = chunks[chunks.length - 1] + lastText;
+      } else {
+        chunks.push(`${mdTitle}${lastText}`);
+      }
+    }
+
+    return chunks;
+  };
+
+  try {
+    const chunks = splitTextRecursively({
+      text,
+      step: 0,
+      lastText: '',
+      mdTitle: ''
+    }).map((chunk) => chunk.replaceAll(codeBlockMarker, '\n')); // restore code block
+
+    const tokens = chunks.reduce((sum, chunk) => sum + countPromptTokens(chunk, 'system'), 0);
+
+    return {
+      chunks,
+      tokens
+    };
+  } catch (err) {
+    throw new Error(getErrText(err));
+  }
+};

packages/global/common/string/tiktoken/index.ts

@@ -1,8 +1,8 @@
 /* Only the token of gpt-3.5-turbo is used */
-import { ChatItemType } from '@/types/chat';
+import type { ChatItemType } from '../../../core/chat/type';
 import { Tiktoken } from 'js-tiktoken/lite';
-import { adaptChat2GptMessages } from '@/utils/common/adapt/message';
-import { ChatCompletionRequestMessageRoleEnum } from '@fastgpt/global/core/ai/constant';
+import { adaptChat2GptMessages } from '../../../core/chat/adapt';
+import { ChatCompletionRequestMessageRoleEnum } from '../../../core/ai/constant';
 import encodingJson from './cl100k_base.json';
 
 /* init tikToken obj */
@@ -55,17 +55,6 @@ export function countMessagesTokens({ messages }: { messages: ChatItemType[] })
   return totalTokens;
 }
 
-export function sliceTextByTokens({ text, length }: { text: string; length: number }) {
-  const enc = getTikTokenEnc();
-
-  try {
-    const encodeText = enc.encode(text);
-    return enc.decode(encodeText.slice(0, length));
-  } catch (error) {
-    return text.slice(0, length);
-  }
-}
-
 /* slice messages from top to bottom by maxTokens */
 export function sliceMessagesTB({
   messages,

packages/global/common/string/tiktoken/type.d.ts

@@ -0,0 +1,5 @@
+import type { Tiktoken } from 'js-tiktoken';
+
+declare global {
+  var TikToken: Tiktoken;
+}

packages/global/common/string/time.ts

@@ -0,0 +1,3 @@
+import dayjs from 'dayjs';
+
+export const formatTime2YMDHM = (time: Date) => dayjs(time).format('YYYY-MM-DD HH:mm');

packages/global/common/string/tools.ts

@@ -1,17 +1,20 @@
 import crypto from 'crypto';
 
+/* check string is a web link */
 export function strIsLink(str?: string) {
   if (!str) return false;
   if (/^((http|https)?:\/\/|www\.|\/)[^\s/$.?#].[^\s]*$/i.test(str)) return true;
   return false;
 }
 
-export const hashStr = (psw: string) => {
-  return crypto.createHash('sha256').update(psw).digest('hex');
+/* hash string */
+export const hashStr = (str: string) => {
+  return crypto.createHash('sha256').update(str).digest('hex');
 };
 
 /* simple text, remove chinese space and extra \n */
-export const simpleText = (text: string) => {
+export const simpleText = (text = '') => {
+  text = text.trim();
   text = text.replace(/([\u4e00-\u9fa5])[\s&&[^\n]]+([\u4e00-\u9fa5])/g, '$1$2');
   text = text.replace(/\r\n|\r/g, '\n');
   text = text.replace(/\n{3,}/g, '\n\n');
@@ -20,3 +23,16 @@ export const simpleText = (text: string) => {
 
   return text;
 };
+
+/* 
+  replace {{variable}} to value
+*/
+export function replaceVariable(text: string, obj: Record<string, string | number>) {
+  for (const key in obj) {
+    const val = obj[key];
+    if (!['string', 'number'].includes(typeof val)) continue;
+
+    text = text.replace(new RegExp(`{{(${key})}}`, 'g'), String(val));
+  }
+  return text || '';
+}

packages/global/common/system/types/index.d.ts

@@ -2,17 +2,15 @@ export type FeConfigsType = {
   show_emptyChat?: boolean;
   show_register?: boolean;
   show_appStore?: boolean;
-  show_contact?: boolean;
   show_git?: boolean;
-  show_doc?: boolean;
   show_pay?: boolean;
   show_openai_account?: boolean;
   show_promotion?: boolean;
   hide_app_flow?: boolean;
+  concatMd?: string;
   docUrl?: string;
   openAPIDocUrl?: string;
   systemTitle?: string;
-  authorText?: string;
   googleClientVerKey?: string;
   isPlus?: boolean;
   oauth?: {
@@ -23,6 +21,7 @@ export type FeConfigsType = {
     exportLimitMinutes?: number;
   };
   scripts?: { [key: string]: string }[];
+  favicon?: string;
 };
 
 export type SystemEnvType = {

packages/global/common/system/utils.ts

@@ -0,0 +1,6 @@
+export const delay = (ms: number) =>
+  new Promise((resolve) => {
+    setTimeout(() => {
+      resolve('');
+    }, ms);
+  });

packages/global/core/ai/api.d.ts

@@ -0,0 +1,5 @@
+export type PostReRankProps = {
+  query: string;
+  inputs: { id: string; text: string }[];
+};
+export type PostReRankResponse = { id: string; score?: number }[];

packages/global/core/ai/constant.ts

@@ -2,5 +2,6 @@ export enum ChatCompletionRequestMessageRoleEnum {
   'System' = 'system',
   'User' = 'user',
   'Assistant' = 'assistant',
-  'Function' = 'function'
+  'Function' = 'function',
+  'Tool' = 'tool'
 }

packages/global/core/ai/index.ts

@@ -0,0 +1,2 @@
+import OpenAI from 'openai';
+export default OpenAI;

packages/global/core/ai/model.d.ts

@@ -1,15 +1,15 @@
-import { LLMModelUsageEnum } from '@/constants/model';
-
 export type LLMModelItemType = {
   model: string;
   name: string;
-  maxToken: number;
+  maxContext: number;
+  maxResponse: number;
   price: number;
 };
 export type ChatModelItemType = LLMModelItemType & {
   quoteMaxToken: number;
   maxTemperature: number;
   censor?: boolean;
+  vision?: boolean;
   defaultSystemChatPrompt?: string;
 };
 
@@ -25,3 +25,24 @@ export type VectorModelItemType = {
   price: number;
   maxToken: number;
 };
+
+export type ReRankModelItemType = {
+  model: string;
+  name: string;
+  price: number;
+  requestUrl?: string;
+  requestAuth?: string;
+};
+
+export type AudioSpeechModelType = {
+  model: string;
+  name: string;
+  price: number;
+  voices: { label: string; value: string; bufferId: string }[];
+};
+
+export type WhisperModelType = {
+  model: string;
+  name: string;
+  price: number;
+};

packages/global/core/ai/model.ts

@@ -0,0 +1,143 @@
+import type {
+  LLMModelItemType,
+  ChatModelItemType,
+  FunctionModelItemType,
+  VectorModelItemType,
+  AudioSpeechModelType,
+  WhisperModelType,
+  ReRankModelItemType
+} from './model.d';
+
+export const defaultChatModels: ChatModelItemType[] = [
+  {
+    model: 'gpt-3.5-turbo-1106',
+    name: 'GPT35-1106',
+    price: 0,
+    maxContext: 16000,
+    maxResponse: 4000,
+    quoteMaxToken: 2000,
+    maxTemperature: 1.2,
+    censor: false,
+    vision: false,
+    defaultSystemChatPrompt: ''
+  },
+  {
+    model: 'gpt-3.5-turbo-16k',
+    name: 'GPT35-16k',
+    maxContext: 16000,
+    maxResponse: 16000,
+    price: 0,
+    quoteMaxToken: 8000,
+    maxTemperature: 1.2,
+    censor: false,
+    vision: false,
+    defaultSystemChatPrompt: ''
+  },
+  {
+    model: 'gpt-4',
+    name: 'GPT4-8k',
+    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: ''
+  }
+];
+export const defaultQAModels: LLMModelItemType[] = [
+  {
+    model: 'gpt-3.5-turbo-16k',
+    name: 'GPT35-16k',
+    maxContext: 16000,
+    maxResponse: 16000,
+    price: 0
+  }
+];
+export const defaultCQModels: FunctionModelItemType[] = [
+  {
+    model: 'gpt-3.5-turbo-1106',
+    name: 'GPT35-1106',
+    maxContext: 16000,
+    maxResponse: 4000,
+    price: 0,
+    functionCall: true,
+    functionPrompt: ''
+  },
+  {
+    model: 'gpt-4',
+    name: 'GPT4-8k',
+    maxContext: 8000,
+    maxResponse: 8000,
+    price: 0,
+    functionCall: true,
+    functionPrompt: ''
+  }
+];
+export const defaultExtractModels: FunctionModelItemType[] = [
+  {
+    model: 'gpt-3.5-turbo-1106',
+    name: 'GPT35-1106',
+    maxContext: 16000,
+    maxResponse: 4000,
+    price: 0,
+    functionCall: true,
+    functionPrompt: ''
+  }
+];
+export const defaultQGModels: LLMModelItemType[] = [
+  {
+    model: 'gpt-3.5-turbo-1106',
+    name: 'GPT35-1106',
+    maxContext: 1600,
+    maxResponse: 4000,
+    price: 0
+  }
+];
+
+export const defaultVectorModels: VectorModelItemType[] = [
+  {
+    model: 'text-embedding-ada-002',
+    name: 'Embedding-2',
+    price: 0,
+    defaultToken: 500,
+    maxToken: 3000
+  }
+];
+
+export const defaultReRankModels: ReRankModelItemType[] = [];
+
+export const defaultAudioSpeechModels: AudioSpeechModelType[] = [
+  {
+    model: 'tts-1',
+    name: 'OpenAI TTS1',
+    price: 0,
+    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' }
+    ]
+  }
+];
+
+export const defaultWhisperModel: WhisperModelType = {
+  model: 'whisper-1',
+  name: 'Whisper1',
+  price: 0
+};

packages/global/core/ai/type.d.ts

@@ -1,9 +1,21 @@
-import OpenAI from 'openai';
-export type ChatCompletionRequestMessage = OpenAI.Chat.CreateChatCompletionRequestMessage;
-export type ChatCompletion = OpenAI.Chat.ChatCompletion;
-export type CreateChatCompletionRequest = OpenAI.Chat.ChatCompletionCreateParams;
+import type {
+  ChatCompletion,
+  ChatCompletionCreateParams,
+  ChatCompletionChunk,
+  ChatCompletionMessageParam,
+  ChatCompletionContentPart
+} from 'openai/resources';
 
-export type StreamChatType = Stream<OpenAI.Chat.ChatCompletionChunk>;
+export type ChatCompletionContentPart = ChatCompletionContentPart;
+export type ChatCompletionCreateParams = ChatCompletionCreateParams;
+export type ChatMessageItemType = Omit<ChatCompletionMessageParam, 'name'> & {
+  name?: any;
+  dataId?: string;
+  content: any;
+} & any;
+
+export type ChatCompletion = ChatCompletion;
+export type StreamChatType = Stream<ChatCompletionChunk>;
 
 export type PromptTemplateItem = {
   title: string;

packages/global/core/app/api.d.ts

@@ -0,0 +1,26 @@
+import type { ChatModelItemType } from '../ai/model.d';
+import { AppTypeEnum } from './constants';
+import { AppSchema, AppSimpleEditFormType } from './type';
+
+export type CreateAppParams = {
+  name?: string;
+  avatar?: string;
+  type?: `${AppTypeEnum}`;
+  modules: AppSchema['modules'];
+};
+
+export interface AppUpdateParams {
+  name?: string;
+  type?: `${AppTypeEnum}`;
+  simpleTemplateId?: string;
+  avatar?: string;
+  intro?: string;
+  modules?: AppSchema['modules'];
+  permission?: AppSchema['permission'];
+}
+
+export type FormatForm2ModulesProps = {
+  formData: AppSimpleEditFormType;
+  chatModelMaxToken: number;
+  chatModelList: ChatModelItemType[];
+};

packages/global/core/app/constants.ts

@@ -0,0 +1,12 @@
+export enum AppTypeEnum {
+  simple = 'simple',
+  advanced = 'advanced'
+}
+export const AppTypeMap = {
+  [AppTypeEnum.simple]: {
+    label: 'simple'
+  },
+  [AppTypeEnum.advanced]: {
+    label: 'advanced'
+  }
+};

packages/global/core/app/type.d.ts

@@ -0,0 +1,121 @@
+import type { AppTTSConfigType, ModuleItemType, VariableItemType } from '../module/type.d';
+import { AppTypeEnum } from './constants';
+import { PermissionTypeEnum } from '../../support/permission/constant';
+import type { AIChatModuleProps, DatasetModuleProps } from '../module/node/type.d';
+import { VariableInputEnum } from '../module/constants';
+import { SelectedDatasetType } from '../module/api';
+import { DatasetSearchModeEnum } from '../dataset/constant';
+
+export interface AppSchema {
+  _id: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  name: string;
+  type: `${AppTypeEnum}`;
+  simpleTemplateId: string;
+  avatar: string;
+  intro: string;
+  updateTime: number;
+  modules: ModuleItemType[];
+  permission: `${PermissionTypeEnum}`;
+  inited?: boolean;
+}
+
+export type AppListItemType = {
+  _id: string;
+  name: string;
+  avatar: string;
+  intro: string;
+  isOwner: boolean;
+  permission: `${PermissionTypeEnum}`;
+};
+
+export type AppDetailType = AppSchema & {
+  isOwner: boolean;
+  canWrite: boolean;
+};
+
+// export type AppSimpleEditFormType = {
+//   aiSettings: AIChatModuleProps;
+//   dataset: DatasetModuleProps & {
+//     searchEmptyText: string;
+//   };
+//   userGuide: {
+//     welcomeText: string;
+//     variables: VariableItemType[];
+//     questionGuide: boolean;
+//     tts: AppTTSConfigType;
+//   };
+// };
+// Since useform cannot infer enumeration types, all enumeration keys can only be undone manually
+export type AppSimpleEditFormType = {
+  templateId: string;
+  aiSettings: {
+    model: string;
+    systemPrompt?: string | undefined;
+    temperature: number;
+    maxToken: number;
+    isResponseAnswerText: boolean;
+    quoteTemplate?: string | undefined;
+    quotePrompt?: string | undefined;
+  };
+  dataset: {
+    datasets: SelectedDatasetType;
+    similarity: number;
+    limit: number;
+    searchMode: `${DatasetSearchModeEnum}`;
+    searchEmptyText: string;
+  };
+  userGuide: {
+    welcomeText: string;
+    variables: {
+      id: string;
+      key: string;
+      label: string;
+      type: `${VariableInputEnum}`;
+      required: boolean;
+      maxLen: number;
+      enums: {
+        value: string;
+      }[];
+    }[];
+    questionGuide: boolean;
+    tts: {
+      type: 'none' | 'web' | 'model';
+      model?: string | undefined;
+      voice?: string | undefined;
+      speed?: number | undefined;
+    };
+  };
+};
+
+/* simple mode template*/
+export type AppSimpleEditConfigTemplateType = {
+  id: string;
+  name: string;
+  desc: string;
+  systemForm: {
+    aiSettings?: {
+      model?: boolean;
+      systemPrompt?: boolean;
+      temperature?: boolean;
+      maxToken?: boolean;
+      quoteTemplate?: boolean;
+      quotePrompt?: boolean;
+    };
+    dataset?: {
+      datasets?: boolean;
+      similarity?: boolean;
+      limit?: boolean;
+      searchMode: `${DatasetSearchModeEnum}`;
+      searchEmptyText?: boolean;
+    };
+    userGuide?: {
+      welcomeText?: boolean;
+      variables?: boolean;
+      questionGuide?: boolean;
+      tts?: boolean;
+    };
+  };
+};

packages/global/core/app/utils.ts

@@ -0,0 +1,123 @@
+import type { AppSimpleEditFormType } from '../app/type';
+import { FlowNodeTypeEnum } from '../module/node/constant';
+import { ModuleOutputKeyEnum, ModuleInputKeyEnum } from '../module/constants';
+import type { FlowNodeInputItemType } from '../module/node/type.d';
+import { getGuideModule, splitGuideModule } from '../module/utils';
+import { defaultChatModels } from '../ai/model';
+import { ModuleItemType } from '../module/type.d';
+import { DatasetSearchModeEnum } from '../dataset/constant';
+
+export const getDefaultAppForm = (templateId = 'fastgpt-universal'): AppSimpleEditFormType => {
+  const defaultChatModel = defaultChatModels[0];
+
+  return {
+    templateId,
+    aiSettings: {
+      model: defaultChatModel?.model,
+      systemPrompt: '',
+      temperature: 0,
+      isResponseAnswerText: true,
+      quotePrompt: '',
+      quoteTemplate: '',
+      maxToken: defaultChatModel ? defaultChatModel.maxResponse / 2 : 4000
+    },
+    dataset: {
+      datasets: [],
+      similarity: 0.4,
+      limit: 5,
+      searchEmptyText: '',
+      searchMode: DatasetSearchModeEnum.embedding
+    },
+    userGuide: {
+      welcomeText: '',
+      variables: [],
+      questionGuide: false,
+      tts: {
+        type: 'web'
+      }
+    }
+  };
+};
+
+/* format app modules to edit form */
+export const appModules2Form = ({
+  templateId,
+  modules
+}: {
+  modules: ModuleItemType[];
+  templateId: string;
+}) => {
+  const defaultAppForm = getDefaultAppForm(templateId);
+
+  const findInputValueByKey = (inputs: FlowNodeInputItemType[], key: string) => {
+    return inputs.find((item) => item.key === key)?.value;
+  };
+
+  modules.forEach((module) => {
+    if (module.flowType === FlowNodeTypeEnum.chatNode) {
+      defaultAppForm.aiSettings.model = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.aiModel
+      );
+      defaultAppForm.aiSettings.systemPrompt = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.aiSystemPrompt
+      );
+      defaultAppForm.aiSettings.temperature = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.aiChatTemperature
+      );
+      defaultAppForm.aiSettings.maxToken = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.aiChatMaxToken
+      );
+      defaultAppForm.aiSettings.quoteTemplate = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.aiChatQuoteTemplate
+      );
+      defaultAppForm.aiSettings.quotePrompt = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.aiChatQuotePrompt
+      );
+    } else if (module.flowType === FlowNodeTypeEnum.datasetSearchNode) {
+      defaultAppForm.dataset.datasets = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.datasetSelectList
+      );
+      defaultAppForm.dataset.similarity = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.datasetSimilarity
+      );
+      defaultAppForm.dataset.limit = findInputValueByKey(
+        module.inputs,
+        ModuleInputKeyEnum.datasetLimit
+      );
+      defaultAppForm.dataset.searchMode =
+        findInputValueByKey(module.inputs, ModuleInputKeyEnum.datasetSearchMode) ||
+        DatasetSearchModeEnum.embedding;
+
+      // empty text
+      const emptyOutputs =
+        module.outputs.find((item) => item.key === ModuleOutputKeyEnum.datasetIsEmpty)?.targets ||
+        [];
+      const emptyOutput = emptyOutputs[0];
+      if (emptyOutput) {
+        const target = modules.find((item) => item.moduleId === emptyOutput.moduleId);
+        defaultAppForm.dataset.searchEmptyText =
+          target?.inputs?.find((item) => item.key === ModuleInputKeyEnum.answerText)?.value || '';
+      }
+    } else if (module.flowType === FlowNodeTypeEnum.userGuide) {
+      const { welcomeText, variableModules, questionGuide, ttsConfig } = splitGuideModule(
+        getGuideModule(modules)
+      );
+      defaultAppForm.userGuide = {
+        welcomeText: welcomeText,
+        variables: variableModules,
+        questionGuide: questionGuide,
+        tts: ttsConfig
+      };
+    }
+  });
+
+  return defaultAppForm;
+};

packages/global/core/chat/adapt.ts

@@ -1,18 +1,21 @@
-import type { ChatItemType } from '@/types/chat';
-import { ChatRoleEnum } from '@/constants/chat';
-import { ChatCompletionRequestMessageRoleEnum } from '@fastgpt/global/core/ai/constant';
-import type { MessageItemType } from '@/types/core/chat/type';
+import type { ChatItemType } from '../../core/chat/type.d';
+import { ChatRoleEnum } from '../../core/chat/constants';
+import { ChatCompletionRequestMessageRoleEnum } from '../../core/ai/constant';
+import type { ChatMessageItemType } from '../../core/ai/type.d';
 
 const chat2Message = {
   [ChatRoleEnum.AI]: ChatCompletionRequestMessageRoleEnum.Assistant,
   [ChatRoleEnum.Human]: ChatCompletionRequestMessageRoleEnum.User,
-  [ChatRoleEnum.System]: ChatCompletionRequestMessageRoleEnum.System
+  [ChatRoleEnum.System]: ChatCompletionRequestMessageRoleEnum.System,
+  [ChatRoleEnum.Function]: ChatCompletionRequestMessageRoleEnum.Function,
+  [ChatRoleEnum.Tool]: ChatCompletionRequestMessageRoleEnum.Tool
 };
 const message2Chat = {
   [ChatCompletionRequestMessageRoleEnum.System]: ChatRoleEnum.System,
   [ChatCompletionRequestMessageRoleEnum.User]: ChatRoleEnum.Human,
   [ChatCompletionRequestMessageRoleEnum.Assistant]: ChatRoleEnum.AI,
-  [ChatCompletionRequestMessageRoleEnum.Function]: 'function'
+  [ChatCompletionRequestMessageRoleEnum.Function]: ChatRoleEnum.Function,
+  [ChatCompletionRequestMessageRoleEnum.Tool]: ChatRoleEnum.Tool
 };
 
 export function adaptRole_Chat2Message(role: `${ChatRoleEnum}`) {
@@ -28,10 +31,10 @@ export const adaptChat2GptMessages = ({
 }: {
   messages: ChatItemType[];
   reserveId: boolean;
-}): MessageItemType[] => {
+}): ChatMessageItemType[] => {
   return messages.map((item) => ({
     ...(reserveId && { dataId: item.dataId }),
-    role: chat2Message[item.obj] || ChatCompletionRequestMessageRoleEnum.System,
+    role: chat2Message[item.obj],
     content: item.value || ''
   }));
 };

packages/global/core/chat/api.d.ts

@@ -0,0 +1,33 @@
+import { ModuleItemType } from '../module/type';
+import { AdminFbkType, ChatItemType, moduleDispatchResType } from './type';
+
+export type UpdateHistoryProps = {
+  chatId: string;
+  customTitle?: string;
+  top?: boolean;
+};
+
+export type AdminUpdateFeedbackParams = AdminFbkType & {
+  chatItemId: string;
+};
+
+export type InitChatResponse = {
+  chatId: string;
+  appId: string;
+  app: {
+    userGuideModule?: ModuleItemType;
+    chatModels?: string[];
+    name: string;
+    avatar: string;
+    intro: string;
+    canUse?: boolean;
+  };
+  title: string;
+  variables: Record<string, any>;
+  history: ChatItemType[];
+};
+
+export type ChatHistoryItemResType = moduleDispatchResType & {
+  moduleType: `${FlowNodeTypeEnum}`;
+  moduleName: string;
+};

packages/global/core/chat/constants.ts

@@ -1,24 +1,10 @@
-import dayjs from 'dayjs';
-
-export enum sseResponseEventEnum {
-  error = 'error',
-  answer = 'answer',
-  moduleStatus = 'moduleStatus',
-  appStreamResponse = 'appStreamResponse' // sse response request
-}
-
 export enum ChatRoleEnum {
   System = 'System',
   Human = 'Human',
-  AI = 'AI'
+  AI = 'AI',
+  Function = 'Function',
+  Tool = 'Tool'
 }
-
-export enum TaskResponseKeyEnum {
-  'answerText' = 'answerText', //  answer module text key
-  'responseData' = 'responseData',
-  'history' = 'history'
-}
-
 export const ChatRoleMap = {
   [ChatRoleEnum.System]: {
     name: '系统提示词'
@@ -28,6 +14,12 @@ export const ChatRoleMap = {
   },
   [ChatRoleEnum.AI]: {
     name: 'AI'
+  },
+  [ChatRoleEnum.Function]: {
+    name: 'Function'
+  },
+  [ChatRoleEnum.Tool]: {
+    name: 'Tool'
   }
 };
 
@@ -37,7 +29,6 @@ export enum ChatSourceEnum {
   share = 'share',
   api = 'api'
 }
-
 export const ChatSourceMap = {
   [ChatSourceEnum.test]: {
     name: 'chat.logs.test'
@@ -55,3 +46,6 @@ export const ChatSourceMap = {
 
 export const HUMAN_ICON = `/icon/human.svg`;
 export const LOGO_ICON = `/icon/logo.svg`;
+
+export const IMG_BLOCK_KEY = 'img-block';
+export const FILE_BLOCK_KEY = 'file-block';

packages/global/core/chat/type.d.ts

@@ -0,0 +1,114 @@
+import { ClassifyQuestionAgentItemType } from '../module/type';
+import { SearchDataResponseItemType } from '../dataset/type';
+import { ChatRoleEnum, ChatSourceEnum } from './constants';
+import { FlowNodeTypeEnum } from '../module/node/constant';
+import { ModuleOutputKeyEnum } from '../module/constants';
+import { AppSchema } from '../app/type';
+import { DatasetSearchModeEnum } from '../dataset/constant';
+
+export type ChatSchema = {
+  _id: string;
+  chatId: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  appId: string;
+  updateTime: Date;
+  title: string;
+  customTitle: string;
+  top: boolean;
+  variables: Record<string, any>;
+  source: `${ChatSourceEnum}`;
+  shareId?: string;
+  isInit: boolean;
+  content: ChatItemType[];
+};
+
+export type ChatWithAppSchema = Omit<ChatSchema, 'appId'> & {
+  appId: AppSchema;
+};
+
+export type ChatItemSchema = {
+  dataId: string;
+  chatId: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  appId: string;
+  time: Date;
+  obj: `${ChatRoleEnum}`;
+  value: string;
+  userFeedback?: string;
+  adminFeedback?: AdminFbkType;
+  [ModuleOutputKeyEnum.responseData]?: ChatHistoryItemResType[];
+};
+
+export type AdminFbkType = {
+  dataId: string;
+  datasetId: string;
+  collectionId: string;
+  q: string;
+  a?: string;
+};
+
+export type ChatItemType = {
+  dataId?: string;
+  obj: ChatItemSchema['obj'];
+  value: any;
+  userFeedback?: string;
+  adminFeedback?: ChatItemSchema['feedback'];
+  [ModuleOutputKeyEnum.responseData]?: ChatHistoryItemResType[];
+};
+
+export type ChatSiteItemType = ChatItemType & {
+  status: 'loading' | 'running' | 'finish';
+  moduleName?: string;
+  ttsBuffer?: Uint8Array;
+};
+
+export type HistoryItemType = {
+  chatId: string;
+  updateTime: Date;
+  customTitle?: string;
+  title: string;
+};
+export type ChatHistoryItemType = HistoryItemType & {
+  appId: string;
+  top: boolean;
+};
+
+// response data
+export type moduleDispatchResType = {
+  moduleLogo?: string;
+  price: number;
+  runningTime?: number;
+  tokens?: number;
+  model?: string;
+  query?: string;
+
+  // chat
+  temperature?: number;
+  maxToken?: number;
+  quoteList?: SearchDataResponseItemType[];
+  historyPreview?: ChatItemType[]; // completion context array. history will slice
+
+  // dataset search
+  similarity?: number;
+  limit?: number;
+  searchMode?: `${DatasetSearchModeEnum}`;
+
+  // cq
+  cqList?: ClassifyQuestionAgentItemType[];
+  cqResult?: string;
+
+  // content extract
+  extractDescription?: string;
+  extractResult?: Record<string, any>;
+
+  // http
+  body?: Record<string, any>;
+  httpResult?: Record<string, any>;
+
+  // plugin output
+  pluginOutput?: Record<string, any>;
+};

packages/global/core/chat/utils.ts

@@ -0,0 +1,6 @@
+import { IMG_BLOCK_KEY, FILE_BLOCK_KEY } from './constants';
+
+export function chatContentReplaceBlock(content: string = '') {
+  const regex = new RegExp(`\`\`\`(${IMG_BLOCK_KEY})\\n([\\s\\S]*?)\`\`\``, 'g');
+  return content.replace(regex, '').trim();
+}

packages/global/core/dataset/api.d.ts

@@ -0,0 +1,49 @@
+import { DatasetDataIndexItemType, DatasetSchemaType } from './type';
+import { DatasetCollectionTrainingModeEnum, DatasetCollectionTypeEnum } from './constant';
+import type { LLMModelItemType } from '../ai/model.d';
+
+/* ================= dataset ===================== */
+export type DatasetUpdateBody = {
+  id: string;
+  parentId?: string;
+  tags?: string[];
+  name?: string;
+  avatar?: string;
+  permission?: DatasetSchemaType['permission'];
+  agentModel?: LLMModelItemType;
+  websiteConfig?: DatasetSchemaType['websiteConfig'];
+  status?: DatasetSchemaType['status'];
+};
+
+/* ================= collection ===================== */
+export type CreateDatasetCollectionParams = {
+  datasetId: string;
+  parentId?: string;
+  name: string;
+  type: `${DatasetCollectionTypeEnum}`;
+  trainingType?: `${DatasetCollectionTrainingModeEnum}`;
+  chunkSize?: number;
+  fileId?: string;
+  rawLink?: string;
+  metadata?: Record<string, any>;
+};
+
+/* ================= data ===================== */
+export type PgSearchRawType = {
+  id: string;
+  team_id: string;
+  tmb_id: string;
+  collection_id: string;
+  data_id: string;
+  score: number;
+};
+export type PushDatasetDataChunkProps = {
+  q: string; // embedding content
+  a?: string; // bonus content
+  indexes?: Omit<DatasetDataIndexItemType, 'dataId'>[];
+};
+
+export type PostWebsiteSyncParams = {
+  datasetId: string;
+  billId: string;
+};

packages/global/core/dataset/constant.ts

@@ -1,62 +1,147 @@
+export const PgDatasetTableName = 'modeldata';
+
+/* ------------ dataset -------------- */
 export enum DatasetTypeEnum {
   folder = 'folder',
-  dataset = 'dataset'
+  dataset = 'dataset',
+  websiteDataset = 'websiteDataset' // depp link
 }
-
 export const DatasetTypeMap = {
   [DatasetTypeEnum.folder]: {
-    name: 'folder'
+    icon: 'core/dataset/folderDataset',
+    label: 'core.dataset.Folder Dataset',
+    collectionLabel: 'common.Folder'
   },
   [DatasetTypeEnum.dataset]: {
-    name: 'dataset'
+    icon: 'core/dataset/commonDataset',
+    label: 'core.dataset.Common Dataset',
+    collectionLabel: 'common.File'
+  },
+  [DatasetTypeEnum.websiteDataset]: {
+    icon: 'core/dataset/websiteDataset',
+    label: 'core.dataset.Website Dataset',
+    collectionLabel: 'common.Website'
   }
 };
 
+export enum DatasetStatusEnum {
+  active = 'active',
+  syncing = 'syncing'
+}
+export const DatasetStatusMap = {
+  [DatasetStatusEnum.active]: {
+    label: 'core.dataset.status.active'
+  },
+  [DatasetStatusEnum.syncing]: {
+    label: 'core.dataset.status.syncing'
+  }
+};
+
+/* ------------ collection -------------- */
 export enum DatasetCollectionTypeEnum {
-  file = 'file',
   folder = 'folder',
-  link = 'link',
+  file = 'file',
+  link = 'link', // one link
   virtual = 'virtual'
 }
-
 export const DatasetCollectionTypeMap = {
-  [DatasetCollectionTypeEnum.file]: {
-    name: 'dataset.file'
-  },
   [DatasetCollectionTypeEnum.folder]: {
-    name: 'dataset.folder'
+    name: 'core.dataset.folder'
+  },
+  [DatasetCollectionTypeEnum.file]: {
+    name: 'core.dataset.file'
   },
   [DatasetCollectionTypeEnum.link]: {
-    name: 'dataset.link'
+    name: 'core.dataset.link'
   },
   [DatasetCollectionTypeEnum.virtual]: {
-    name: 'dataset.Virtual File'
+    name: 'core.dataset.Virtual File'
   }
 };
-
-export enum TrainingModeEnum {
-  'qa' = 'qa',
-  'index' = 'index'
-}
-export const TrainingTypeMap = {
-  [TrainingModeEnum.qa]: 'qa',
-  [TrainingModeEnum.index]: 'index'
-};
-
-export enum DatasetSpecialIdEnum {
+export enum DatasetCollectionTrainingModeEnum {
   manual = 'manual',
-  mark = 'mark'
+  chunk = 'chunk',
+  qa = 'qa'
 }
-export const datasetSpecialIdMap = {
-  [DatasetSpecialIdEnum.manual]: {
-    name: 'kb.Manual Data',
-    sourceName: 'kb.Manual Input'
+export const DatasetCollectionTrainingTypeMap = {
+  [DatasetCollectionTrainingModeEnum.manual]: {
+    label: 'core.dataset.collection.training.type manual'
   },
-  [DatasetSpecialIdEnum.mark]: {
-    name: 'kb.Mark Data',
-    sourceName: 'kb.Manual Mark'
+  [DatasetCollectionTrainingModeEnum.chunk]: {
+    label: 'core.dataset.collection.training.type chunk'
+  },
+  [DatasetCollectionTrainingModeEnum.qa]: {
+    label: 'core.dataset.collection.training.type qa'
+  }
+};
+
+/* ------------ data -------------- */
+export enum DatasetDataIndexTypeEnum {
+  chunk = 'chunk',
+  qa = 'qa',
+  summary = 'summary',
+  hypothetical = 'hypothetical',
+  custom = 'custom'
+}
+export const DatasetDataIndexTypeMap = {
+  [DatasetDataIndexTypeEnum.chunk]: {
+    name: 'dataset.data.indexes.chunk'
+  },
+  [DatasetDataIndexTypeEnum.summary]: {
+    name: 'dataset.data.indexes.summary'
+  },
+  [DatasetDataIndexTypeEnum.hypothetical]: {
+    name: 'dataset.data.indexes.hypothetical'
+  },
+  [DatasetDataIndexTypeEnum.qa]: {
+    name: 'dataset.data.indexes.qa'
+  },
+  [DatasetDataIndexTypeEnum.custom]: {
+    name: 'dataset.data.indexes.custom'
+  }
+};
+
+/* ------------ training -------------- */
+export enum TrainingModeEnum {
+  chunk = 'chunk',
+  qa = 'qa'
+}
+
+export const TrainingTypeMap = {
+  [TrainingModeEnum.chunk]: {
+    label: 'core.dataset.training.type chunk'
+  },
+  [TrainingModeEnum.qa]: {
+    label: 'core.dataset.training.type qa'
+  }
+};
+
+/* ------------ search -------------- */
+export enum DatasetSearchModeEnum {
+  embedding = 'embedding',
+  embeddingReRank = 'embeddingReRank',
+  embFullTextReRank = 'embFullTextReRank'
+}
+
+export const DatasetSearchModeMap = {
+  [DatasetSearchModeEnum.embedding]: {
+    icon: 'core/dataset/modeEmbedding',
+    title: 'core.dataset.search.mode.embedding',
+    desc: 'core.dataset.search.mode.embedding desc',
+    value: DatasetSearchModeEnum.embedding
+  },
+  [DatasetSearchModeEnum.embeddingReRank]: {
+    icon: 'core/dataset/modeEmbeddingRerank',
+    title: 'core.dataset.search.mode.embeddingReRank',
+    desc: 'core.dataset.search.mode.embeddingReRank desc',
+    value: DatasetSearchModeEnum.embeddingReRank
+  },
+  [DatasetSearchModeEnum.embFullTextReRank]: {
+    icon: 'core/dataset/modeEmbFTRerank',
+    title: 'core.dataset.search.mode.embFullTextReRank',
+    desc: 'core.dataset.search.mode.embFullTextReRank desc',
+    value: DatasetSearchModeEnum.embFullTextReRank
   }
 };
-export const datasetSpecialIds: string[] = [DatasetSpecialIdEnum.manual, DatasetSpecialIdEnum.mark];
 
 export const FolderAvatarSrc = '/imgs/files/folder.svg';

packages/global/core/dataset/controller.d.ts

@@ -0,0 +1,28 @@
+import type { DatasetDataIndexItemType, DatasetDataSchemaType } from './type';
+
+export type CreateDatasetDataProps = {
+  teamId: string;
+  tmbId: string;
+  datasetId: string;
+  collectionId: string;
+  chunkIndex?: number;
+  q: string;
+  a?: string;
+  indexes?: Omit<DatasetDataIndexItemType, 'dataId'>[];
+};
+
+export type UpdateDatasetDataProps = {
+  dataId: string;
+  q?: string;
+  a?: string;
+  indexes?: (Omit<DatasetDataIndexItemType, 'dataId'> & {
+    dataId?: string; // pg data id
+  })[];
+};
+
+export type PatchIndexesProps = {
+  type: 'create' | 'update' | 'delete';
+  index: Omit<DatasetDataIndexItemType, 'dataId'> & {
+    dataId?: string;
+  };
+};

packages/global/core/dataset/type.d.ts

@@ -1,37 +1,83 @@
-import { DatasetCollectionTypeEnum, DatasetTypeEnum, TrainingModeEnum } from './constant';
+import type { LLMModelItemType, VectorModelItemType } from '../../core/ai/model.d';
+import { PermissionTypeEnum } from '../../support/permission/constant';
+import { PushDatasetDataChunkProps } from './api';
+import {
+  DatasetCollectionTypeEnum,
+  DatasetDataIndexTypeEnum,
+  DatasetStatusEnum,
+  DatasetTypeEnum,
+  TrainingModeEnum
+} from './constant';
 
+/* schema */
 export type DatasetSchemaType = {
   _id: string;
-  userId: string;
   parentId: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
   updateTime: Date;
   avatar: string;
   name: string;
   vectorModel: string;
-  tags: string[];
+  agentModel: string;
+  intro: string;
   type: `${DatasetTypeEnum}`;
+  status: `${DatasetStatusEnum}`;
+  permission: `${PermissionTypeEnum}`;
+  websiteConfig?: {
+    url: string;
+    selector: string;
+  };
 };
 
 export type DatasetCollectionSchemaType = {
   _id: string;
-  userId: string;
+  teamId: string;
+  tmbId: string;
   datasetId: string;
   parentId?: string;
   name: string;
   type: `${DatasetCollectionTypeEnum}`;
+  createTime: Date;
   updateTime: Date;
-  metadata: {
-    fileId?: string;
-    rawLink?: string;
-    pgCollectionId?: string;
-  };
+  trainingType: `${TrainingModeEnum}`;
+  chunkSize: number;
+  fileId?: string;
+  rawLink?: string;
+  metadata?: Record<string, any>;
+};
+
+export type DatasetDataIndexItemType = {
+  defaultIndex: boolean;
+  dataId: string; // pg data id
+  type: `${DatasetDataIndexTypeEnum}`;
+  text: string;
+};
+export type DatasetDataSchemaType = {
+  _id: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  datasetId: string;
+  collectionId: string;
+  datasetId: string;
+  collectionId: string;
+  chunkIndex: number;
+  updateTime: Date;
+  q: string; // large chunks or question
+  a: string; // answer or custom content
+  fullTextToken: string;
+  indexes: DatasetDataIndexItemType[];
 };
 
 export type DatasetTrainingSchemaType = {
   _id: string;
   userId: string;
+  teamId: string;
+  tmbId: string;
   datasetId: string;
-  datasetCollectionId: string;
+  collectionId: string;
   billId: string;
   expireAt: Date;
   lockTime: Date;
@@ -40,36 +86,76 @@ export type DatasetTrainingSchemaType = {
   prompt: string;
   q: string;
   a: string;
+  chunkIndex: number;
+  indexes: Omit<DatasetDataIndexItemType, 'dataId'>[];
+};
+
+export type CollectionWithDatasetType = Omit<DatasetCollectionSchemaType, 'datasetId'> & {
+  datasetId: DatasetSchemaType;
+};
+export type DatasetDataWithCollectionType = Omit<DatasetDataSchemaType, 'collectionId'> & {
+  collectionId: DatasetCollectionSchemaType;
 };
 
 /* ================= dataset ===================== */
+export type DatasetListItemType = {
+  _id: string;
+  parentId: string;
+  avatar: string;
+  name: string;
+  intro: string;
+  type: `${DatasetTypeEnum}`;
+  isOwner: boolean;
+  canWrite: boolean;
+  permission: `${PermissionTypeEnum}`;
+  vectorModel: VectorModelItemType;
+};
+export type DatasetItemType = Omit<DatasetSchemaType, 'vectorModel' | 'agentModel'> & {
+  vectorModel: VectorModelItemType;
+  agentModel: LLMModelItemType;
+  isOwner: boolean;
+  canWrite: boolean;
+};
 
 /* ================= collection ===================== */
+export type DatasetCollectionItemType = CollectionWithDatasetType & {
+  canWrite: boolean;
+  sourceName: string;
+  sourceId?: string;
+  file?: DatasetFileSchema;
+};
 
 /* ================= data ===================== */
-export type PgDataItemType = {
-  id: string;
-  q: string;
-  a: string;
-  dataset_id: string;
-  collection_id: string;
-};
-export type DatasetChunkItemType = {
-  q: string;
-  a: string;
-};
-export type DatasetDataItemType = DatasetChunkItemType & {
+export type DatasetDataItemType = {
   id: string;
   datasetId: string;
   collectionId: string;
   sourceName: string;
   sourceId?: string;
+  q: string;
+  a: string;
+  indexes: DatasetDataIndexItemType[];
+  isOwner: boolean;
+  canWrite: boolean;
+};
+
+/* --------------- file ---------------------- */
+export type DatasetFileSchema = {
+  _id: string;
+  length: number;
+  chunkSize: number;
+  uploadDate: Date;
+  filename: string;
+  contentType: string;
+  metadata: {
+    contentType: string;
+    datasetId: string;
+    teamId: string;
+    tmbId: string;
+  };
 };
 
 /* ============= search =============== */
-export type SearchDataResultItemType = PgDataItemType & {
-  score: number;
-};
-export type SearchDataResponseItemType = DatasetDataItemType & {
+export type SearchDataResponseItemType = Omit<DatasetDataItemType, 'isOwner' | 'canWrite'> & {
   score: number;
 };