From 1ba099721c17a4d1c84b762ebb70f65cd63d5cef Mon Sep 17 00:00:00 2001 From: c121914yu Date: Fri, 6 Sep 2024 09:32:30 +0000 Subject: [PATCH] deploy: d45cb2f84a69436ac353fee0faf3fff6b6454ec3 --- docs/development/docker/index.html | 20 +-- docs/development/openapi/chat/index.html | 32 ++-- docs/development/openapi/dataset/index.html | 162 ++++++++++---------- docs/development/openapi/share/index.html | 30 ++-- docs/development/upgrading/4810/index.html | 2 +- docs/workflow/modules/http/index.html | 16 +- 6 files changed, 131 insertions(+), 131 deletions(-) diff --git a/docs/development/docker/index.html b/docs/development/docker/index.html index b5c18f6eb215..a556b7d697f4 100644 --- a/docs/development/docker/index.html +++ b/docs/development/docker/index.html @@ -26,9 +26,9 @@ menu
Docker Compose 快速部署
article

Docker Compose 快速部署

使用 Docker Compose 快速部署 FastGPT

部署架构图

推荐配置

PgVector版本

体验测试首选

环境最低配置（单节点）推荐配置
测试2c2g2c4g
100w 组向量4c8g 50GB4c16g 50GB
500w 组向量8c32g 200GB16c64g 200GB

Milvus版本

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

点击查看 Milvus 官方推荐配置

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

zilliz cloud版本

亿级以上向量首选。

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

前置工作

1. 确保网络环境

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

2. 准备 Docker 环境 

+Table of Contents
article

Docker Compose 快速部署

使用 Docker Compose 快速部署 FastGPT

部署架构图

推荐配置

PgVector版本

体验测试首选

环境最低配置（单节点）推荐配置
测试2c2g2c4g
100w 组向量4c8g 50GB4c16g 50GB
500w 组向量8c32g 200GB16c64g 200GB

Milvus版本

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

点击查看 Milvus 官方推荐配置

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

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
@@ -39,9 +39,9 @@
 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
@@ -52,13 +52,13 @@
 # curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/files/docker/docker-compose-milvus.yml
 # zilliz 版本
 # curl -o docker-compose.yml https://raw.githubusercontent.com/labring/FastGPT/main/files/docker/docker-compose-zilliz.yml
-

2. 修改 docker-compose.yml 环境变量 

+

2. 修改 docker-compose.yml 环境变量 

   无需操作
-  
+  
   无需操作
-

zilliz_key

3. 启动容器

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

+

zilliz_key

3. 启动容器

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

   # 启动容器
 docker-compose up -d
 # 等待10s，OneAPI第一次总是要重启几次才能连上Mysql
diff --git a/docs/development/openapi/chat/index.html b/docs/development/openapi/chat/index.html
index f4a0d3737fa3..5d241b6e53b1 100644
--- a/docs/development/openapi/chat/index.html
+++ b/docs/development/openapi/chat/index.html
@@ -26,8 +26,8 @@
 menu
对话接口
chat

对话接口

FastGPT OpenAPI 对话接口

发起对话(简易应用和工作流)

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

请求 

+Table of Contents
chat

对话接口

FastGPT OpenAPI 对话接口

发起对话(简易应用和工作流)

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

请求 

   curl --location --request POST 'https://api.fastgpt.in/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
@@ -46,11 +46,11 @@
         }
     ]
 }'
-

响应 

+

响应 

   {
     "id": "adsfasf",
     "model": "",
@@ -70,7 +70,7 @@
         }
     ]
 }
-  
+  
   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}]}
@@ -78,7 +78,7 @@
 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}]}
-  
+  
   {
     "responseData": [ // 不同模块的响应值, 不同版本具体值可能有差异，可先 log 自行查看最新值。
         {
@@ -162,7 +162,7 @@
         }
     ]
 }
-  
+  
   event: flowNodeStatus
 data: {"status":"running","name":"知识库搜索"}
 
@@ -192,7 +192,7 @@
 
 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}]
-

event取值：

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

请求插件

插件的接口与对话接口一致，仅请求参数略有区别，有以下规定：

  • 调用插件类型的应用时，接口默认为detail模式。
  • 无需传入 chatId，因为插件只能运行一轮。
  • 无需传入messages。
  • 通过传递variables来代表插件的输入。
  • 通过获取pluginData来获取插件输出。

请求示例 

+

event取值：

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

请求插件

插件的接口与对话接口一致，仅请求参数略有区别，有以下规定：

  • 调用插件类型的应用时，接口默认为detail模式。
  • 无需传入 chatId，因为插件只能运行一轮。
  • 无需传入messages。
  • 通过传递variables来代表插件的输入。
  • 通过获取pluginData来获取插件输出。

请求示例 

   curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer test-xxxxx' \
 --header 'Content-Type: application/json' \
@@ -203,9 +203,9 @@
         "query":"你好" # 我的插件输入有一个参数，变量名叫 query
     }
 }'
-

响应示例

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

响应示例

  • 插件的输出可以通过查找responseData中, moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍可以通过choices进行获取。
   {
     "responseData": [
         {
@@ -262,7 +262,7 @@
         }
     ]
 }
-
  • 插件的输出可以通过获取event=flowResponses中的字符串，并将其反序列化后得到一个数组。同样的，查找 moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍和对话接口一样获取。
+
  • 插件的输出可以通过获取event=flowResponses中的字符串，并将其反序列化后得到一个数组。同样的，查找 moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
  • 流输出，仍和对话接口一样获取。
   event: flowNodeStatus
 data: {"status":"running","name":"AI 对话"}
 
@@ -319,7 +319,7 @@
 
 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: 报错

使用案例

编辑此页面

© 2024 the FastGPT Authors.

云操作系统Sealos +

event取值：

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

使用案例

编辑此页面
diff --git a/docs/development/openapi/dataset/index.html b/docs/development/openapi/dataset/index.html index 101dfeabd590..2a8c03bd51b4 100644 --- a/docs/development/openapi/dataset/index.html +++ b/docs/development/openapi/dataset/index.html @@ -26,8 +26,8 @@ menu
知识库接口
dataset

知识库接口

FastGPT OpenAPI 知识库接口

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

创建训练订单

新例子

+Table of Contents
dataset

知识库接口

FastGPT OpenAPI 知识库接口

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

创建训练订单

新例子

   curl --location --request POST 'https://api.fastgpt.in/api/support/wallet/usage/createTrainingUsage' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -42,16 +42,16 @@
 --data-raw '{
     "name": "可选，自定义订单名称，例如：文档训练-fastgpt.docx"
 }'
-

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' \
@@ -64,23 +64,23 @@
     "vectorModel": "text-embedding-ada-002",
     "agentModel": "gpt-3.5-turbo-16k"
 }'
-  
+  
   {
   "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": "",
@@ -107,12 +107,12 @@
         }
     ]
 }
-

获取知识库详情 

+

获取知识库详情 

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

删除一个知识库 

+

删除一个知识库 

   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: QA拆分;auto: 增强训练✅
chunkSize预估块大小
chunkSplitter自定义最高优先分割符号
qaPromptqa拆分提示词

出参

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

创建一个空的集合 

+

集合

通用创建参数说明

入参

参数说明必填
datasetId知识库ID✅
parentId：父级ID，不填则默认为根目录
trainingType训练模式。chunk: 按文本长度进行分割;qa: QA拆分;auto: 增强训练✅
chunkSize预估块大小
chunkSplitter自定义最高优先分割符号
qaPromptqa拆分提示词

出参

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

创建一个空的集合 

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -175,16 +175,16 @@
       "test":111
     }
 }'
-

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 @@
 
     "metadata":{}
 }'
-

data 为集合的 ID。

+

data 为集合的 ID。

   {
   "code": 200,
   "statusText": "",
@@ -216,9 +216,9 @@
       }
   }
 }
-

创建一个链接集合

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

+

创建一个链接集合

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

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/link' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -236,7 +236,7 @@
         "webPageSelector":".docs-content"
     }
 }'
-

data 为集合的 ID。

+

data 为集合的 ID。

   {
     "code": 200,
     "statusText": "",
@@ -245,14 +245,14 @@
         "collectionId": "65abd0ad9d1448617cba6031"
     }
 }
-

创建一个文件集合

传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：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": "",
@@ -267,9 +267,9 @@
         }
     }
 }
-

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

+

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

   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)' \
@@ -286,7 +286,7 @@
     "chunkSplitter":"",
     "qaPrompt":""
 }'
-
参数说明必填
externalFileUrl文件访问链接（可以是临时链接）✅
externalFileId外部文件ID
filename自定义文件名

data 为集合的 ID。

+
参数说明必填
externalFileUrl文件访问链接（可以是临时链接）✅
externalFileId外部文件ID
filename自定义文件名

data 为集合的 ID。

   {
   "code": 200,
   "statusText": "",
@@ -296,9 +296,9 @@
     "insertLen": 3
   }
 }
-

获取集合列表 

+

获取集合列表 

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/list' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -309,7 +309,7 @@
     "parentId": null,
     "searchText":""
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -345,12 +345,12 @@
         "total": 93
     }
 }
-

获取集合详情 

+

获取集合详情 

   curl --location --request GET 'http://localhost:3000/api/core/dataset/collection/detail?id=65abcfab9d1448617cba5f0d' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -389,9 +389,9 @@
         "sourceName": "测试训练"
     }
 }
-

修改集合信息 

+

修改集合信息 

   curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -400,29 +400,29 @@
     "parentId":null,
     "name":"测2222试"
 }'
-  
+  
   {
     "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个

字段类型说明必填
defaultIndexBoolean是否为默认索引✅
dataIdString关联的向量ID✅
textString文本内容✅

为集合批量添加添加数据

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

+

数据

数据的结构

Data结构

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

Index结构

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

字段类型说明必填
defaultIndexBoolean是否为默认索引✅
dataIdString关联的向量ID✅
textString文本内容✅

为集合批量添加添加数据

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

   curl --location --request POST 'https://api.fastgpt.in/api/core/dataset/data/pushData' \
 --header 'Authorization: Bearer apikey' \
 --header 'Content-Type: application/json' \
@@ -450,7 +450,7 @@
         }
     ]
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -461,7 +461,7 @@
         "error": [] // 其他错误
     }
 }
-

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

+

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

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

获取集合的数据列表 

+

获取集合的数据列表 

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

获取单条数据详情 

+

获取单条数据详情 

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

修改单条数据 

+

修改单条数据 

   curl --location --request PUT 'http://localhost:3000/api/core/dataset/data/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -569,28 +569,28 @@
         }
     ]
 }'
-  
+  
   {
     "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' \
@@ -602,7 +602,7 @@
     "searchMode": "embedding",
     "usingReRank": false
 }'
-

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

+

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

   {
   "code": 200,
   "statusText": "",
diff --git a/docs/development/openapi/share/index.html b/docs/development/openapi/share/index.html
index 6a30761418b5..f607fe9ec257 100644
--- a/docs/development/openapi/share/index.html
+++ b/docs/development/openapi/share/index.html
@@ -35,43 +35,43 @@
         "uid": "用户唯一凭证"
     }
 }
-

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

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

触发流程

配置教程

1. 配置身份校验地址

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

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

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

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

完整链接: https://share.fastgpt.in/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.fastgpt.in/chat/share?shareId=648aaf5ae121349a16d62192

完整链接: https://share.fastgpt.in/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": "身份验证失败",
@@ -194,9 +194,9 @@
 
     isElseResult?: boolean; // 判断器结果
 }
-

实践案例

我们以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) {
@@ -209,7 +209,7 @@
 
   return { success: false,message:"身份错误" }
 }
-

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

+

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

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

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

+

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

   import cloud from '@lafjs/cloud'
 
 export default async function (ctx: FunctionContext) {
diff --git a/docs/development/upgrading/4810/index.html b/docs/development/upgrading/4810/index.html
index 7c197e7776ea..ced74a5648d5 100644
--- a/docs/development/upgrading/4810/index.html
+++ b/docs/development/upgrading/4810/index.html
@@ -33,7 +33,7 @@
   curl --location --request POST 'https://{{host}}/api/admin/initv4810' \
 --header 'rootkey: {{rootkey}}' \
 --header 'Content-Type: application/json'
-
  1. 初始化发布记录版本标记
  2. 初始化开票记录

V4.8.10 更新说明

完整内容请见：4.8.10 release

  1. 新增 - 模板市场。
  2. 新增 - 工作流节点拖动自动对齐吸附。
  3. 新增 - 用户选择节点（Debug 模式暂未支持）。
  4. 新增 - 工作流增加 uid 全局变量。
  5. 新增 - 工作流撤销和重做。
  6. 新增 - 工作流本次编辑记录，取代自动保存。
  7. 新增 - 工作流版本支持重命名。
  8. 新增 - 工作流的“应用调用”节点弃用，迁移成单独节点，与插件使用方式相同，同时可以传递全局变量和用户上传的文件。
  9. 新增 - 插件增加使用说明配置。
  10. 新增 - 插件自定义输入支持单选框。
  11. 新增 - HTTP 节点支持 text/plain 模式。
  12. 新增 - HTTP模块支持超时配置、支持更多的 Body 类型，params 和 headers 支持新的变量选择模式。
  13. 新增 - 工作流导出导入，支持直接导出和导入 JSON 文件，便于交流。
  14. 新增 - 发送验证码安全校验。
  15. 商业版新增 - 飞书机器人接入。
  16. 商业版新增 - 公众号接入接入。
  17. 商业版新增 - 自助开票申请。
  18. 商业版新增 - SSO 定制。
  19. 优化 - 工作流循环校验，避免 skip 循环空转。同时支持分支完全并发执行。
  20. 优化 - 工作流嵌套执行，参数可能存在的污染问题。
  21. 优化 - 部分全局变量，增加数据类型约束。
  22. 优化 - 节点选择，避免切换 tab 时候，path 加载报错。
  23. 优化 - 最新 React Markdown 组件，支持 Base64 图片。
  24. 优化 - 对话框性能问题。
  25. 优化 - 单选框打开后自动滚动到选中的位置。
  26. 优化 - 知识库集合禁用，目录禁用会递归修改其下所有 children 的禁用状态。
  27. 优化 - SSE 响应代码优化。
  28. 优化 - 无 SSL 证书情况下，优化复制。
  29. 优化 - 知识库列表 UI。
  30. 优化 - 知识库详情页 UI。
  31. 优化 - 支持无网络配置情况下运行。
  32. 优化 - 调整.env.template关于mongodb的说明，使得更易于理解。
  33. 优化 - 新的支付模式。
  34. 优化 - 用户默认头像。
  35. 修复 - Prompt 模式调用工具，stream=false 模式下，会携带 0: 开头标记。
  36. 修复 - 对话日志鉴权问题：仅为 APP 管理员的用户，无法查看对话日志详情。
  37. 修复 - 选择 Milvus 部署时，无法导出知识库。
  38. 修复 - 创建 APP 副本，无法复制系统配置。
  39. 修复 - 图片识别模式下，自动解析图片链接正则不够严谨问题。
  40. 修复 - 内容提取的数据类型与输出数据类型未一致。
  41. 修复 - 工作流运行时间统计错误。
  42. 修复 - stream 模式下，工具调用有可能出现 undefined。
  43. 修复 - reranker typo。
  44. 修复 - home host typo。
  45. 修复 - i18n display。
  46. 修复 - 全局变量可重复定义 key。
  47. 修复 - 全局变量在 Debug 模式下不可持久化。
  48. 修复 - 全局变量在 API 中无法持久化。
  49. 修复 - OpenAPI，detail=false模式下，不应该返回 tool 调用结果，仅返回文字。（可解决 cow 不适配问题）。
  50. 修复 - 知识库标签重复加载。
  51. 修复 - 网络链接重新获取时，自定义分割符不生效。
  52. 修复 - 插件运行时，会传递额外的全局变量，可能造成插件内变量污染。
  53. 文档 - qa docs。
  54. 文档 - Update feishu.md。
  55. 文档 - update baseURL。
编辑此页面

© 2024 the FastGPT Authors.

云操作系统Sealos +

  1. 初始化发布记录版本标记
  2. 初始化开票记录

V4.8.10 更新说明

完整内容请见：4.8.10 release

  1. 新增 - 模板市场。
  2. 新增 - 工作流节点拖动自动对齐吸附。
  3. 新增 - 用户选择节点（Debug 模式暂未支持）。
  4. 新增 - 工作流增加 uid 全局变量。
  5. 新增 - 工作流撤销和重做。
  6. 新增 - 工作流本次编辑记录，取代自动保存。
  7. 新增 - 工作流版本支持重命名。
  8. 新增 - 工作流的“应用调用”节点弃用，迁移成单独节点，与插件使用方式相同，同时可以传递全局变量和用户上传的文件。
  9. 新增 - 插件增加使用说明配置。
  10. 新增 - 插件自定义输入支持单选框。
  11. 新增 - HTTP 节点支持 text/plain 模式。
  12. 新增 - HTTP模块支持超时配置、支持更多的 Body 类型，params 和 headers 支持新的变量选择模式。
  13. 新增 - 工作流导出导入，支持直接导出和导入 JSON 文件，便于交流。
  14. 新增 - 发送验证码安全校验。
  15. 商业版新增 - 飞书机器人接入。
  16. 商业版新增 - 公众号接入接入。
  17. 商业版新增 - 自助开票申请。
  18. 商业版新增 - SSO 定制。
  19. 优化 - 工作流循环校验，避免 skip 循环空转。同时支持分支完全并发执行。
  20. 优化 - 工作流嵌套执行，参数可能存在的污染问题。
  21. 优化 - 部分全局变量，增加数据类型约束。
  22. 优化 - 节点选择，避免切换 tab 时候，path 加载报错。
  23. 优化 - 最新 React Markdown 组件，支持 Base64 图片。
  24. 优化 - 对话框性能问题。
  25. 优化 - 单选框打开后自动滚动到选中的位置。
  26. 优化 - 知识库集合禁用，目录禁用会递归修改其下所有 children 的禁用状态。
  27. 优化 - SSE 响应代码优化。
  28. 优化 - 无 SSL 证书情况下，优化复制。
  29. 优化 - 知识库列表 UI。
  30. 优化 - 知识库详情页 UI。
  31. 优化 - 支持无网络配置情况下运行。
  32. 优化 - 调整.env.template关于mongodb的说明，使得更易于理解。
  33. 优化 - 新的支付模式。
  34. 优化 - 用户默认头像。
  35. 修复 - Prompt 模式调用工具，stream=false 模式下，会携带 0: 开头标记。
  36. 修复 - 对话日志鉴权问题：仅为 APP 管理员的用户，无法查看对话日志详情。
  37. 修复 - 选择 Milvus 部署时，无法导出知识库。
  38. 修复 - 创建 APP 副本，无法复制系统配置。
  39. 修复 - 图片识别模式下，自动解析图片链接正则不够严谨问题。
  40. 修复 - 内容提取的数据类型与输出数据类型未一致。
  41. 修复 - 工作流运行时间统计错误。
  42. 修复 - stream 模式下，工具调用有可能出现 undefined。
  43. 修复 - reranker typo。
  44. 修复 - home host typo。
  45. 修复 - i18n display。
  46. 修复 - 全局变量可重复定义 key。
  47. 修复 - 全局变量在 Debug 模式下不可持久化。
  48. 修复 - 全局变量在 API 中无法持久化。
  49. 修复 - OpenAPI，detail=false模式下，不应该返回 tool 调用结果，仅返回文字。（可解决 cow 不适配问题）。
  50. 修复 - 知识库标签重复加载。
  51. 修复 - 网络链接重新获取时，自定义分割符不生效。
  52. 修复 - 插件运行时，会传递额外的全局变量，可能造成插件内变量污染。
  53. 文档 - qa docs。
  54. 文档 - Update feishu.md。
  55. 文档 - update baseURL。
编辑此页面
diff --git a/docs/workflow/modules/http/index.html b/docs/workflow/modules/http/index.html index 1a37a032c248..0a6c22a60ed5 100644 --- a/docs/workflow/modules/http/index.html +++ b/docs/workflow/modules/http/index.html @@ -26,9 +26,9 @@ menu
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,
@@ -39,7 +39,7 @@
     "url": "https://fastgpt.in"
   }
 }
-

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

+

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

   {
   "string": "{{string}}",
   "token": "Bearer {{string}}",
@@ -49,7 +49,7 @@
   "array2": {{array}},
   "object": {{obj}}
 }
-  
+  
   {
   "string": "字符串",
   "token": "Bearer 字符串",
@@ -62,8 +62,8 @@
     "url": "https://fastgpt.in"
   }
 }
-

如何获取返回值

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

+

如何获取返回值

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

   {
   "message": "测试",
   "data":{
@@ -81,7 +81,7 @@
       "psw": "xxx"
   }
 }
-  
+  
   {
   "message": "测试",
   "data.user": { "name": "xxx", "age": 12 },