diff --git a/docs/agreement/index.html b/docs/agreement/index.html index 892f11efe..d60b7d19a 100644 --- a/docs/agreement/index.html +++ b/docs/agreement/index.html @@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
Docker Compose 快速部署
article

Docker Compose 快速部署

使用 Docker Compose 快速部署 FastGPT

前置知识

  1. 基础的网络知识：端口，防火墙……
  2. Docker 和 Docker Compose 基础知识
  3. 大模型相关接口和参数
  4. RAG 相关知识：向量模型，向量数据库，向量检索

部署架构图

推荐配置

PgVector版本

非常轻量，适合知识库索引量在 5000 万以下。

环境最低配置（单节点）推荐配置
测试（可以把计算进程设置少一些）2c4g2c8g
100w 组向量4c8g 50GB4c16g 50GB
500w 组向量8c32g 200GB16c64g 200GB

Milvus版本

对于亿级以上向量性能更优秀。

点击查看 Milvus 官方推荐配置

环境最低配置（单节点）推荐配置
测试2c8g4c16g
100w 组向量未测试
500w 组向量

zilliz cloud版本

Zilliz Cloud 由 Milvus 原厂打造，是全托管的 SaaS 向量数据库服务，性能优于 Milvus 并提供 SLA，点击使用 Zilliz Cloud。

由于向量库使用了 Cloud，无需占用本地资源，无需太关注。

前置工作

1. 确保网络环境

如果使用OpenAI等国外模型接口，请确保可以正常访问，否则会报错：Connection error 等。 方案可以参考：代理方案

2. 准备 Docker 环境 

+Table of Contents
article

Docker Compose 快速部署

使用 Docker Compose 快速部署 FastGPT

前置知识

  1. 基础的网络知识：端口，防火墙……
  2. Docker 和 Docker Compose 基础知识
  3. 大模型相关接口和参数
  4. RAG 相关知识：向量模型，向量数据库，向量检索

部署架构图

推荐配置

PgVector版本

非常轻量，适合知识库索引量在 5000 万以下。

环境最低配置（单节点）推荐配置
测试（可以把计算进程设置少一些）2c4g2c8g
100w 组向量4c8g 50GB4c16g 50GB
500w 组向量8c32g 200GB16c64g 200GB

Milvus版本

对于亿级以上向量性能更优秀。

点击查看 Milvus 官方推荐配置

环境最低配置（单节点）推荐配置
测试2c8g4c16g
100w 组向量未测试
500w 组向量

zilliz cloud版本

Zilliz Cloud 由 Milvus 原厂打造，是全托管的 SaaS 向量数据库服务，性能优于 Milvus 并提供 SLA，点击使用 Zilliz Cloud。

由于向量库使用了 Cloud，无需占用本地资源，无需太关注。

前置工作

1. 确保网络环境

如果使用OpenAI等国外模型接口，请确保可以正常访问，否则会报错：Connection error 等。 方案可以参考：代理方案

2. 准备 Docker 环境 

   # 安装 Docker
 curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
 systemctl enable --now docker
@@ -47,9 +47,9 @@ chmod +x /usr/local/bin/docker-compose
 docker -v
 docker-compose -v
 # 如失效，自行百度~
-

推荐直接使用 Orbstack。可直接通过 Homebrew 来安装：

+

推荐直接使用 Orbstack。可直接通过 Homebrew 来安装：

   brew install orbstack
-

或者直接下载安装包进行安装。

我们建议将源代码和其他数据绑定到 Linux 容器中时，将其存储在 Linux 文件系统中，而不是 Windows 文件系统中。

可以选择直接使用 WSL 2 后端在 Windows 中安装 Docker Desktop。

也可以直接在 WSL 2 中安装命令行版本的 Docker。

开始部署

1. 下载 docker-compose.yml

非 Linux 环境或无法访问外网环境，可手动创建一个目录，并下载配置文件和对应版本的docker-compose.yml，在这个文件夹中依据下载的配置文件运行docker，若作为本地开发使用推荐docker-compose-pgvector版本，并且自行拉取并运行sandbox和fastgpt，并在docker配置文件中注释掉sandbox和fastgpt的部分

Linux 快速脚本

+

或者直接下载安装包进行安装。

我们建议将源代码和其他数据绑定到 Linux 容器中时，将其存储在 Linux 文件系统中，而不是 Windows 文件系统中。

可以选择直接使用 WSL 2 后端在 Windows 中安装 Docker Desktop。

也可以直接在 WSL 2 中安装命令行版本的 Docker。

开始部署

1. 下载 docker-compose.yml

非 Linux 环境或无法访问外网环境，可手动创建一个目录，并下载配置文件和对应版本的docker-compose.yml，在这个文件夹中依据下载的配置文件运行docker，若作为本地开发使用推荐docker-compose-pgvector版本，并且自行拉取并运行sandbox和fastgpt，并在docker配置文件中注释掉sandbox和fastgpt的部分

Linux 快速脚本

   mkdir fastgpt
 cd fastgpt
 curl -O https://raw.githubusercontent.com/labring/FastGPT/main/projects/app/data/config.json
@@ -63,9 +63,9 @@ curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/mai
 # curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-milvus.yml
 # zilliz 版本
 # curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/deploy/docker/docker-compose-zilliz.yml
-

2. 修改环境变量

找到 yml 文件中，fastgpt 容器的环境变量进行下面操作：

无需操作
无需操作
无需操作

打开 Zilliz Cloud, 创建实例并获取相关秘钥。

zilliz_key

3. 修改 config.json 配置文件

修改config.json文件中的mcpServerProxyEndpoint值，设置成mcp server的公网可访问地址，yml 文件中默认给出了映射到 3005 端口，如通过 IP 访问，则可能是：120.172.2.10:3005。

4. 启动容器

在 docker-compose.yml 同级目录下执行。请确保docker-compose版本最好在2.17以上，否则可能无法执行自动化命令。

+

2. 修改环境变量

找到 yml 文件中，fastgpt 容器的环境变量进行下面操作：

无需操作
无需操作
无需操作

打开 Zilliz Cloud, 创建实例并获取相关秘钥。

zilliz_key

3. 修改 config.json 配置文件

修改config.json文件中的mcpServerProxyEndpoint值，设置成mcp server的公网可访问地址，yml 文件中默认给出了映射到 3005 端口，如通过 IP 访问，则可能是：120.172.2.10:3005。

4. 启动容器

在 docker-compose.yml 同级目录下执行。请确保docker-compose版本最好在2.17以上，否则可能无法执行自动化命令。

   # 启动容器
 docker-compose up -d

5. 访问 FastGPT

目前可以通过 ip:3000 直接访问(注意开放防火墙)。登录用户名为 root，密码为docker-compose.yml环境变量里设置的 DEFAULT_ROOT_PSW。

如果需要域名访问，请自行安装并配置 Nginx。

首次运行，会自动初始化 root 用户，密码为 1234（与环境变量中的DEFAULT_ROOT_PSW一致），日志可能会提示一次MongoServerError: Unable to read from a snapshot due to pending collection catalog changes;可忽略。

6. 配置模型

  • 首次登录FastGPT后，系统会提示未配置语言模型和索引模型，并自动跳转模型配置页面。系统必须至少有这两类模型才能正常使用。
  • 如果系统未正常跳转，可以在账号-模型提供商页面，进行模型配置。点击查看相关教程
  • 目前已知可能问题：首次进入系统后，整个浏览器 tab 无法响应。此时需要删除该tab，重新打开一次即可。

FAQ

登录系统后，浏览器无法响应

无法点击任何内容，刷新也无效。此时需要删除该tab，重新打开一次即可。

Mongo 副本集自动初始化失败

最新的 docker-compose 示例优化 Mongo 副本集初始化，实现了全自动。目前在 unbuntu20,22 centos7, wsl2, mac, window 均通过测试。仍无法正常启动，大部分是因为 cpu 不支持 AVX 指令集，可以切换 Mongo4.x 版本。

如果是由于，无法自动初始化副本集合，可以手动初始化副本集：

  1. 终端中执行下面命令，创建mongo密钥：
diff --git a/docs/development/faq/index.html b/docs/development/faq/index.html
index b0e4d2c29..da9f69855 100644
--- a/docs/development/faq/index.html
+++ b/docs/development/faq/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
私有部署常见问题
upgrade

私有部署常见问题

FastGPT 私有部署常见问题

一、错误排查方式

可以先找找Issue，或新提 Issue，私有部署错误，务必提供详细的操作步骤、日志、截图，否则很难排查。

获取后端错误

  1. docker ps -a 查看所有容器运行状态，检查是否全部 running，如有异常，尝试docker logs 容器名查看对应日志。
  2. 容器都运行正常的，docker logs 容器名 查看报错日志

前端错误

前端报错时，页面会出现崩溃，并提示检查控制台日志。可以打开浏览器控制台，并查看console中的 log 日志。还可以点击对应 log 的超链接，会提示到具体错误文件，可以把这些详细错误信息提供，方便排查。

OneAPI 错误

带有requestId的，都是 OneAPI 提示错误，大部分都是因为模型接口报错。可以参考 OneAPI 常见错误

二、通用问题

前端页面崩溃

  1. 90% 情况是模型配置不正确：确保每类模型都至少有一个启用；检查模型中一些对象参数是否异常（数组和对象），如果为空，可以尝试给个空数组或空对象。
  2. 少部分是由于浏览器兼容问题，由于项目中包含一些高阶语法，可能低版本浏览器不兼容，可以将具体操作步骤和控制台中错误信息提供 issue。
  3. 关闭浏览器翻译功能，如果浏览器开启了翻译，可能会导致页面崩溃。

通过sealos部署的话，是否没有本地部署的一些限制？

这是索引模型的长度限制，通过任何方式部署都一样的，但不同索引模型的配置不一样，可以在后台修改参数。

怎么挂载小程序配置文件

将验证文件，挂载到指定位置：/app/projects/app/public/xxxx.txt

然后重启。例如:

数据库3306端口被占用了，启动服务失败

把端口映射改成 3307 之类的，例如 3307:3306。

本地部署的限制

具体内容参考https://fael3z0zfze.feishu.cn/wiki/OFpAw8XzAi36Guk8dfucrCKUnjg。

能否纯本地运行

可以。需要准备好向量模型和LLM模型。

其他模型没法进行问题分类/内容提取

  1. 看日志。如果提示 JSON invalid，not support tool 之类的，说明该模型不支持工具调用或函数调用，需要设置toolChoice=false和functionCall=false，就会默认走提示词模式。目前内置提示词仅针对了商业模型API进行测试。问题分类基本可用，内容提取不太行。
  2. 如果已经配置正常，并且没有错误日志，则说明可能提示词不太适合该模型，可以通过修改customCQPrompt来自定义提示词。

页面崩溃

  1. 关闭翻译
  2. 检查配置文件是否正常加载，如果没有正常加载会导致缺失系统信息，在某些操作下会导致空指针。
  • 95%情况是配置文件不对。会提示 xxx undefined
  • 提示URI malformed，请 Issue 反馈具体操作和页面，这是由于特殊字符串编码解析报错。
  1. 某些api不兼容问题（较少）

开启内容补全后，响应速度变慢

  1. 问题补全需要经过一轮AI生成。
  2. 会进行3~5轮的查询，如果数据库性能不足，会有明显影响。

页面中可以正常回复，API 报错

页面中是用 stream=true 模式，所以API也需要设置 stream=true 来进行测试。部分模型接口（国产居多）非 Stream 的兼容有点垃圾。 -和上一个问题一样，curl 测试。

知识库索引没有进度/索引很慢

先看日志报错信息。有以下几种情况：

  1. 可以对话，但是索引没有进度：没有配置向量模型（vectorModels）
  2. 不能对话，也不能索引：API调用失败。可能是没连上OneAPI或OpenAI
  3. 有进度，但是非常慢：api key不行，OpenAI的免费号，一分钟只有3次还是60次。一天上限200次。

Connection error

网络异常。国内服务器无法请求OpenAI，自行检查与AI模型的连接是否正常。

或者是FastGPT请求不到 OneAPI（没放同一个网络）

修改了 vectorModels 但是没有生效

  1. 重启容器，确保模型配置已经加载（可以在日志或者新建知识库时候看到新模型）
  2. 记得刷新一次浏览器。
  3. 如果是已经创建的知识库，需要删除重建。向量模型是创建时候绑定的，不会动态更新。

三、常见的 OneAPI 错误

带有 requestId 的都是 OneAPI 的报错。

insufficient_user_quota user quota is not enough

OneAPI 账号的余额不足，默认 root 用户只有 200 刀，可以手动修改。

路径：打开OneAPI -> 用户 -> root用户右边的编辑 -> 剩余余额调大

xxx渠道找不到

FastGPT 模型配置文件中的 model 必须与 OneAPI 渠道中的模型对应上，否则就会提示这个错误。可检查下面内容：

  1. OneAPI 中没有配置该模型渠道，或者被禁用了。
  2. FastGPT 配置文件有 OneAPI 没有配置的模型。如果 OneAPI 没有配置对应模型的，配置文件中也不要写。
  3. 使用旧的向量模型创建了知识库，后又更新了向量模型。这时候需要删除以前的知识库，重建。

如果OneAPI中，没有配置对应的模型，config.json中也不要配置，否则容易报错。

点击模型测试失败

OneAPI 只会测试渠道的第一个模型，并且只会测试对话模型，向量模型无法自动测试，需要手动发起请求进行测试。查看测试模型命令示例

get request url failed: Post “https://xxx dial tcp: xxxx

OneAPI 与模型网络不通，需要检查网络配置。

Incorrect API key provided: sk-xxxx.You can find your api Key at xxx

OneAPI 的 API Key 配置错误，需要修改OPENAI_API_KEY环境变量，并重启容器（先 docker-compose down 然后再 docker-compose up -d 运行一次）。

可以exec进入容器，env查看环境变量是否生效。

bad_response_status_code bad response status code 503

  1. 模型服务不可用
  2. 模型接口参数异常（温度、max token等可能不适配）
  3. ….

Tiktoken 下载失败

由于 OneAPI 会在启动时从网络下载一个 tiktoken 的依赖，如果网络异常，就会导致启动失败。可以参考OneAPI 离线部署解决。

四、常见模型问题

如何检查模型可用性问题

  1. 私有部署模型，先确认部署的模型是否正常。
  2. 通过 CURL 请求，直接测试上游模型是否正常运行（云端模型或私有模型均进行测试）
  3. 通过 CURL 请求，请求 OneAPI 去测试模型是否正常。
  4. 在 FastGPT 中使用该模型进行测试。

下面是几个测试 CURL 示例：

+和上一个问题一样，curl 测试。
知识库索引没有进度/索引很慢 
先看日志报错信息。有以下几种情况：
  1. 可以对话，但是索引没有进度：没有配置向量模型（vectorModels）
  2. 不能对话，也不能索引：API调用失败。可能是没连上OneAPI或OpenAI
  3. 有进度，但是非常慢：api key不行，OpenAI的免费号，一分钟只有3次还是60次。一天上限200次。
Connection error 
网络异常。国内服务器无法请求OpenAI，自行检查与AI模型的连接是否正常。
或者是FastGPT请求不到 OneAPI（没放同一个网络）
修改了 vectorModels 但是没有生效 
  1. 重启容器，确保模型配置已经加载（可以在日志或者新建知识库时候看到新模型）
  2. 记得刷新一次浏览器。
  3. 如果是已经创建的知识库，需要删除重建。向量模型是创建时候绑定的，不会动态更新。
三、常见的 OneAPI 错误 
带有 requestId 的都是 OneAPI 的报错。
insufficient_user_quota user quota is not enough 
OneAPI 账号的余额不足，默认 root 用户只有 200 刀，可以手动修改。
路径：打开OneAPI -> 用户 -> root用户右边的编辑 -> 剩余余额调大
xxx渠道找不到 
FastGPT 模型配置文件中的 model 必须与 OneAPI 渠道中的模型对应上，否则就会提示这个错误。可检查下面内容：
  1. OneAPI 中没有配置该模型渠道，或者被禁用了。
  2. FastGPT 配置文件有 OneAPI 没有配置的模型。如果 OneAPI 没有配置对应模型的，配置文件中也不要写。
  3. 使用旧的向量模型创建了知识库，后又更新了向量模型。这时候需要删除以前的知识库，重建。
如果OneAPI中，没有配置对应的模型，config.json中也不要配置，否则容易报错。
点击模型测试失败 
OneAPI 只会测试渠道的第一个模型，并且只会测试对话模型，向量模型无法自动测试，需要手动发起请求进行测试。查看测试模型命令示例
get request url failed: Post “https://xxx dial tcp: xxxx 
OneAPI 与模型网络不通，需要检查网络配置。
Incorrect API key provided: sk-xxxx.You can find your api Key at xxx 
OneAPI 的 API Key 配置错误，需要修改OPENAI_API_KEY环境变量，并重启容器（先 docker-compose down 然后再 docker-compose up -d 运行一次）。
可以exec进入容器，env查看环境变量是否生效。
bad_response_status_code bad response status code 503 
  1. 模型服务不可用
  2. 模型接口参数异常（温度、max token等可能不适配）
  3. ….
Tiktoken 下载失败 
由于 OneAPI 会在启动时从网络下载一个 tiktoken 的依赖，如果网络异常，就会导致启动失败。可以参考OneAPI 离线部署解决。
四、常见模型问题 
如何检查模型可用性问题 
  1. 私有部署模型，先确认部署的模型是否正常。
  2. 通过 CURL 请求，直接测试上游模型是否正常运行（云端模型或私有模型均进行测试）
  3. 通过 CURL 请求，请求 OneAPI 去测试模型是否正常。
  4. 在 FastGPT 中使用该模型进行测试。
下面是几个测试 CURL 示例：
   curl https://api.openai.com/v1/chat/completions \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $OPENAI_API_KEY" \
@@ -57,7 +57,7 @@ Table of Contents
+  
   curl https://api.openai.com/v1/embeddings \
   -H "Authorization: Bearer $OPENAI_API_KEY" \
   -H "Content-Type: application/json" \
@@ -66,7 +66,7 @@ Table of Contents
+  
   curl --location --request POST 'https://xxxx.com/api/v1/rerank' \
 --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
 --header 'Content-Type: application/json' \
@@ -77,7 +77,7 @@ Table of Contents
+  
   curl https://api.openai.com/v1/audio/speech \
   -H "Authorization: Bearer $OPENAI_API_KEY" \
   -H "Content-Type: application/json" \
@@ -87,7 +87,7 @@ Table of Contents
+  
   curl https://api.openai.com/v1/audio/transcriptions \
   -H "Authorization: Bearer $OPENAI_API_KEY" \
   -H "Content-Type: multipart/form-data" \
diff --git a/docs/development/index.html b/docs/development/index.html
index cb992e942..ec568fb34 100644
--- a/docs/development/index.html
+++ b/docs/development/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks
 开发与部署指南
code_blocks
 开发与部署指南
code_blocks
 开发与部署指南
diff --git a/docs/development/migration/docker_mongo/index.html b/docs/development/migration/docker_mongo/index.html index b25cd8335..22219efeb 100644 --- a/docs/development/migration/docker_mongo/index.html +++ b/docs/development/migration/docker_mongo/index.html @@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
对话接口
chat

对话接口

FastGPT OpenAPI 对话接口

如何获取 AppId

可在应用详情的路径里获取 AppId。

发起对话

请求简易应用和工作流

v1对话接口兼容GPT的接口！如果你的项目使用的是标准的GPT官方接口，可以直接通过修改BaseUrl和 Authorization来访问 FastGpt 应用，不过需要注意下面几个规则：

请求 

+Table of Contents
chat

对话接口

FastGPT OpenAPI 对话接口

如何获取 AppId

可在应用详情的路径里获取 AppId。

发起对话

请求简易应用和工作流

v1对话接口兼容GPT的接口！如果你的项目使用的是标准的GPT官方接口，可以直接通过修改BaseUrl和 Authorization来访问 FastGpt 应用，不过需要注意下面几个规则：

请求 

   curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
@@ -56,7 +56,7 @@ Table of Contents
+  
   {
     "id": "adsfasf",
     "model": "",
@@ -110,7 +110,7 @@ Table of Contents
   event: flowNodeStatus
 data: {"status":"running","name":"知识库搜索"}
 
@@ -232,8 +232,8 @@ data: [DONE]
 
 event: flowResponses
 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}]
-

交互节点响应

如果工作流中包含交互节点，依然是调用该 API 接口，需要设置detail=true，并可以从event=interactive的数据中获取交互节点的配置信息。如果是stream=false，则可以从 choice 中获取type=interactive的元素，获取交互节点的选择信息。

当你调用一个带交互节点的工作流时，如果工作流遇到了交互节点，那么会直接返回，你可以得到下面的信息：

+

event取值：

  • answer: 返回给客户端的文本（最终会算作回答）
  • fastAnswer: 指定回复返回给客户端的文本（最终会算作回答）
  • toolCall: 执行工具
  • toolParams: 工具参数
  • toolResponse: 工具返回
  • flowNodeStatus: 运行到的节点状态
  • flowResponses: 节点完整响应
  • updateVariables: 更新变量
  • error: 报错

交互节点响应

如果工作流中包含交互节点，依然是调用该 API 接口，需要设置detail=true，并可以从event=interactive的数据中获取交互节点的配置信息。如果是stream=false，则可以从 choice 中获取type=interactive的元素，获取交互节点的选择信息。

当你调用一个带交互节点的工作流时，如果工作流遇到了交互节点，那么会直接返回，你可以得到下面的信息：

   {
     "interactive": {
         "type": "userSelect",
@@ -252,7 +252,7 @@ data: [{"moduleName":"知识库搜索","moduleType":"
         }
     }
 }
-  
+  
   {
     "interactive": {
         "type": "userInput",
@@ -295,8 +295,8 @@ data: [{"moduleName":"知识库搜索","moduleType":"
         }
     }
 }
-

交互节点继续运行

紧接着上一节，当你接收到交互节点信息后，可以根据这些数据进行 UI 渲染，引导用户输入或选择相关信息。然后需要再次发起对话，来继续工作流。调用的接口与仍是该接口，你需要按以下格式来发起请求：

对于用户选择，你只需要直接传递一个选择的结果给 messages 即可。

+

交互节点继续运行

紧接着上一节，当你接收到交互节点信息后，可以根据这些数据进行 UI 渲染，引导用户输入或选择相关信息。然后需要再次发起对话，来继续工作流。调用的接口与仍是该接口，你需要按以下格式来发起请求：

对于用户选择，你只需要直接传递一个选择的结果给 messages 即可。

   curl --location --request POST 'https://api.fastgpt.in/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxx' \
 --header 'Content-Type: application/json' \
@@ -311,7 +311,7 @@ data: [{"moduleName":"知识库搜索","moduleType":"
         }
     ]
 }'
-

表单输入稍微麻烦一点，需要将输入的内容，以对象形式并序列化成字符串，作为messages的值。对象的 key 对应表单的 key，value 为用户输入的值。务必确保chatId是一致的。

+

表单输入稍微麻烦一点，需要将输入的内容，以对象形式并序列化成字符串，作为messages的值。对象的 key 对应表单的 key，value 为用户输入的值。务必确保chatId是一致的。

   curl --location --request POST 'https://api.fastgpt.in/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxx' \
 --header 'Content-Type: application/json' \
@@ -337,9 +337,9 @@ data: [{"moduleName":"知识库搜索","moduleType":"
         "query":"你好" # 我的插件输入有一个参数，变量名叫 query
     }
 }'
-

响应示例

  • 插件的输出可以通过查找responseData中, moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍可以通过choices进行获取。
+

响应示例

  • 插件的输出可以通过查找responseData中, moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍可以通过choices进行获取。
   {
     "responseData": [
         {
@@ -396,7 +396,7 @@ data: [{"moduleName":"知识库搜索","moduleType":"
         }
     ]
 }
-
  • 插件的输出可以通过获取event=flowResponses中的字符串，并将其反序列化后得到一个数组。同样的，查找 moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍和对话接口一样获取。
+
  • 插件的输出可以通过获取event=flowResponses中的字符串，并将其反序列化后得到一个数组。同样的，查找 moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍和对话接口一样获取。
   event: flowNodeStatus
 data: {"status":"running","name":"AI 对话"}
 
@@ -453,9 +453,9 @@ data: [DONE]
 
 event: flowResponses
 data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对话","moduleType":"chatNode","totalPoints":0.033,"model":"FastAI-3.5","tokens":33,"query":"你好","maxToken":2000,"historyPreview":[{"obj":"Human","value":"你好"},{"obj":"AI","value":"你好！有什么可以帮助你的吗？"}],"contextTotalLen":2,"runningTime":1.42},{"nodeId":"pluginOutput","moduleName":"插件输出","moduleType":"pluginOutput","totalPoints":0,"pluginOutput":{"result":"你好！有什么可以帮助你的吗？"},"runningTime":0}]
-

event取值：

  • answer: 返回给客户端的文本（最终会算作回答）
  • fastAnswer: 指定回复返回给客户端的文本（最终会算作回答）
  • toolCall: 执行工具
  • toolParams: 工具参数
  • toolResponse: 工具返回
  • flowNodeStatus: 运行到的节点状态
  • flowResponses: 节点完整响应
  • updateVariables: 更新变量
  • error: 报错

对话 CRUD

重要字段

  • chatId - 指一个应用下，某一个对话窗口的 ID
  • dataId - 指一个对话窗口下，某一个对话记录的 ID

历史记录

获取某个应用历史记录 

+

event取值：

  • answer: 返回给客户端的文本（最终会算作回答）
  • fastAnswer: 指定回复返回给客户端的文本（最终会算作回答）
  • toolCall: 执行工具
  • toolParams: 工具参数
  • toolResponse: 工具返回
  • flowNodeStatus: 运行到的节点状态
  • flowResponses: 节点完整响应
  • updateVariables: 更新变量
  • error: 报错

对话 CRUD

重要字段

  • chatId - 指一个应用下，某一个对话窗口的 ID
  • dataId - 指一个对话窗口下，某一个对话记录的 ID

历史记录

获取某个应用历史记录 

   curl --location --request POST 'http://localhost:3000/api/core/chat/getHistories' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -465,7 +465,7 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
     "pageSize": 20,
     "source": "api"
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -492,9 +492,9 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         "total": 2
     }
 }
-

修改某个对话的标题 

+

修改某个对话的标题 

   curl --location --request POST 'http://localhost:3000/api/core/chat/updateHistory' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -503,16 +503,16 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
     "chatId": "chatId",
     "customTitle": "自定义标题"
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

置顶 / 取消置顶 

+

置顶 / 取消置顶 

   curl --location --request POST 'http://localhost:3000/api/core/chat/updateHistory' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -521,43 +521,43 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
     "chatId": "chatId",
     "top": true
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

删除某个历史记录 

+

删除某个历史记录 

   curl --location --request DELETE 'http://localhost:3000/api/core/chat/delHistory?chatId={{chatId}}&appId={{appId}}' \
 --header 'Authorization: Bearer {{apikey}}'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

清空所有历史记录

仅会情况通过 API Key 创建的对话历史记录，不会清空在线使用、分享链接等其他来源的对话历史记录。

+

清空所有历史记录

仅会情况通过 API Key 创建的对话历史记录，不会清空在线使用、分享链接等其他来源的对话历史记录。

   curl --location --request DELETE 'http://localhost:3000/api/core/chat/clearHistories?appId={{appId}}' \
 --header 'Authorization: Bearer {{apikey}}'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

对话记录

指的是某个 chatId 下的对话记录操作。

获取单个对话初始化信息 

+

对话记录

指的是某个 chatId 下的对话记录操作。

获取单个对话初始化信息 

   curl --location --request GET 'http://localhost:3000/api/core/chat/init?appId={{appId}}&chatId={{chatId}}' \
 --header 'Authorization: Bearer {{apikey}}'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -611,9 +611,9 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         }
     }
 }
-

获取对话记录列表 

+

获取对话记录列表 

   curl --location --request POST 'http://localhost:3000/api/core/chat/getPaginationRecords' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -624,7 +624,7 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
     "pageSize": 10,
     "loadCustomFeedbacks": true
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -673,12 +673,12 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         "total": 2
     }
 }
-

获取单个对话记录运行详情 

+

获取单个对话记录运行详情 

   curl --location --request GET 'http://localhost:3000/api/core/chat/getResData?appId={{appId}}&chatId={{chatId}}&dataId={{dataId}}' \
 --header 'Authorization: Bearer {{apikey}}'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -724,21 +724,21 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         }
     ]
 }
-

删除对话记录 

+

删除对话记录 

   curl --location --request DELETE 'http://localhost:3000/api/core/chat/item/delete?contentId={{contentId}}&chatId={{chatId}}&appId={{appId}}' \
 --header 'Authorization: Bearer {{apikey}}'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

点赞 / 取消点赞 

+

点赞 / 取消点赞 

   curl --location --request POST 'http://localhost:3000/api/core/chat/feedback/updateUserFeedback' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -748,16 +748,16 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
     "dataId": "dataId",
     "userGoodFeedback": "yes"
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

点踩 / 取消点踩 

+

点踩 / 取消点踩 

   curl --location --request POST 'http://localhost:3000/api/core/chat/feedback/updateUserFeedback' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -767,16 +767,16 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
     "dataId": "dataId",
     "userBadFeedback": "yes"
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

猜你想问

4.8.16 后新版接口

新版猜你想问，必须包含 appId 和 chatId 的参数才可以进行使用。会自动根据 chatId 去拉取最近 6 轮对话记录作为上下文来引导回答。

+

猜你想问

4.8.16 后新版接口

新版猜你想问，必须包含 appId 和 chatId 的参数才可以进行使用。会自动根据 chatId 去拉取最近 6 轮对话记录作为上下文来引导回答。

   curl --location --request POST 'http://localhost:3000/api/core/ai/agent/v2/createQuestionGuide' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -789,7 +789,7 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         "customPrompt": "你是一个智能助手，请根据用户的问题生成猜你想问。"
     }
 }'
-  
   {
     "code": 200,
     "statusText": "",
@@ -810,9 +810,9 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         "你希望AI能做什么？"
     ]
 }
-

4.8.16 前旧版接口：

+

4.8.16 前旧版接口：

   curl --location --request POST 'http://localhost:3000/api/core/ai/agent/createQuestionGuide' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -828,7 +828,7 @@ data: [{"nodeId":"fdDgXQ6SYn8v","moduleName":"AI 对
         }
     ]
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
diff --git a/docs/development/openapi/dataset/index.html b/docs/development/openapi/dataset/index.html
index c7ac6e6fc..fd076e980 100644
--- a/docs/development/openapi/dataset/index.html
+++ b/docs/development/openapi/dataset/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
知识库接口
dataset

知识库接口

FastGPT OpenAPI 知识库接口

如何获取知识库ID（datasetId）如何获取文件集合ID（collection_id）

创建训练订单

新例子

+Table of Contents
dataset

知识库接口

FastGPT OpenAPI 知识库接口

如何获取知识库ID（datasetId）如何获取文件集合ID（collection_id）

创建训练订单

新例子

   curl --location --request POST 'http://localhost:3000/api/support/wallet/usage/createTrainingUsage' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -43,16 +43,16 @@ Table of Contents

data 为 billId，可用于添加知识库数据时进行账单聚合。

+

data 为 billId，可用于添加知识库数据时进行账单聚合。

   {
   "code": 200,
   "statusText": "",
   "message": "",
   "data": "65112ab717c32018f4156361"
 }
-

知识库

创建一个知识库 

+

知识库

创建一个知识库 

   curl --location --request POST 'http://localhost:3000/api/core/dataset/create' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -65,23 +65,23 @@ Table of Contents
+  
   {
   "code": 200,
   "statusText": "",
   "message": "",
   "data": "65abc9bd9d1448617cba5e6c"
 }
-

获取知识库列表 

+

获取知识库列表 

   curl --location --request POST 'http://localhost:3000/api/core/dataset/list?parentId=' \
 --header 'Authorization: Bearer xxxx' \
 --header 'Content-Type: application/json' \
 --data-raw '{
     "parentId":""
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -108,12 +108,12 @@ Table of Contents

获取知识库详情 

+

获取知识库详情 

   curl --location --request GET 'http://localhost:3000/api/core/dataset/detail?id=6593e137231a2be9c5603ba7' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -149,21 +149,21 @@ Table of Contents

删除一个知识库 

+

删除一个知识库 

   curl --location --request DELETE 'http://localhost:3000/api/core/dataset/delete?id=65abc8729d1448617cba5df6' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

集合

通用创建参数说明（必看）

入参

参数说明必填
datasetId知识库ID✅
parentId：父级ID，不填则默认为根目录
trainingType数据处理方式。chunk: 按文本长度进行分割;qa: 问答对提取✅
autoIndexes是否自动生成索引(仅商业版支持)
imageIndex是否自动生成图片索引(仅商业版支持)
chunkSettingMode分块参数模式。auto: 系统默认参数; custom: 手动指定参数
chunkSplitMode分块拆分模式。size: 按长度拆分; char: 按字符拆分。chunkSettingMode=auto时不生效。
chunkSize分块大小，默认 1500。chunkSettingMode=auto时不生效。
indexSize索引大小，默认 512，必须小于索引模型最大token。chunkSettingMode=auto时不生效。
chunkSplitter自定义最高优先分割符号，除非超出文件处理最大上下文，否则不会进行进一步拆分。chunkSettingMode=auto时不生效。
qaPromptqa拆分提示词
tags集合标签（字符串数组）
createTime文件创建时间（Date / String）

出参

  • collectionId - 新建的集合ID
  • insertLen：插入的块数量

创建一个空的集合 

+

集合

通用创建参数说明（必看）

入参

参数说明必填
datasetId知识库ID✅
parentId：父级ID，不填则默认为根目录
trainingType数据处理方式。chunk: 按文本长度进行分割;qa: 问答对提取✅
autoIndexes是否自动生成索引(仅商业版支持)
imageIndex是否自动生成图片索引(仅商业版支持)
chunkSettingMode分块参数模式。auto: 系统默认参数; custom: 手动指定参数
chunkSplitMode分块拆分模式。size: 按长度拆分; char: 按字符拆分。chunkSettingMode=auto时不生效。
chunkSize分块大小，默认 1500。chunkSettingMode=auto时不生效。
indexSize索引大小，默认 512，必须小于索引模型最大token。chunkSettingMode=auto时不生效。
chunkSplitter自定义最高优先分割符号，除非超出文件处理最大上下文，否则不会进行进一步拆分。chunkSettingMode=auto时不生效。
qaPromptqa拆分提示词
tags集合标签（字符串数组）
createTime文件创建时间（Date / String）

出参

  • collectionId - 新建的集合ID
  • insertLen：插入的块数量

创建一个空的集合 

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -176,16 +176,16 @@ Table of Contents

data 为集合的 ID。

+

data 为集合的 ID。

   {
   "code": 200,
   "statusText": "",
   "message": "",
   "data": "65abcd009d1448617cba5ee1"
 }
-

创建一个纯文本集合

传入一段文字，创建一个集合，会根据传入的文字进行分割。

+

创建一个纯文本集合

传入一段文字，创建一个集合，会根据传入的文字进行分割。

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/text' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -201,7 +201,7 @@ Table of Contents

data 为集合的 ID。

+

data 为集合的 ID。

   {
   "code": 200,
   "statusText": "",
@@ -216,9 +216,9 @@ Table of Contents

创建一个链接集合

传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。

+

创建一个链接集合

传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/link' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -235,7 +235,7 @@ Table of Contents

data 为集合的 ID。

+

data 为集合的 ID。

   {
     "code": 200,
     "statusText": "",
@@ -250,14 +250,14 @@ Table of Contents

创建一个文件集合

传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。

使用代码上传时，请注意中文 filename 需要进行 encode 处理，否则容易乱码。

+

创建一个文件集合

传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。

使用代码上传时，请注意中文 filename 需要进行 encode 处理，否则容易乱码。

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/localFile' \
 --header 'Authorization: Bearer {{authorization}}' \
 --form 'file=@"C:\\Users\\user\\Desktop\\fastgpt测试文件\\index.html"' \
 --form 'data="{\"datasetId\":\"6593e137231a2be9c5603ba7\",\"parentId\":null,\"trainingType\":\"chunk\",\"chunkSize\":512,\"chunkSplitter\":\"\",\"qaPrompt\":\"\",\"metadata\":{}}"'
-

需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。

data 为集合的 ID。

+

需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。

data 为集合的 ID。

   {
     "code": 200,
     "statusText": "",
@@ -272,9 +272,9 @@ Table of Contents

创建一个API集合

传入一个文件的 id，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。

使用代码上传时，请注意中文 filename 需要进行 encode 处理，否则容易乱码。

+

创建一个API集合

传入一个文件的 id，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。

使用代码上传时，请注意中文 filename 需要进行 encode 处理，否则容易乱码。

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/apiCollection' \
 --header 'Authorization: Bearer fastgpt-xxx' \
 --header 'Content-Type: application/json' \
@@ -290,7 +290,7 @@ Table of Contents

需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。

data 为集合的 ID。

+

需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。

data 为集合的 ID。

   {
     "code": 200,
     "statusText": "",
@@ -305,9 +305,9 @@ Table of Contents

创建一个外部文件库集合（商业版） 

+

创建一个外部文件库集合（商业版） 

   curl --location --request POST 'http://localhost:3000/api/proApi/core/dataset/collection/create/externalFileUrl' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
@@ -326,7 +326,7 @@ Table of Contents
参数说明必填
externalFileUrl文件访问链接（可以是临时链接）✅
externalFileId外部文件ID
filename自定义文件名，需要带后缀
createTime文件创建时间（Date ISO 字符串都 ok）

data 为集合的 ID。

+
参数说明必填
externalFileUrl文件访问链接（可以是临时链接）✅
externalFileId外部文件ID
filename自定义文件名，需要带后缀
createTime文件创建时间（Date ISO 字符串都 ok）

data 为集合的 ID。

   {
   "code": 200,
   "statusText": "",
@@ -341,9 +341,9 @@ Table of Contents

获取集合列表

4.8.19+

+

获取集合列表

4.8.19+

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/listV2' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -365,7 +365,7 @@ Table of Contents
+  
   {
     "code": 200,
     "statusText": "",
@@ -425,12 +425,12 @@ Table of Contents

获取集合详情 

+

获取集合详情 

   curl --location --request GET 'http://localhost:3000/api/core/dataset/collection/detail?id=65abcfab9d1448617cba5f0d' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -469,9 +469,9 @@ Table of Contents

修改集合信息

通过集合 ID 修改集合信息

+

修改集合信息

通过集合 ID 修改集合信息

   curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -496,29 +496,29 @@ Table of Contents
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

删除一个集合 

+

删除一个集合 

   curl --location --request DELETE 'http://localhost:3000/api/core/dataset/collection/delete?id=65aa2a64e6cb9b8ccdc00de8' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

数据

数据的结构

Data结构

字段类型说明必填
teamIdString团队ID✅
tmbIdString成员ID✅
datasetIdString知识库ID✅
collectionIdString集合ID✅
qString主要数据✅
aString辅助数据✖
fullTextTokenString分词✖
indexesIndex[]向量索引✅
updateTimeDate更新时间✅
chunkIndexNumber分块下表✖

Index结构

每组数据的自定义索引最多5个

字段类型说明必填
typeString可选索引类型：default-默认索引; custom-自定义索引; summary-总结索引; question-问题索引; image-图片索引
dataIdString关联的向量ID，变更数据时候传入该 ID，会进行差量更新，而不是全量更新
textString文本内容✅

type 不填则默认为 custom 索引，还会基于 q/a 组成一个默认索引。如果传入了默认索引，则不会额外创建。

为集合批量添加添加数据

注意，每次最多推送 200 组数据。

+

数据

数据的结构

Data结构

字段类型说明必填
teamIdString团队ID✅
tmbIdString成员ID✅
datasetIdString知识库ID✅
collectionIdString集合ID✅
qString主要数据✅
aString辅助数据✖
fullTextTokenString分词✖
indexesIndex[]向量索引✅
updateTimeDate更新时间✅
chunkIndexNumber分块下表✖

Index结构

每组数据的自定义索引最多5个

字段类型说明必填
typeString可选索引类型：default-默认索引; custom-自定义索引; summary-总结索引; question-问题索引; image-图片索引
dataIdString关联的向量ID，变更数据时候传入该 ID，会进行差量更新，而不是全量更新
textString文本内容✅

type 不填则默认为 custom 索引，还会基于 q/a 组成一个默认索引。如果传入了默认索引，则不会额外创建。

为集合批量添加添加数据

注意，每次最多推送 200 组数据。

   curl --location --request POST 'https://api.fastgpt.in/api/core/dataset/data/pushData' \
 --header 'Authorization: Bearer apikey' \
 --header 'Content-Type: application/json' \
@@ -546,7 +546,7 @@ Table of Contents
+  
   {
     "code": 200,
     "statusText": "",
@@ -557,7 +557,7 @@ Table of Contents

{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容

+

{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容

   我会给你一段文本，{{theme}}，学习它们，并整理学习成果，要求为：
 1. 提出最多 25 个问题。
 2. 给出每个问题的答案。
@@ -571,9 +571,9 @@ A2:
 ……
 
 我的文本："""{{text}}"""
-

获取集合的数据列表

4.8.11+

+

获取集合的数据列表

4.8.11+

   curl --location --request POST 'http://localhost:3000/api/core/dataset/data/v2/list' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -593,7 +593,7 @@ A2:
     "collectionId":"65abd4ac9d1448617cba6171",
     "searchText":""
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -620,12 +620,12 @@ A2:
         "total": 63
     }
 }
-

获取单条数据详情 

+

获取单条数据详情 

   curl --location --request GET 'http://localhost:3000/api/core/dataset/data/detail?id=65abd4b29d1448617cba61db' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -651,9 +651,9 @@ A2:
         "canWrite": true
     }
 }
-

修改单条数据 

+

修改单条数据 

   curl --location --request PUT 'http://localhost:3000/api/core/dataset/data/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -678,28 +678,28 @@ A2:
         }
     ]
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

删除单条数据 

+

删除单条数据 

   curl --location --request DELETE 'http://localhost:3000/api/core/dataset/data/delete?id=65abd4b39d1448617cba624d' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
   "code": 200,
   "statusText": "",
   "message": "",
   "data": "success"
 }
-

搜索测试 

+

搜索测试 

   curl --location --request POST 'https://api.fastgpt.in/api/core/dataset/searchTest' \
 --header 'Authorization: Bearer fastgpt-xxxxx' \
 --header 'Content-Type: application/json' \
@@ -715,7 +715,7 @@ A2:
     "datasetSearchExtensionModel": "gpt-4o-mini",
     "datasetSearchExtensionBg": ""
 }'
-

返回 top k 结果， limit 为最大 Tokens 数量，最多 20000 tokens。

+

返回 top k 结果， limit 为最大 Tokens 数量，最多 20000 tokens。

   {
   "code": 200,
   "statusText": "",
diff --git a/docs/development/openapi/index.html b/docs/development/openapi/index.html
index 194975000..8cb4ab5d6 100644
--- a/docs/development/openapi/index.html
+++ b/docs/development/openapi/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南

FastGPT 将会判断success是否为true决定是允许用户继续操作。message与msg是等同的，你可以选择返回其中一个，当success不为true时，将会提示这个错误。

uid是用户的唯一凭证，将会用于拉取对话记录以及保存对话记录。可参考下方实践案例。

触发流程

配置教程

1. 配置身份校验地址

配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。

2. 分享链接中增加额外 query

在分享链接的地址中，增加一个额外的参数: authToken。例如：

原始的链接：https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192

完整链接: https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192&authToken=userid12345

这个authToken通常是你系统生成的用户唯一凭证（Token之类的）。FastGPT 会在鉴权接口的body中携带 token={{authToken}} 的参数。

3. 编写聊天初始化校验接口 

+

FastGPT 将会判断success是否为true决定是允许用户继续操作。message与msg是等同的，你可以选择返回其中一个，当success不为true时，将会提示这个错误。

uid是用户的唯一凭证，将会用于拉取对话记录以及保存对话记录。可参考下方实践案例。

触发流程

配置教程

1. 配置身份校验地址

配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。

2. 分享链接中增加额外 query

在分享链接的地址中，增加一个额外的参数: authToken。例如：

原始的链接：https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192

完整链接: https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192&authToken=userid12345

这个authToken通常是你系统生成的用户唯一凭证（Token之类的）。FastGPT 会在鉴权接口的body中携带 token={{authToken}} 的参数。

3. 编写聊天初始化校验接口 

   curl --location --request POST '{{host}}/shareAuth/init' \
 --header 'Content-Type: application/json' \
 --data-raw '{
     "token": "{{authToken}}"
 }'
-  
+  
   {
     "success": true,
     "data": {
         "uid": "用户唯一凭证"
     }
 }
-

系统会拉取该分享链接下，uid 为 username123 的对话记录。

+

系统会拉取该分享链接下，uid 为 username123 的对话记录。

   {
     "success": false,
     "message": "身份错误",
 }
-

4. 编写对话前校验接口 

+

4. 编写对话前校验接口 

   curl --location --request POST '{{host}}/shareAuth/start' \
 --header 'Content-Type: application/json' \
 --data-raw '{
     "token": "{{authToken}}",
     "question": "用户问题",
 }'
-  
+  
   {
     "success": true,
     "data": {
         "uid": "用户唯一凭证"
     }
 }
-  
+  
   {
     "success": false,
     "message": "身份验证失败",
@@ -202,9 +202,9 @@ Table of Contents

实践案例

我们以Laf作为服务器为例，简单展示这 3 个接口的使用方式。

1. 创建3个Laf接口

这个接口中，我们设置了token必须等于fastgpt才能通过校验。（实际生产中不建议固定写死）

+

实践案例

我们以Laf作为服务器为例，简单展示这 3 个接口的使用方式。

1. 创建3个Laf接口

这个接口中，我们设置了token必须等于fastgpt才能通过校验。（实际生产中不建议固定写死）

   import cloud from '@lafjs/cloud'
 
 export default async function (ctx: FunctionContext) {
@@ -217,7 +217,7 @@ export default async function (ctx: FunctionContext) {
 
   return { success: false,message:"身份错误" }
 }
-

这个接口中，我们设置了token必须等于fastgpt才能通过校验。并且如果问题中包含了你字，则会报错，用于模拟敏感校验。

+

这个接口中，我们设置了token必须等于fastgpt才能通过校验。并且如果问题中包含了你字，则会报错，用于模拟敏感校验。

   import cloud from '@lafjs/cloud'
 
 export default async function (ctx: FunctionContext) {
@@ -235,7 +235,7 @@ export default async function (ctx: FunctionContext) {
 
   return { success: true, data: { uid: "user1" } } 
 }
-

结果上报接口可自行进行逻辑处理。

+

结果上报接口可自行进行逻辑处理。

   import cloud from '@lafjs/cloud'
 
 export default async function (ctx: FunctionContext) {
diff --git a/docs/development/proxy/cloudflare/index.html b/docs/development/proxy/cloudflare/index.html
index 2201e05f3..3c81f9d7f 100644
--- a/docs/development/proxy/cloudflare/index.html
+++ b/docs/development/proxy/cloudflare/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
V4.9.5
upgrade

V4.9.5

FastGPT V4.9.5 更新说明

升级指南

1. 做好数据备份

2. 更新镜像 tag

  • 更新 FastGPT 镜像 tag: v4.9.5
  • 更新 FastGPT 商业版镜像 tag: v4.9.5
  • Sandbox 无需更新
  • AIProxy 无需更新

🚀 新增内容

  1. 团队成员权限细分，可分别控制是否可创建在根目录应用/知识库以及 API Key
  2. 支持交互节点在嵌套工作流中使用。
  3. 团队成员操作日志。
  4. 用户输入节点支持多选框。

⚙️ 优化

  1. 繁体中文翻译。
  2. Arm 镜像打包

🐛 修复

  1. password 检测规则错误。
  2. 分享链接无法隐藏知识库检索结果。
  3. IOS 低版本正则兼容问题。
  4. 修复问答提取队列错误后，计数器未清零问题，导致问答提取队列失效。
  5. Debug 模式交互节点下一步可能造成死循环。
编辑此页面
diff --git a/docs/development/upgrading/496/index.html b/docs/development/upgrading/496/index.html index 9e0d1c48a..9e38032fe 100644 --- a/docs/development/upgrading/496/index.html +++ b/docs/development/upgrading/496/index.html @@ -1,4 +1,4 @@ -V4.9.6(进行中) | FastGPT
diff --git a/docs/development/upgrading/index.xml b/docs/development/upgrading/index.xml index f5812716f..5cf8a3449 100644 --- a/docs/development/upgrading/index.xml +++ b/docs/development/upgrading/index.xml @@ -9,7 +9,8 @@ docker-compose pull docker-compose up -d 执行升级初始化脚本 link镜像 QA link为什么需要执行升级脚本 link数据表出现大幅度变更，无法通过设置默认值，或复杂度较高时，会通过升级脚本来更新部分数据表字段。 严格按初始化步骤进行操作，不会造成旧数据丢失。但在初始化过程中，如果数据量大，需要初始化的时间较长，这段时间可能会造成服务无法正常使用。 {{host}} 是什么 link{{}} 代表变量， {{host}}代表一个名为 host 的变量。指的是你服务器的域名或 IP。 Sealos 中，你可以在下图中找到你的域名： -如何获取 rootkey link从docker-compose.yml中的environment中获取，对应的是ROOT_KEY的值。V4.9.6(进行中)https://doc.tryfastgpt.ai/docs/development/upgrading/496/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/496/🚀 新增内容 link 以 MCP 方式对外提供应用调用。 支持以 MCP SSE 协议创建工具。 批量执行节点支持交互节点，可实现每一轮循环都人工参与。 增加工作台二级菜单，合并工具箱。 增加 grok3、GPT4.1、o系列、Gemini2.5 模型系统配置。 ⚙️ 优化 link 工作流数据类型转化鲁棒性和兼容性增强。 Python sandbox 代码，支持大数据输入。 路径组件支持配置最后一步是否可点击。 知识库工具调用结果，自动补充图片域名。 Github action runner 升级成 unbuntu24 去除飞书、公众号等三方渠道，回复时，可能前后多一个换行的问题。 调整分块策略，大表格时，不进行超大块合并，而是独立拆块。 Iframe 嵌套组件，内置允许麦克风声明。 🐛 修复 link 修复子工作流包含交互节点时，未成功恢复子工作流所有数据。 completion v1 接口，未接受 interactive 参数，导致 API 调用失败。 连续工具调用，上下文截断异常V4.9.5https://doc.tryfastgpt.ai/docs/development/upgrading/495/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/495/升级指南 link1. 做好数据备份 link2. 更新镜像 tag link 更新 FastGPT 镜像 tag: v4.9.5 更新 FastGPT 商业版镜像 tag: v4.9.5 Sandbox 无需更新 AIProxy 无需更新 🚀 新增内容 link 团队成员权限细分，可分别控制是否可创建在根目录应用/知识库以及 API Key 支持交互节点在嵌套工作流中使用。 团队成员操作日志。 用户输入节点支持多选框。 ⚙️ 优化 link 繁体中文翻译。 Arm 镜像打包 🐛 修复 link password 检测规则错误。 分享链接无法隐藏知识库检索结果。 IOS 低版本正则兼容问题。 修复问答提取队列错误后，计数器未清零问题，导致问答提取队列失效。 Debug 模式交互节点下一步可能造成死循环。V4.9.4https://doc.tryfastgpt.ai/docs/development/upgrading/494/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/494/升级指南 link1. 做好数据备份 link2. 安装 Redis link docker 部署的用户，参考最新的 docker-compose.yml 文件增加 Redis 配置。增加一个 redis 容器，并配置fastgpt,fastgpt-pro的环境变量，增加 REDIS_URL 环境变量。 Sealos 部署的用户，在数据库里新建一个redis数据库，并复制内网地址的 connection 作为 redis 的链接串。然后配置fastgpt,fastgpt-pro的环境变量，增加 REDIS_URL 环境变量。 3. 更新镜像 tag link 更新 FastGPT 镜像 tag: v4.9.4 更新 FastGPT 商业版镜像 tag: v4.9.4 Sandbox 无需更新 AIProxy 无需更新 4. 执行升级脚本 link该脚本仅需商业版用户执行。 +如何获取 rootkey link从docker-compose.yml中的environment中获取，对应的是ROOT_KEY的值。V4.9.6https://doc.tryfastgpt.ai/docs/development/upgrading/496/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/496/🚀 新增内容 link 以 MCP 方式对外提供应用调用。 支持以 MCP SSE 协议创建工具。 批量执行节点支持交互节点，可实现每一轮循环都人工参与。 增加工作台二级菜单，合并工具箱。 增加 grok3、GPT4.1、o系列、Gemini2.5 模型系统配置。 ⚙️ 优化 link 工作流数据类型转化鲁棒性和兼容性增强。 Python sandbox 代码，支持大数据输入。 路径组件支持配置最后一步是否可点击。 知识库工具调用结果，自动补充图片域名。 Github action runner 升级成 unbuntu24 去除飞书、公众号等三方渠道，回复时，可能前后多一个换行的问题。 调整分块策略，大表格时，不进行超大块合并，而是独立拆块。 Iframe 嵌套组件，内置允许麦克风声明。 🐛 修复 link 修复子工作流包含交互节点时，未成功恢复子工作流所有数据。 completion v1 接口，未接受 interactive 参数，导致 API 调用失败。 连续工具调用，上下文截断异常 升级指南 link1. 做好数据备份 link2. 部署 MCP server 服务 linkDocker 部署 link在docker-compose.yml文件中，加入fastgpt-mcp-server服务: +fastgpt-mcp-server: container_name: fastgpt-mcp-server image: ghcr.io/labring/fastgpt-mcp_server:v4.9.6 ports: - 3005:3000 networks: - fastgpt restart: always environment: - FASTGPT_ENDPOINT=http://fastgpt:3000 Sealos 部署 link直接在应用管理中，增加一个fastgpt-mcp-server应用，镜像为ghcr.V4.9.5https://doc.tryfastgpt.ai/docs/development/upgrading/495/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/495/升级指南 link1. 做好数据备份 link2. 更新镜像 tag link 更新 FastGPT 镜像 tag: v4.9.5 更新 FastGPT 商业版镜像 tag: v4.9.5 Sandbox 无需更新 AIProxy 无需更新 🚀 新增内容 link 团队成员权限细分，可分别控制是否可创建在根目录应用/知识库以及 API Key 支持交互节点在嵌套工作流中使用。 团队成员操作日志。 用户输入节点支持多选框。 ⚙️ 优化 link 繁体中文翻译。 Arm 镜像打包 🐛 修复 link password 检测规则错误。 分享链接无法隐藏知识库检索结果。 IOS 低版本正则兼容问题。 修复问答提取队列错误后，计数器未清零问题，导致问答提取队列失效。 Debug 模式交互节点下一步可能造成死循环。V4.9.4https://doc.tryfastgpt.ai/docs/development/upgrading/494/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/494/升级指南 link1. 做好数据备份 link2. 安装 Redis link docker 部署的用户，参考最新的 docker-compose.yml 文件增加 Redis 配置。增加一个 redis 容器，并配置fastgpt,fastgpt-pro的环境变量，增加 REDIS_URL 环境变量。 Sealos 部署的用户，在数据库里新建一个redis数据库，并复制内网地址的 connection 作为 redis 的链接串。然后配置fastgpt,fastgpt-pro的环境变量，增加 REDIS_URL 环境变量。 3. 更新镜像 tag link 更新 FastGPT 镜像 tag: v4.9.4 更新 FastGPT 商业版镜像 tag: v4.9.4 Sandbox 无需更新 AIProxy 无需更新 4. 执行升级脚本 link该脚本仅需商业版用户执行。 从任意终端，发起 1 个 HTTP 请求。其中 {{rootkey}} 替换成环境变量里的 rootkey；{{host}} 替换成FastGPT 域名。 curl --location --request POST 'https://{{host}}/api/admin/initv494' \ --header 'rootkey: {{rootkey}}' \ --header 'Content-Type: application/json' 脚本功能V4.9.3https://doc.tryfastgpt.ai/docs/development/upgrading/493/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/493/更新指南 link1. 做好数据库备份 link2. 更新镜像 link 更新 FastGPT 镜像 tag: v4.9.3 更新 FastGPT 商业版镜像 tag: v4.9.3 Sandbox 镜像tag: v4.9.3 AIProxy 镜像tag: v0.1.5 🚀 新增内容 link 工作流 debug 模式支持交互节点。 代码运行支持 Python3 代码。 🐛 修复 link 工作流格式转化异常。V4.9.2https://doc.tryfastgpt.ai/docs/development/upgrading/492/Mon, 01 Jan 0001 00:00:00 +0000https://doc.tryfastgpt.ai/docs/development/upgrading/492/更新指南 link可直接升级v4.9.3，v4.9.2存在一个工作流数据类型转化错误。 1. 做好数据库备份 link2. SSO 迁移 link使用了 SSO 或成员同步的商业版用户，并且是对接钉钉、企微的，需要迁移已有的 SSO 相关配置: diff --git a/docs/development/upgrading/intro/index.html b/docs/development/upgrading/intro/index.html index aef60a60a..50523e5e7 100644 --- a/docs/development/upgrading/intro/index.html +++ b/docs/development/upgrading/intro/index.html @@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南

标准接口文档

以下是 FastGPT-pro 中，SSO 和成员同步的标准接口文档，如果需要对接非标准系统，可以参考该章节进行开发。

FastGPT 提供如下标准接口支持：

  1. https://example.com/login/oauth/getAuthURL 获取鉴权重定向地址
  2. https://example.com/login/oauth/getUserInfo?code=xxxxx 消费 code，换取用户信息
  3. https://example.com/org/list 获取组织列表
  4. https://example.com/user/list 获取成员列表

获取 SSO 登录重定向地址

返回一个重定向登录地址，fastgpt 会自动重定向到该地址。redirect_uri 会自动拼接到该地址的 query中。

+

标准接口文档

以下是 FastGPT-pro 中，SSO 和成员同步的标准接口文档，如果需要对接非标准系统，可以参考该章节进行开发。

FastGPT 提供如下标准接口支持：

  1. https://example.com/login/oauth/getAuthURL 获取鉴权重定向地址
  2. https://example.com/login/oauth/getUserInfo?code=xxxxx 消费 code，换取用户信息
  3. https://example.com/org/list 获取组织列表
  4. https://example.com/user/list 获取成员列表

获取 SSO 登录重定向地址

返回一个重定向登录地址，fastgpt 会自动重定向到该地址。redirect_uri 会自动拼接到该地址的 query中。

   curl -X GET "https://redict.example/login/oauth/getAuthURL?redirect_uri=xxx&state=xxxx" \
 -H "Authorization: Bearer your_token_here" \
 -H "Content-Type: application/json"
-

成功：

+

成功：

   {
   "success": true,
   "message": "",
@@ -177,12 +177,12 @@ Table of Contents

SSO 获取用户信息

该接口接受一个 code 参数作为鉴权，消费 code 返回用户信息。

+

SSO 获取用户信息

该接口接受一个 code 参数作为鉴权，消费 code 返回用户信息。

   curl -X GET "https://oauth.example/login/oauth/getUserInfo?code=xxxxxx" \
 -H "Authorization: Bearer your_token_here" \
 -H "Content-Type: application/json"
-

成功：

+

成功：

   {
   "success": true,
   "message": "",
@@ -199,12 +199,12 @@ Table of Contents

获取组织 

+

获取组织 

   curl -X GET "https://example.com/org/list" \
 -H "Authorization: Bearer your_token_here" \
 -H "Content-Type: application/json"
-

⚠️注意：只能存在一个根部门。如果你的系统中存在多个根部门，需要先进行处理，加一个虚拟的根部门。返回值类型：

+

⚠️注意：只能存在一个根部门。如果你的系统中存在多个根部门，需要先进行处理，加一个虚拟的根部门。返回值类型：

   type OrgListResponseType = {
     message?: string; // 报错信息
     success: boolean;
@@ -231,12 +231,12 @@ Table of Contents

获取成员 

+

获取成员 

   curl -X GET "https://example.com/user/list" \
 -H "Authorization: Bearer your_token_here" \
 -H "Content-Type: application/json"
-

返回值类型：

+

返回值类型：

   type UserListResponseListType = {
     message?: string; // 报错信息
     success: boolean;
diff --git a/docs/guide/admin/teammode/index.html b/docs/guide/admin/teammode/index.html
index a18a63ab7..a98474c85 100644
--- a/docs/guide/admin/teammode/index.html
+++ b/docs/guide/admin/teammode/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
HTTP 请求
http

HTTP 请求

FastGPT HTTP 模块介绍

特点

  • 可重复添加
  • 手动配置
  • 触发执行
  • 核中核模块

介绍

HTTP 模块会向对应的地址发送一个 HTTP 请求，实际操作与 Postman 和 ApiFox 这类直流工具使用差不多。

  • Params 为路径请求参数，GET请求中用的居多。
  • Body 为请求体，POST/PUT请求中用的居多。
  • Headers 为请求头，用于传递一些特殊的信息。
  • 自定义变量中可以接收前方节点的输出作为变量
  • 3 种数据中均可以通过 {{}} 来引用变量。
  • url 也可以通过 {{}} 来引用变量。
  • 变量来自于全局变量、系统变量、前方节点输出

参数结构

系统变量说明

你可以将鼠标放置在请求参数旁边的问号中，里面会提示你可用的变量。

  • appId: 应用的ID
  • chatId: 当前对话的ID，测试模式下不存在。
  • responseChatItemId: 当前对话中，响应的消息ID，测试模式下不存在。
  • variables: 当前对话的全局变量。
  • cTime: 当前时间。
  • histories: 历史记录（默认最多取10条，无法修改长度）

Params, Headers

不多描述，使用方法和Postman, ApiFox 基本一致。

可通过 {{key}} 来引入变量。例如：

keyvalue
appId{{appId}}
AuthorizationBearer {{token}}

Body

只有特定请求类型下会生效。

可以写一个自定义的 Json，并通过 {{key}} 来引入变量。例如：

+Table of Contents
http

HTTP 请求

FastGPT HTTP 模块介绍

特点

  • 可重复添加
  • 手动配置
  • 触发执行
  • 核中核模块

介绍

HTTP 模块会向对应的地址发送一个 HTTP 请求，实际操作与 Postman 和 ApiFox 这类直流工具使用差不多。

  • Params 为路径请求参数，GET请求中用的居多。
  • Body 为请求体，POST/PUT请求中用的居多。
  • Headers 为请求头，用于传递一些特殊的信息。
  • 自定义变量中可以接收前方节点的输出作为变量
  • 3 种数据中均可以通过 {{}} 来引用变量。
  • url 也可以通过 {{}} 来引用变量。
  • 变量来自于全局变量、系统变量、前方节点输出

参数结构

系统变量说明

你可以将鼠标放置在请求参数旁边的问号中，里面会提示你可用的变量。

  • appId: 应用的ID
  • chatId: 当前对话的ID，测试模式下不存在。
  • responseChatItemId: 当前对话中，响应的消息ID，测试模式下不存在。
  • variables: 当前对话的全局变量。
  • cTime: 当前时间。
  • histories: 历史记录（默认最多取10条，无法修改长度）

Params, Headers

不多描述，使用方法和Postman, ApiFox 基本一致。

可通过 {{key}} 来引入变量。例如：

keyvalue
appId{{appId}}
AuthorizationBearer {{token}}

Body

只有特定请求类型下会生效。

可以写一个自定义的 Json，并通过 {{key}} 来引入变量。例如：

   {
   "string": "字符串",
   "number": 123,
@@ -47,7 +47,7 @@ Table of Contents

注意，在 Body 中，你如果引用字符串，则需要加上""，例如："{{string}}"。

+

注意，在 Body 中，你如果引用字符串，则需要加上""，例如："{{string}}"。

   {
   "string": "{{string}}",
   "token": "Bearer {{string}}",
@@ -57,7 +57,7 @@ Table of Contents
+  
   {
   "string": "字符串",
   "token": "Bearer 字符串",
@@ -70,8 +70,8 @@ Table of Contents

如何获取返回值

从图中可以看出，FastGPT可以添加多个返回值，这个返回值并不代表接口的返回值，而是代表如何解析接口返回值，可以通过 JSON path 的语法，来提取接口响应的值。

语法可以参考: https://github.com/JSONPath-Plus/JSONPath?tab=readme-ov-file

+

如何获取返回值

从图中可以看出，FastGPT可以添加多个返回值，这个返回值并不代表接口的返回值，而是代表如何解析接口返回值，可以通过 JSON path 的语法，来提取接口响应的值。

语法可以参考: https://github.com/JSONPath-Plus/JSONPath?tab=readme-ov-file

   {
   "message": "测试",
   "data":{
@@ -89,7 +89,7 @@ Table of Contents
+  
   {
   "$.message": "测试",
   "$.data.user": { "name": "xxx", "age": 12 },
diff --git a/docs/guide/dashboard/workflow/index.html b/docs/guide/dashboard/workflow/index.html
index 40d554ffa..88e6307cd 100644
--- a/docs/guide/dashboard/workflow/index.html
+++ b/docs/guide/dashboard/workflow/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南

1. 获取文件树 

+

1. 获取文件树 

   curl --location --request POST '{{baseURL}}/v1/file/list' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -59,7 +59,7 @@ type FileListItem = {
     "parentId": null,
     "searchKey": ""
 }'
-  
+  
   {
     "code": 200,
     "success": true,
@@ -75,12 +75,12 @@ type FileListItem = {
         }
    ]
 }
-

2. 获取单个文件内容（文本内容或访问链接） 

+

2. 获取单个文件内容（文本内容或访问链接） 

   curl --location --request GET '{{baseURL}}/v1/file/content?id=xx' \
 --header 'Authorization: Bearer {{authorization}}'
-  
+  
   {
     "code": 200,
     "success": true,
@@ -91,11 +91,11 @@ type FileListItem = {
         "previewUrl": "xxxx"
     }
 }
-

3. 获取文件阅读链接（用于查看原文）

id 为文件的 id。

+

3. 获取文件阅读链接（用于查看原文）

id 为文件的 id。

   curl --location --request GET '{{baseURL}}/v1/file/read?id=xx' \
 --header 'Authorization: Bearer {{authorization}}'
-  
+  
   {
     "code": 200,
     "success": true,
diff --git a/docs/guide/knowledge_base/dataset_engine/index.html b/docs/guide/knowledge_base/dataset_engine/index.html
index 75e6c0691..6182a6aa5 100644
--- a/docs/guide/knowledge_base/dataset_engine/index.html
+++ b/docs/guide/knowledge_base/dataset_engine/index.html
@@ -18,7 +18,7 @@ FastGPT
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南
code_blocks 开发与部署指南