system title (#526)

修复知识库选择文件onChange事件遇到有http请求时无法响应的bug

.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/docs-image.yml

@@ -9,7 +9,7 @@ on:
     tags:
       - 'v*.*.*'
 jobs:
-  build-fastgpt-images:
+  build-fastgpt-docs-images:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
@@ -59,7 +59,7 @@ jobs:
           -f docSite/Dockerfile \
           .
   push-to-docker-hub:
-    needs: build-fastgpt-images
+    needs: build-fastgpt-docs-images
     runs-on: ubuntu-20.04
     if: github.repository == 'labring/FastGPT'
     steps:
@@ -82,4 +82,17 @@ jobs:
       - name: Tag image with Docker Hub repository name and version tag
         run: docker tag ghcr.io/${{ github.repository_owner }}/fastgpt-docs:${{env.IMAGE_TAG}} ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
       - name: Push image to Docker Hub
-        run: docker push ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+        run: docker push ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+
+  update-docs-image:
+    needs: build-fastgpt-docs-images
+    runs-on: ubuntu-20.04
+    if: github.repository == 'labring/FastGPT'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - uses: actions-hub/kubectl@master
+        env:
+          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
+        with:
+          args: rollout restart deployment fastgpt-docs

.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

@@ -15,13 +15,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
         with:
-          fetch-depth: 1
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: recursive # Fetch submodules
+          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
         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 }}
@@ -45,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} \

.vscode/settings.json

@@ -2,7 +2,7 @@
     "editor.formatOnSave": true,
     "editor.mouseWheelZoom": true,
     "typescript.tsdk": "node_modules/typescript/lib",
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "prettier.prettierPath": "./node_modules/prettier",
     "i18n-ally.localesPaths": [
         "projects/app/public/locales"
     ],

Dockerfile

@@ -1,7 +1,7 @@
 # Install dependencies only when needed
-FROM node:current-alpine AS deps
+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
@@ -10,34 +10,30 @@ ARG name
 COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./
 COPY ./packages ./packages
 COPY ./projects/$name/package.json ./projects/$name/package.json
-COPY ./projects/$name/pnpm-lock.yaml ./projects/$name/pnpm-lock.yaml
 
-RUN \
-  [ -f pnpm-lock.yaml ] && pnpm install || \
-  (echo "Lockfile not found." && exit 1)
+RUN [ -f pnpm-lock.yaml ] || (echo "Lockfile not found." && exit 1)
 
-RUN pnpm prune
+RUN pnpm install
 
 # Rebuild the source code only when needed
-FROM node:current-alpine AS builder
+FROM node:18.15-alpine AS builder
 WORKDIR /app
 
 ARG name
 
 # copy common node_modules and one project node_modules
+COPY package.json pnpm-workspace.yaml ./
 COPY --from=deps /app/node_modules ./node_modules
 COPY --from=deps /app/packages ./packages
 COPY ./projects/$name ./projects/$name
 COPY --from=deps /app/projects/$name/node_modules ./projects/$name/node_modules
-COPY pnpm-lock.yaml pnpm-workspace.yaml ./
-COPY ./packages ./packages
 
 # Uncomment the following line in case you want to disable telemetry during the build.
 ENV NEXT_TELEMETRY_DISABLED 1
 RUN npm install -g pnpm
 RUN pnpm --filter=$name run build
 
-FROM node:current-alpine AS runner
+FROM node:18.15-alpine AS runner
 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 可视化进行工作流编排，从而实现复杂的问答场景！
@@ -15,19 +16,19 @@ FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开
 
 <p align="center">
   <a href="https://fastgpt.run/">
-    <img height="21" src="https://img.shields.io/badge/在线使用-fff?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
+    <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">
-    <img height="21" src="https://img.shields.io/badge/本地开发-%23fff?style=flat-square&logo=xcode&logoColor=7d09f1" alt="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">
     <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=fff&color=7d09f1" alt="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>
 
@@ -35,18 +36,23 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 
 ## 🛸 在线使用
 
-[fastgpt.run](https://fastgpt.run/)（服务器在新加坡，部分地区可能无法直连）
+- 🌐 国内版：[ai.fastgpt.in](https://ai.fastgpt.in/)
+- 🌍 海外版：[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) |
 
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
+
 ## 💡 功能
 
 1. 强大的可视化编排，轻松构建 AI 应用
    - [x] 提供简易模式，无需操作编排
-   - [x] 用户对话前引导, 全局字符串变量
+   - [x] 用户对话前引导，全局字符串变量
    - [x] 知识库搜索
    - [x] 多 LLM 模型对话
    - [x] 文本内容提取成结构化数据
@@ -55,12 +61,12 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
    - [x] 对话下一步指引
    - [ ] 对话多路线选择
    - [x] 源文件引用追踪
-   - [ ] 自定义文件阅读器
+   - [x] 模块封装，实现多级复用
 2. 丰富的知识库预处理
    - [x] 多库复用，混用
    - [x] chunk 记录修改和删除
-   - [x] 支持 手动输入, 直接分段, QA 拆分导入
-   - [x] 支持 url 读取、 CSV 批量导入
+   - [x] 支持手动输入，直接分段，QA 拆分导入
+   - [x] 支持 url 读取、CSV 批量导入
    - [x] 支持知识库单独设置向量模型
    - [x] 源文件存储
    - [ ] 文件学习 Agent
@@ -70,16 +76,20 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
    - [x] 完整上下文呈现
    - [x] 完整模块中间值呈现
 4. OpenAPI
-   - [x] completions 接口（对齐 GPT 接口）
+   - [x] completions 接口 (对齐 GPT 接口)
    - [ ] 知识库 CRUD
 5. 运营功能
    - [x] 免登录分享窗口
    - [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 插件）
+项目技术栈：NextJs + TS + ChakraUI + Mongo + Postgres (Vector 插件)
 
 - **⚡ 快速部署**
 
@@ -89,12 +99,17 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 
   由于需要部署数据库，部署完后需要等待 2~4 分钟才能正常访问。默认用了最低配置，首次访问时会有些慢。
 
-* [快开始本地开发](https://doc.fastgpt.run/docs/development/intro/)
-* [部署 FastGPT](https://doc.fastgpt.run/docs/installation)
-* [系统配置文件说明](https://doc.fastgpt.run/docs/development/configuration/)
-* [多模型配置](https://doc.fastgpt.run/docs/installation/one-api/)
-* [版本更新/升级介绍](https://doc.fastgpt.run/docs/installation/upgrading)
-* [API 文档](https://doc.fastgpt.run/docs/development/openapi/)
+* [快开始本地开发](https://doc.fastgpt.in/docs/development/intro/)
+* [部署 FastGPT](https://doc.fastgpt.in/docs/installation)
+* [系统配置文件说明](https://doc.fastgpt.in/docs/development/configuration/)
+* [多模型配置](https://doc.fastgpt.in/docs/installation/one-api/)
+* [版本更新/升级介绍](https://doc.fastgpt.in/docs/installation/upgrading)
+* [OpenAPI API 文档](https://doc.fastgpt.in/docs/development/openapi/)
+* [知识库结构详解](https://doc.fastgpt.in/docs/use-cases/datasetengine/)
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
 ## 🏘️ 社区交流群
 
@@ -102,12 +117,20 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 
 ![](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)
-- [Sealos: 快速部署集群应用](https://github.com/labring/sealos)
-- [One API: 多模型管理，支持 Azure、文心一言等](https://github.com/songquanpeng/one-api)
-- [TuShan: 5 分钟搭建后台管理系统](https://github.com/msgbyte/tushan)
+- [Laf：3 分钟快速接入三方应用](https://github.com/labring/laf)
+- [Sealos：快速部署集群应用](https://github.com/labring/sealos)
+- [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>
 
 ## 👀 其他
 
@@ -115,19 +138,31 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
 - [接入飞书](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) 开源协议。
 
-1. 允许作为后台服务直接商用，但不允许直接使用 SaaS 服务商用。
-2. 需保留相关版权信息。
+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!
@@ -15,19 +16,19 @@ FastGPT is a knowledge-based Q&A system built on the LLM, offers out-of-the-box
 
 <p align="center">
   <a href="https://fastgpt.run/">
-    <img height="21" src="https://img.shields.io/badge/Website-fff?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
+    <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/Docs-7d09f1?style=flat-square" alt="document">
+    <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/Development-%23fff?style=flat-square&logo=xcode&logoColor=7d09f1" alt="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/Related Projects-7d09f1?style=flat-square" alt="project">
+    <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=fff&color=7d09f1" alt="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>
 
@@ -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
@@ -54,9 +59,9 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
    - [x] Extend with HTTP
    - [ ] Embed Laf for on-the-fly HTTP module crafting
    - [x] Directions for the next dialogue steps
-   - [ ] Multiple dialogue paths selection
    - [x] Tracking source file references
    - [ ] Custom file reader
+   - [ ] Modules are packaged into plug-ins to achieve reuse
 
 2. Extensive knowledge base preprocessing
 
@@ -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/.zhlintignore

@@ -0,0 +1 @@
+*.html

docSite/.zhlintrc

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

docSite/README.md

@@ -3,7 +3,7 @@
 ## 本地运行
 
 1. 安装 go 语言环境。
-2. 安装 hugo。 [二进制下载](https://github.com/gohugoio/hugo/releases/tag/v0.117.0)
+2. 安装 hugo。[二进制下载](https://github.com/gohugoio/hugo/releases/tag/v0.117.0)，注意需要安装 extended 版本。
 3. cd docSite
 4. hugo serve
 5. 访问 http://localhost:1313

docSite/content/docs/commercial.md

@@ -13,18 +13,20 @@ weight: 20
 
 ## 商业版
 
-商业版最终交付版本功能与 https://fastgpt.run 完全一致，品牌内容可自定义。
+商业版最终交付版本功能与 https://fastgpt.run 完全一致，品牌内容可自定义，商业授权时长同`License`有效期。
 
 {{% alert icon="🤖" context="warning" %}}
-商业版与开源版功能差异：（目前计划）
+商业版比开源版额外增加的内容：（目前计划）
 
-1. 自定义 title 和 logo
+1. 可自定义 title 和 logo
 2. 用户注册，支付 （已有微信扫码支付，后续会补充支付方式）
 3. API 访问限制，可配置：额度、过期时间
-4. 团队空间 （计划）
-5. 完善的 OpenAPI（计划）
-6. 高级编排额外插件（计划）
-7. 后台管理系统   
+4. 分享链接限制，可配置：额度、过期时间、QPM、身份验证Hook
+5. 内容审核（目前对接了百度）
+6. 团队空间 （计划）
+7. 完善的 OpenAPI（计划）
+8. 高级编排额外插件（计划）
+9. 后台管理系统   
   a. 查询：用户、支付、应用、知识库  
   b. 变更：用户  
   c. 新增：用户  
@@ -36,7 +38,7 @@ weight: 20
 
 + 使用 [Sealos 公有云](https://sealos.io)部署：1万元/年/套 （无部署费用。赠送 8000 sealos 公有云额度，可用于 FastGPT 或其他云资源）。
 + 渠道商使用 Sealos 部署：返现 20% 成交额。
-+ 私有服务器部署：2万元/年/套（如需部署支持，按技术服务费计算）
++ 私有服务器部署：2万元/年/套
 + 渠道商私有服务器部署：1.3万元/年/套（渠道商合同单独约谈，累计 5 套以上可签）
 
 #### 用户注册数量费用（按注册量算，不计量分享和 API）
@@ -81,7 +83,7 @@ weight: 20
    
    完整版应用 = 开源版镜像 + 商业版镜像
 
-   我们会提供一个商业版镜像给你使用，该镜像需要一个 license 启动，license 有效期为 1 年。此外，还会提供一个简单的后台管理系统（目前只设置了简单的查询功能）
+   我们会提供一个商业版镜像给你使用，该镜像需要一个 License 启动，License 有效期为 1 年。此外，还会提供一个简单的后台管理系统（目前只设置了简单的查询功能）
 
 2. 二次开发如何操作？
    

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

@@ -63,15 +63,15 @@ Authorization 为 sk-aaabbbcccdddeeefffggghhhiiijjjkkk。model 为刚刚在 One
 
 ```json
 "ChatModels": [
-  //已有模型
+  //其他对话模型
   {
     "model": "chatglm2",
     "name": "chatglm2",
-    "contextMaxToken": 8000,
+    "maxToken": 8000,
+    "price": 0,
     "quoteMaxToken": 4000,
     "maxTemperature": 1.2,
-    "price": 0,
-    "defaultSystem": ""
+    "defaultSystemChatPrompt": ""
   }
 ],
 "VectorModels": [

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,11 +107,12 @@ Authorization 为 sk-aaabbbcccdddeeefffggghhhiiijjjkkk。model 为刚刚在 One
   {
     "model": "chatglm2",
     "name": "chatglm2",
-    "contextMaxToken": 8000,
-    "quoteMaxToken": 4000,
-    "maxTemperature": 1.2,
-    "price": 0,
-    "defaultSystem": ""
+    "maxContext": 4000,
+    "maxResponse": 4000,
+    "quoteMaxToken": 2000,
+    "maxTemperature": 1,
+    "vision": false, 
+    "defaultSystemChatPrompt": ""
   }
 ]
 ```

docSite/content/docs/development/configuration.md

@@ -21,69 +21,140 @@ weight: 520
 ```json
 {
   "SystemParams": {
+    "pluginBaseUrl": "", // 商业版接口地址
     "vectorMaxProcess": 15, // 向量生成最大进程，结合数据库性能和 key 来设置
     "qaMaxProcess": 15,  // QA 生成最大进程，结合数据库性能和 key 来设置
-    "pgIvfflatProbe": 20  // pg vector 搜索探针。没有设置索引前可忽略，通常 50w 组以上才需要设置。
+    "pgHNSWEfSearch": 100  // pg vector 索引参数，越大精度高但速度慢
   },
-  "ChatModels": [
+  "ChatModels": [ // 对话模型
     {
-      "model": "gpt-3.5-turbo",
-      "name": "GPT35-4k",
-      "contextMaxToken": 4000, // 最大token，均按 gpt35 计算
-      "quoteMaxToken": 2000, // 引用内容最大 token
-      "maxTemperature": 1.2, // 最大温度
-      "price": 0,
-      "defaultSystem": ""
+      "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",
-      "contextMaxToken": 16000,
+      "maxContext": 16000,
+      "maxResponse": 16000,
+      "price": 0,
       "quoteMaxToken": 8000,
       "maxTemperature": 1.2,
-      "price": 0,
-      "defaultSystem": ""
+      "censor": false,
+      "vision": false,
+      "defaultSystemChatPrompt": ""
     },
     {
       "model": "gpt-4",
       "name": "GPT4-8k",
-      "contextMaxToken": 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,
-      "defaultSystem": ""
+      "quoteMaxToken": 100000,
+      "maxTemperature": 1.2,
+      "censor": false,
+      "vision": true,
+      "defaultSystemChatPrompt": ""
     }
   ],
-  "VectorModels": [
+  "QAModels": [ // QA 生成模型
+    {
+      "model": "gpt-3.5-turbo-16k",
+      "name": "GPT35-16k",
+      "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-1106",
+      "name": "GPT35-1106",
+      "maxContext": 16000,
+      "maxResponse": 4000,
+      "price": 0,
+      "functionCall": true,
+      "functionPrompt": ""
+    }
+  ],
+  "QGModels": [ // 生成下一步指引
+    {
+      "model": "gpt-3.5-turbo-1106",
+      "name": "GPT35-1106",
+      "maxContext": 1600,
+      "maxResponse": 4000,
+      "price": 0
+    }
+  ],
+  "VectorModels": [ // 向量模型
     {
       "model": "text-embedding-ada-002",
       "name": "Embedding-2",
-      "price": 0,
-      "defaultToken": 500,
+      "price": 0.2,
+      "defaultToken": 700,
       "maxToken": 3000
     }
   ],
-  "QAModel": { // QA 拆分模型
-    "model": "gpt-3.5-turbo-16k",
-    "name": "GPT35-16k",
-    "maxToken": 16000,
+  "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
-  },
-  "ExtractModel": { // 内容提取模型
-    "model": "gpt-3.5-turbo-16k",
-    "functionCall": true, // 是否使用 functionCall
-    "name": "GPT35-16k",
-    "maxToken": 16000,
-    "price": 0,
-    "prompt": ""
-  },
-  "CQModel": { // 问题分类模型
-    "model": "gpt-3.5-turbo-16k",
-    "functionCall": true,
-    "name": "GPT35-16k",
-    "maxToken": 16000,
-    "price": 0,
-    "prompt": ""
   }
 }
 ```

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

@@ -0,0 +1,8 @@
+---
+weight: 540
+title: "设计方案"
+description: "FastGPT 部分设计方案"
+icon: public
+draft: false
+images: []
+---

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

@@ -0,0 +1,25 @@
+---
+weight: 541
+title: "数据集"
+description: "FastGPT 数据集中文件与数据的设计方案"
+icon: dataset
+draft: false
+images: []
+---
+
+## 文件与数据的关系
+
+在 FastGPT 中，文件会通过 MongoDB 的 FS 存储，而具体的数据会通过 PostgreSQL 存储，PG 中的数据会有一列 file_id，关联对应的文件。考虑到旧版本的兼容，以及手动输入、标注数据等，我们给 file_id 增加了一些特殊的值，如下：
+
+- manual: 手动输入
+- mark: 手动标注的数据
+
+注意，file_id 仅在插入数据时会写入，变更时无法修改。
+
+## 文件导入流程
+
+1. 上传文件到 MongoDB 的 FS 中，获取 file_id，此时文件标记为 `unused` 状态
+2. 浏览器解析文件，获取对应的文本和 chunk
+3. 给每个 chunk 打上 file_id
+4. 点击上传数据：将文件的状态改为 `used`，并将数据推送到 mongo `training` 表中等待训练
+5. 由训练线程从 mongo 中取数据，并在获取向量后插入到 pg。

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 配置文件不能包含注释，介绍中为了方便看才加入的注释**
 
@@ -66,7 +66,7 @@ git clone git@github.com:<github_username>/FastGPT.git
 
 - `vectorMaxProcess`: 向量生成最大进程，根据数据库和 key 的并发数来决定，通常单个 120 号，2c4g 服务器设置 10~15。
 - `qaMaxProcess`: QA 生成最大进程
-- `pgIvfflatProbe`: PostgreSQL vector 搜索探针，没有添加 vector 索引时可忽略。
+- `pgHNSWEfSearch`: PostgreSQL vector 索引参数，越大搜索精度越高但是速度越慢，具体可看 pgvector 官方说明。
 
 ### 5. 运行
 
@@ -94,7 +94,16 @@ docker build -t dockername/fastgpt --build-arg name=app .
 
 如果遇到问题，比如合并冲突或不知道如何打开拉取请求，请查看 GitHub 的[拉取请求教程](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests)，了解如何解决合并冲突和其他问题。一旦您的 PR 被合并，您将自豪地被列为[贡献者表](https://github.com/labring/FastGPT/graphs/contributors)中的一员。
 
-## 加入社区
+
+
+## QA
+
+### 本地数据库无法连接
+
+1. 如果你是连接远程的数据库，先检查对应的端口是否开放。
+2. 如果是本地运行的数据库，可尝试`host`改成`localhost`或`127.0.0.1`
+
+### 加入社区
 
 遇到困难了吗？有任何问题吗? 加入微信群与开发者和用户保持沟通。
 

docSite/content/docs/development/openApi.md

@@ -1,533 +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":[{"kb_id":"646627f4f7b896cfd8910e38","id":"8099","q":"本作的主人公是谁？","a":"本作的主人公是名叫铃芽的少女。","source":"手动修改"},{"kb_id":"646627f4f7b896cfd8910e38","id":"8686","q":"电影《铃芽之旅》男主角是谁？","a":"电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。","source":""},{"kb_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": [
-                {
-                    "kb_id": "646627f4f7b896cfd8910e38",
-                    "id": "8099",
-                    "q": "本作的主人公是谁？",
-                    "a": "本作的主人公是名叫铃芽的少女。",
-                    "source": "手动修改"
-                },
-                {
-                    "kb_id": "646627f4f7b896cfd8910e38",
-                    "id": "8686",
-                    "q": "电影《铃芽之旅》男主角是谁？",
-                    "a": "电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",
-                    "source": ""
-                },
-                {
-                    "kb_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（kbId）
-
-![](/imgs/getKbId.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 '{
-    "kbId": "64663f451ba1676dbdef0499",
-    "mode": "index",
-    "prompt": "qa 拆分引导词，index 模式下可以忽略",
-    "billId": "可选。如果有这个值，本次的数据会被聚合到一个订单中，这个值可以重复使用。可以参考 [创建训练订单] 获取该值。",
-    "data": [
-        {
-            "a": "test",
-            "q": "1111",
-        },
-        {
-            "a": "test2",
-            "q": "22222"
-        }
-    ]
-}'
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="参数说明" >}}
-{{< markdownify >}}
-
-```json
-{
-    "kbId": "知识库的ID，可以在知识库详情查看。",
-    "mode": "index | qa ", //  index 模式: 直接将 q 转成向量存起来，a 直接入库。qa 模式: 只关注 data 里的 q，将 q 丢给大模型，让其根据 prompt 拆分成 qa 问答对。  
-    "prompt": "拆分提示词，需严格按照模板，建议不要传入。",
-    "data": [
-        {
-            "q": "生成索引的内容，index 模式下最大 tokens 为3000，建议不超过 1000",
-            "a": "预期回答/补充"
-        },
-        {
-            "q": "生成索引的内容，qa 模式下最大 tokens 为10000，建议 8000 左右",
-            "a": "预期回答/补充"
-        }
-    ]
-}
-```
-
-{{< /markdownify >}}
-{{< /tab >}}
-
-{{< tab tabName="响应例子" >}}
-{{< markdownify >}}
-
-```json
-{
-    "code": 200,
-    "statusText": "",
-    "data": {
-        "insertLen": 1 // 最终插入成功的数量，可能因为超出 tokens 或者插入异常，index 可以重复插入，会自动去重
-    }
-}
-```
-
-{{< /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 '{
-    "kbId": "xxxxx",
-    "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": [
-                {
-                    "kb_id": "646627f4f7b896cfd8910e38",
-                    "id": "8099",
-                    "q": "本作的主人公是谁？",
-                    "a": "本作的主人公是名叫铃芽的少女。",
-                    "source": "手动修改"
-                },
-                {
-                    "kb_id": "646627f4f7b896cfd8910e38",
-                    "id": "8686",
-                    "q": "电影《铃芽之旅》男主角是谁？",
-                    "a": "电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",
-                    "source": ""
-                },
-                {
-                    "kb_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

@@ -9,6 +9,8 @@ weight: 720
 
 ## 准备条件
 
+服务器要求：2C2G 起
+
 ### 1. 准备好代理环境（国外服务器可忽略）
 
 确保可以访问 OpenAI，具体方案可以参考：[代理方案](/docs/installation/proxy/)。或直接在 Sealos 上 [部署 OneAPI](/docs/installation/one-api)，既解决代理问题也能实现多 Key 轮询、接入其他大模型。
@@ -70,9 +72,9 @@ brew install orbstack
 
 依次执行下面命令，创建 FastGPT 文件并拉取`docker-compose.yml`和`config.json`，执行完后目录下会有 2 个文件。
 
-非 Linux 环境，可手动创建目录，并下载这2个文件。
+非 Linux 环境或无法访问外网环境，可手动创建一个目录，并下载下面2个链接的文件: [docker-compose.yml](https://github.com/labring/FastGPT/blob/main/files/deploy/fastgpt/docker-compose.yml),[config.json](https://github.com/labring/FastGPT/blob/main/projects/app/data/config.json)
 
-**注意: 配置文件中 Mongo 为 5.x，部分服务器不支持，需手动更改其镜像版本为 4.4.24**
+**注意: `docker-compose.yml` 配置文件中 Mongo 为 5.x，部分服务器不支持，需手动更改其镜像版本为 4.4.24**
 
 ```bash
 mkdir fastgpt
@@ -84,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 同级目录下执行
@@ -118,7 +120,12 @@ docker-compose up -d
 1. `docker logs fastgpt` 可以查看日志，在启动容器后，第一次请求网页，会进行配置文件读取，可以看看有没有读取成功以及有无错误日志。
 2. `docker exec -it fastgpt sh` 进入 FastGPT 容器，可以通过`ls data`查看目录下是否成功挂载`config.json`文件。可通过`cat data/config.json`查看配置文件。
 
-### 为什么无法连接 oneapi 和 本地模型镜像。
+**可能不生效的原因**
+
+1. 挂载目录不正确
+2. 配置文件不正确，日志中会提示`invalid json`，配置文件需要是标准的 JSON 文件。
+
+### 为什么无法连接`本地模型`镜像。
 
 `docker-compose.yml`中使用了桥接的模式建立了`fastgpt`网络，如想通过0.0.0.0或镜像名访问其它镜像，需将其它镜像也加入到网络中。
 
@@ -132,6 +139,21 @@ docker-compose 端口定义为：`映射端口:运行端口`。
 
 （自行补习 docker 基本知识）
 
+### relation "modeldata" does not exist
+
+PG 数据库没有连接上/初始化失败，可以查看日志。FastGPT 会在每次连接上 PG 时进行表初始化，如果报错会有对应日志。
+
+1. 检查数据库容器是否正常启动
+2. 非 docker 部署的，需要手动安装 pg vector 插件
+3. 查看 fastgpt 日志，有没有相关报错
+
+### Operation `auth_codes.findOne()` buffering timed out after 10000ms
+
+mongo连接失败，检查
+1. mongo 服务有没有起来(有些 cpu 不支持 AVX，无法用 mongo5，需要换成 mongo4.x，可以dockerhub找个最新的4.x，修改镜像版本，重新运行）
+2. 环境变量（账号密码，注意host和port）
+
+
 ### 错误排查方式
 
 遇到问题先按下面方式排查。

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,12 +98,13 @@ CHAT_API_KEY=sk-xxxxxx
     {
       "model": "ERNIE-Bot", // 这里的模型需要对应 One API 的模型
       "name": "文心一言", // 对外展示的名称
-      "contextMaxToken": 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.
       "quoteMaxToken": 2000, // 引用知识库的最大 Token
       "maxTemperature": 1, // 最大温度
-      "price": 0, // 1个token 价格 => 1.5 / 100000 * 1000 = 0.015元/1k token
-      "defaultSystem": "" // 默认的系统提示词
+      "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

@@ -0,0 +1,31 @@
+---
+title: 'V4.4.7（需执行升级脚本）'
+description: 'FastGPT V4.4.7 更新（需执行升级脚本）'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 840
+---
+
+## 执行初始化 API
+
+发起 1 个 HTTP 请求（{{rootkey}} 替换成环境变量里的`rootkey`，{{host}}替换成自己域名）
+
+1. https://xxxxx/api/admin/initv447
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv447' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```
+
+初始化 pg 索引以及将 file_id 中空对象转成 manual 对象。如果数据多，可能需要较长时间，可以通过日志查看进度。
+
+## 功能介绍
+
+### Fast GPT V4.4.7
+
+1. 优化了数据库文件 crud。
+2. 兼容链接读取，作为 source。
+3. 区分手动录入和标注，可追数据至某个文件。
+4. 升级 openai sdk。

docSite/content/docs/installation/upgrading/45.md

@@ -0,0 +1,93 @@
+---
+title: 'V4.5(需进行较为复杂更新)'
+description: 'FastGPT V4.5 更新'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 839
+---
+
+FastGPT V4.5 引入 PgVector0.5 版本的 HNSW 索引，极大的提高了知识库检索的速度，比起`IVFFlat`索引大致有3~10倍的性能提升，可轻松实现百万数据毫秒级搜索。缺点在于构建索引的速度非常慢，4c16g 500w 组数据使用`并行构建`大约花了 48 小时。具体参数配置可参考 [PgVector官方](https://github.com/pgvector/pgvector)
+
+下面需要对数据库进行一些操作升级：
+
+## PgVector升级：Sealos 部署方案
+
+1. 点击[Sealos桌面](https://cloud.sealos.io)的数据库应用。
+2. 点击【pg】数据库的详情。
+3. 点击右上角的重启，等待重启完成。
+4. 点击左侧的一键链接，等待打开 Terminal。
+5. 依次输入下方 sql 命令
+
+```sql
+-- 升级插件名
+ALTER EXTENSION vector UPDATE;
+-- 插件是否升级成功，成功的话，vector插件版本为 0.5.0，旧版的为 0.4.1
+\dx
+
+-- 下面两个语句会设置 pg 在构建索引时可用的内存大小，需根据自身的数据库规格来动态配置，可配置为 1/4 的内存大小
+alter system set maintenance_work_mem = '2400MB'; 
+select pg_reload_conf();
+
+-- 重构数据库索引和排序
+REINDEX DATABASE postgres;
+
+-- 开始构建索引，该索引构建时间非常久，直接点击右上角的叉，退出 Terminal 即可
+CREATE INDEX CONCURRENTLY vector_index ON modeldata USING hnsw (vector vector_ip_ops) WITH (m = 16, ef_construction = 64);
+-- 可以再次点击一键链接，进入 Terminal，输入下方命令，如果看到 "vector_index" hnsw (vector vector_ip_ops) WITH (m='16', ef_construction='64') 则代表构建完成（注意，后面没有 INVALID）
+\d modeldata
+```
+
+|                       |                       |
+| --------------------- | --------------------- |
+| ![](/imgs/v45-1.png) | ![](/imgs/v45-2.png) |
+| ![](/imgs/v45-3.png) | ![](/imgs/v45-4.png) |
+
+
+
+## PgVector升级：Docker-compose.yml 部署方案
+
+下面的命令是基于给的 docker-compose 模板，如果数据库账号密码更换了，请自行调整。
+
+1. 修改 `docker-compose.yml` 中pg的镜像版本，改成 `ankane/pgvector:v0.5.0` 或 `registry.cn-hangzhou.aliyuncs.com/fastgpt/pgvector:v0.5.0`
+2. 重启 pg 容器(docker-compose pull && docker-compose up -d)，等待重启完成。
+3. 进入容器: `docker exec -it pg bash`
+4. 连接数据库: `psql 'postgresql://username:password@localhost:5432/postgres'`
+5. 执行下面 sql 命令
+
+```sql
+-- 升级插件名
+ALTER EXTENSION vector UPDATE;
+-- 插件是否升级成功，成功的话，vector插件版本为 0.5.0，旧版的为 0.4.2
+\dx
+
+-- 下面两个语句会设置 pg 在构建索引时可用的内存大小，需根据自身的数据库规格来动态配置，可配置为 1/4 的内存大小
+alter system set maintenance_work_mem = '2400MB'; 
+select pg_reload_conf();
+
+-- 重构数据库索引和排序
+REINDEX DATABASE postgres;
+ALTER DATABASE postgres REFRESH COLLATION VERSION;
+
+-- 开始构建索引，该索引构建时间非常久，直接关掉终端即可，不要使用 ctrl+c 关闭
+CREATE INDEX CONCURRENTLY vector_index ON modeldata USING hnsw (vector vector_ip_ops) WITH (m = 16, ef_construction = 64);
+-- 可以再次连接数据库，输入下方命令。如果看到 "vector_index" hnsw (vector vector_ip_ops) WITH (m='16', ef_construction='64') 则代表构建完成（注意，后面没有 INVALID）
+\d modeldata
+
+
+```
+
+## 版本新功能介绍
+
+### Fast GPT V4.5
+
+1. 新增 - 升级 PgVector 插件，引入 HNSW 索引，极大加快的知识库搜索速度。
+2. 新增 - AI对话模块，增加【返回AI内容】选项，可控制 AI 的内容不直接返回浏览器。
+3. 新增 - 支持问题分类选择模型
+4. 优化 - TextSplitter，采用递归拆解法。
+5. 优化 - 高级编排 UX 性能
+6. 修复 - 分享链接鉴权问题
+
+## 该版本需要修改 `config.json` 文件
+
+最新配置可参考: [V45版本最新 config.json](/docs/development/configuration)

docSite/content/docs/installation/upgrading/451.md

@@ -0,0 +1,35 @@
+---
+title: 'V4.5.1(需进行初始化)'
+description: 'FastGPT V4.5.1 更新'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 838
+---
+
+## 执行初始化 API
+
+发起 1 个 HTTP 请求（{{rootkey}} 替换成环境变量里的`rootkey`，{{host}}替换成自己域名）
+
+1. https://xxxxx/api/admin/initv451
+
+```bash
+curl --location --request POST 'https://{{host}}/api/admin/initv451' \
+--header 'rootkey: {{rootkey}}' \
+--header 'Content-Type: application/json'
+```
+
+初始化内容：
+1. rename 数据库字段
+2. 初始化 Mongo APP 表中知识库的相关字段
+3. 初始化 PG 和 Mongo 的内容，为每个文件创建一个集合（存储 Mongo 中），并反馈赋值给 PG。
+
+**该初始化接口可能速度很慢，返回超时不用管，注意看日志即可**
+
+## 功能介绍
+
+### Fast GPT V4.5.1
+
+1. 新增知识库文件夹管理
+2. 修复了 openai4.x sdk 无法兼容 oneapi 的智谱和阿里的接口。
+3. 修复部分模块无法触发完成事件

docSite/content/docs/installation/upgrading/452.md

@@ -0,0 +1,15 @@
+---
+title: 'V4.5.2'
+description: 'FastGPT V4.5.2 更新'
+icon: 'upgrade'
+draft: false
+toc: true
+weight: 837
+---
+
+## 功能介绍
+
+### Fast GPT V4.5.2
+
+1. 新增 - 模块插件，允许自行组装插件进行模块复用。
+2. 优化 - 知识库引用提示。

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/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（包含上下文） |
@@ -30,6 +30,10 @@ weight: 10
 | 星火2.0 - 对话         | 0.01                              |
 | chatglm_pro - 对话     | 0.01                              |
 | 通义千问 - 对话         | 0.01                              |
+| 问题分类         | 0.03                             |
+| 内容提取         | 0.03                             |
+| 下一步指引         | 0.015                              |
+
 {{< /table >}}
 
 {{% alert context="warning" %}}

docSite/content/docs/quick-start.md

@@ -0,0 +1,54 @@
+---
+title: '快速上手'
+description: '快速体验 FastGPT 基础功能'
+icon: 'rocket_launch'
+draft: false
+toc: true
+weight: 30
+---
+
+更多使用技巧，[查看视屏教程](https://www.bilibili.com/video/BV1n34y1A7Bo/?spm_id_from=333.337.search-card.all.click&vd_source=903c2b09b7412037c2eddc6a8fb9828b)
+
+## 知识库
+
+开始前，请准备一份测试电子文档，WORD，PDF，TXT，excel，markdown 都可以，比如公司休假制度，不涉密的销售说辞，产品知识等等。
+
+这里使用 FastGPT 中文 README 文件为例。
+
+首先我们需要创建一个知识库。
+
+![](/imgs/create-rep.png)
+
+知识库创建完之后我们需要上传一点内容。
+
+上传内容这里有四种模式：
+- 手动输入：手动输入问答对，是最精准的数据
+- QA 拆分：选择文本文件，让AI自动生成问答对
+- 直接分段：选择文本文件，直接将其按分段进行处理
+- CSV 导入：批量导入问答对
+
+这里，我们选择 QA 拆分，让 AI 自动生成问答，若问答质量不高，可以后期手动修改。
+
+![](/imgs/upload-data.png)
+
+点击上传后我们需要等待数据处理完成，等到我们上传的文件状态为可用。
+
+![](/imgs/upload-data2.png)
+
+## 应用
+
+点击「应用」按钮来新建一个应用，这里有四个模板，我们选择「知识库 + 对话引导」。
+
+![](/imgs/create-app.png)
+
+应用创建后来再应用详情页找到「知识库」模块，把我们刚刚创建的知识库添加进去。
+
+![](/imgs/create-app2.png)
+
+添加完知识库后记得点击「保存并预览」，这样我们的应用就和知识库关联起来了。
+
+![](/imgs/create-app3.png)
+
+然后我们就可以愉快的开始聊天啦。
+
+![](/imgs/create-app4.png)

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

@@ -0,0 +1,134 @@
+---
+title: "AI 高级配置说明"
+description: "FastGPT AI 高级配置说明"
+icon: "sign_language"
+draft: false
+toc: true
+weight: 310
+---
+
+在 FastGPT 的 AI 对话模块中，有一个 AI 高级配置，里面包含了 AI 模型的参数配置，本文详细介绍这些配置的含义。
+
+## 返回AI内容
+
+这是一个开关，打开的时候，当 AI 对话模块运行时，会将其输出的内容返回到浏览器（API响应）；如果关闭，AI 输出的内容不会返回到浏览器，但是生成的内容仍可以通过【AI回复】进行输出。你可以将【AI回复】连接到其他模块中。
+
+## 温度
+
+可选范围0-10，约大代表生成的内容约自由扩散，越小代表约严谨。调节能力有限，知识库问答场景通常设置为0。
+
+## 回复上限
+
+控制 AI 回复的最大 Tokens，较小的值可以一定程度上减少 AI 的废话，但也可能导致 AI 回复不完整。
+
+## 引用模板 & 引用提示词
+
+这两个参数与知识库问答场景相关，可以控制知识库相关的提示词。
+
+### AI 对话消息组成
+
+想使用明白这两个变量，首先要了解传递传递给 AI 模型的消息格式。它是一个数组，FastGPT 中这个数组的组成形式为：
+
+```json
+[
+    内置提示词（config.json 配置，一般为空）
+    系统提示词 （用户输入的提示词）
+    历史记录
+    问题（由引用提示词、引用模板和用户问题组成）
+]
+```
+
+{{% alert icon="🍅" context="success" %}}
+Tips: 可以通过点击上下文按键查看完整的上下文组成，便于调试。
+{{% /alert %}}
+
+### 引用模板和提示词设计
+
+引用模板和引用提示词通常是成对出现，引用提示词依赖引用模板。
+
+FastGPT 知识库采用 QA 对(不一定都是问答格式，仅代表两个变量)的格式存储，在转义成字符串时候会根据**引用模板**来进行格式化。知识库包含多个可用变量： q, a, sourceId（数据的ID）, index(第n个数据), source(数据的集合名、文件名)，score(距离得分，0-1) 可以通过 {{q}} {{a}} {{sourceId}} {{index}} {{source}} {{score}} 按需引入。下面一个模板例子：
+
+可以通过 [知识库结构讲解](/docs/use-cases/datasetEngine/) 了解详细的知识库的结构。
+
+#### 引用模板
+
+```
+{instruction:"{{q}}",output:"{{a}}",source:"{{source}}"}
+```
+
+搜索到的知识库，会自动将 q,a,source 替换成对应的内容。每条搜索到的内容，会通过 `\n` 隔开。例如：
+```
+{instruction:"电影《铃芽之旅》的导演是谁？",output:"电影《铃芽之旅》的导演是新海诚。",source:"手动输入"}
+{instruction:"本作的主人公是谁？",output:"本作的主人公是名叫铃芽的少女。",source:""}
+{instruction:"电影《铃芽之旅》男主角是谁？",output:"电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",source:""}
+{instruction:"电影《铃芽之旅》的编剧是谁？22",output:"新海诚是本片的编剧。",source:"手动输入"}
+```
+
+#### 引用提示词
+
+引用模板需要和引用提示词一起使用，提示词中可以写引用模板的格式说明以及对话的要求等。可以使用 {{quote}} 来使用 **引用模板**，使用 {{question}} 来引入问题。例如：
+
+```
+你的背景知识:
+"""
+{{quote}}
+"""
+对话要求：
+1. 背景知识是最新的，其中 instruction 是相关介绍，output 是预期回答或补充。
+2. 使用背景知识回答问题。
+3. 背景知识无法回答问题时，你可以礼貌的的回答用户问题。
+我的问题是:"{{question}}"
+```
+
+转义后则为：
+```
+你的背景知识:
+"""
+{instruction:"电影《铃芽之旅》的导演是谁？",output:"电影《铃芽之旅》的导演是新海诚。",source:"手动输入"}
+{instruction:"本作的主人公是谁？",output:"本作的主人公是名叫铃芽的少女。",source:""}
+{instruction:"电影《铃芽之旅》男主角是谁？",output:"电影《铃芽之旅》男主角是宗像草太，由松村北斗配音}
+"""
+对话要求：
+1. 背景知识是最新的，其中 instruction 是相关介绍，output 是预期回答或补充。
+2. 使用背景知识回答问题。
+3. 背景知识无法回答问题时，你可以礼貌的的回答用户问题。
+我的问题是:"{{question}}"
+```
+
+#### 总结
+
+引用模板规定了搜索出来的内容如何组成一句话，其由 q,a,index,source 多个变量组成。
+
+引用提示词由`引用模板`和`提示词`组成，提示词通常是对引用模板的一个描述，加上对模型的要求。
+
+### 引用模板和提示词设计 示例
+
+#### 通用模板与问答模板对比
+
+我们通过一组`你是谁`的手动数据，对通用模板与问答模板的效果进行对比。此处特意打了个搞笑的答案，通用模板下 GPT35 就变得不那么听话了，而问答模板下 GPT35 依然能够回答正确。这是由于结构化的提示词，在大语言模型中具有更强的引导作用。
+
+{{% alert icon="🍅" context="success" %}}
+Tips: 建议根据不同的场景，每种知识库仅选择1类数据类型，这样有利于充分发挥提示词的作用。
+{{% /alert %}}
+
+| 通用模板配置及效果 | 问答模板配置及效果 |
+| --- | --- |
+| ![](/imgs/datasetprompt1.png) | ![](/imgs/datasetprompt2.png) |
+| ![](/imgs/datasetprompt3.png) | ![](/imgs/datasetprompt5.png) |
+| ![](/imgs/datasetprompt4.png) | ![](/imgs/datasetprompt6.png) |
+
+#### 严格模板
+
+使用非严格模板，我们随便询问一个不在知识库中的内容，模型通常会根据其自身知识进行回答。
+
+| 非严格模板效果 | 选择严格模板 | 严格模板效果 |
+| --- | --- | --- |
+| ![](/imgs/datasetprompt7.png) | ![](/imgs/datasetprompt8.png) |![](/imgs/datasetprompt9.png) |
+
+#### 提示词设计思路
+
+1. 使用序号进行不同要求描述。
+2. 使用首先、然后、最后等词语进行描述。
+3. 列举不同场景的要求时，尽量完整，不要遗漏。例如：背景知识完全可以回答、背景知识可以回答一部分、背景知识与问题无关，3种场景都说明清楚。
+4. 巧用结构化提示，例如在问答模板中，利用了`instruction`和`output`，清楚的告诉模型，`output`是一个预期的答案。
+5. 标点符号正确且完整。

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

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

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

@@ -11,6 +11,8 @@ weight: 322
 
 [Feishu OpenAI GitHub 地址](https://github.com/ConnectAI-E/Feishu-OpenAI)
 
+[查看视频教程](https://www.bilibili.com/video/BV1Su4y1r7R3/?spm_id_from=333.999.list.card_archive.click)
+
 由于 FastGPT 的 API 接口和 OpenAI 的规范一致，可以无需变更第三方应用即可使用 FastGPT 上编排好的应用。API 使用可参考 [这篇文章](/docs/use-cases/openapi/)。编排示例，可参考 [高级编排介绍](/docs/workflow/intro)
 
 ## 1. 获取 FastGPT 的 OpenAPI 秘钥

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/openapi.md

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

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

@@ -1,109 +0,0 @@
----
-title: "提示词 & 引用提示词"
-description: "FastGPT 提示词 & 引用提示词说明"
-icon: "sign_language"
-draft: false
-toc: true
-weight: 310
----
-
-限定词从 V4.4.3 版本后去除，被“引用提示词”和“引用模板”替代。
-
-# AI 对话消息组成
-
-传递给 AI 模型的消息是一个数组，FastGPT 中这个数组的组成形式为：
-
-```json
-[
-    内置提示词（config.json 配置，一般为空）
-    提示词 （用户输入的提示词）
-    历史记录
-    问题（会由输入的问题、引用提示词和引用模板来决定）
-]
-```
-
-{{% alert icon="🍅" context="success" %}}
-Tips: 可以通过点击上下文按键查看完整的
-{{% /alert %}}
-
-# 引用模板和提示词设计
-
-知识库采用 QA 对的格式存储，在转义成字符串时候会根据**引用模板**来进行格式化。知识库包含 3 个变量： q,a 和 source，可以通过 {{q}} {{a}} {{source}} 按需引入。下面一个模板例子：
-
-**引用模板**
-
-```
-{instruction:"{{q}}",output:"{{a}}",source:"{{source}}"}
-```
-
-搜索到的知识库，会自动将 q,a,source 替换成对应的内容。每条搜索到的内容，会通过 `\n` 隔开。例如：
-```
-{instruction:"电影《铃芽之旅》的导演是谁？",output:"电影《铃芽之旅》的导演是新海诚。",source:"手动输入"}
-{instruction:"本作的主人公是谁？",output:"本作的主人公是名叫铃芽的少女。",source:""}
-{instruction:"电影《铃芽之旅》男主角是谁？",output:"电影《铃芽之旅》男主角是宗像草太，由松村北斗配音。",source:""}
-{instruction:"电影《铃芽之旅》的编剧是谁？22",output:"新海诚是本片的编剧。",source:"手动输入"}
-```
-
-**引用提示词**
-
-引用模板需要和引用提示词一起使用，提示词中可以写引用模板的格式说明以及对话的要求等。可以使用 {{quote}} 来使用 **引用模板**，使用 {{question}} 来引入问题。例如：
-
-```
-你的背景知识:
-"""
-{{quote}}
-"""
-对话要求：
-1. 背景知识是最新的，其中 instruction 是相关介绍，output 是预期回答或补充。
-2. 使用背景知识回答问题。
-3. 背景知识无法回答问题时，你可以礼貌的的回答用户问题。
-我的问题是:"{{question}}"
-```
-
-
-# 提示词案例
-
-## 仅回复知识库里的内容
-
-**引用提示词**里添加：
-```
-你的背景知识:
-"""
-{{quote}}
-"""
-对话要求：
-1. 回答前，请先判断背景知识是否足够回答问题，如果无法回答，请直接回复：“对不起，我无法回答你的问题~”。
-2. 背景知识是最新的，其中 instruction 是相关介绍，output 是预期回答或补充。
-3. 使用背景知识回答问题。
-我的问题是:"{{question}}"
-```
-
-## 说明引用来源
-
-**引用模板:**
-
-```
-{instruction:"{{q}}",output:"{{a}}",source:"{{source}}"}
-```
-
-**引用提示词：**
-
-```
-你的背景知识:
-"""
-{{quote}}
-"""
-对话要求：
-1. 背景知识是最新的，其中 instruction 是相关介绍，output 是预期回答或补充，source是背景来源。
-2. 使用背景知识回答问题。
-3. 在回答问题后，你需要给出本次回答对应的背景来源，来源展示格式如下：
-
-“
-这是AI作答。本次知识来源：
-1. source1
-2. source2
-......
-”
-
-我的问题是:"{{question}}"
-```

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)
+
+
+
+
+