From 480ee7c5186c8755a1556b83e3073c474d2f852b Mon Sep 17 00:00:00 2001 From: c121914yu Date: Sat, 16 Mar 2024 14:29:42 +0000 Subject: [PATCH] deploy: f5b0d60ff133b451790325633320e07f87ff63cc --- docs/development/configuration/index.html | 6 +- docs/development/docker/index.html | 10 +- docs/development/index.xml | 2 +- docs/development/openapi/chat/index.html | 18 +-- docs/development/openapi/dataset/index.html | 154 ++++++++++---------- docs/development/openapi/share/index.html | 30 ++-- docs/workflow/modules/http/index.html | 16 +- index.xml | 2 +- 8 files changed, 119 insertions(+), 119 deletions(-) diff --git a/docs/development/configuration/index.html b/docs/development/configuration/index.html index 5f0c4e1ea81..5dca1ee330a 100644 --- a/docs/development/configuration/index.html +++ b/docs/development/configuration/index.html @@ -25,7 +25,7 @@ menu
配置文件介绍
settings

配置文件介绍

FastGPT 配置参数介绍

由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 projects/app/data/config.json 看到默认的配置文件。可以参考 docker-compose 快速部署 来挂载配置文件。

开发环境下，你需要将示例配置文件 config.json 复制成 config.local.json 文件才会生效。

这个配置文件中包含了系统级参数、AI 对话的模型、function 模型等……

4.6.8+ 版本新配置文件

llm模型全部合并

+Table of Contents
settings

配置文件介绍

FastGPT 配置参数介绍

由于环境变量不利于配置复杂的内容，新版 FastGPT 采用了 ConfigMap 的形式挂载配置文件，你可以在 projects/app/data/config.json 看到默认的配置文件。可以参考 docker-compose 快速部署 来挂载配置文件。

开发环境下，你需要将示例配置文件 config.json 复制成 config.local.json 文件才会生效。

这个配置文件中包含了系统级参数、AI 对话的模型、function 模型等……

4.6.8+ 版本新配置文件

llm模型全部合并

   {
   "systemEnv": {
     "vectorMaxProcess": 15,
@@ -48,8 +48,8 @@
       "usedInExtractFields": true, // 是否用于内容提取（务必保证至少有一个为true）
       "usedInToolCall": true, // 是否用于工具调用（务必保证至少有一个为true）
       "usedInQueryExtension": true, // 是否用于问题优化（务必保证至少有一个为true）
-      "toolChoice": true, // 是否支持工具选择（务必保证至少有一个为true）
-      "functionCall": false, // 是否支持函数调用（特殊功能，会优先使用 toolChoice，如果为false，则使用 functionCall，如果仍为 false，则使用提示词模式）
+      "toolChoice": true, // 是否支持工具选择（分类，内容提取，工具调用会用到。目前只有gpt支持）
+      "functionCall": false, // 是否支持函数调用（分类，内容提取，工具调用会用到。会优先使用 toolChoice，如果为false，则使用 functionCall，如果仍为 false，则使用提示词模式）
       "customCQPrompt": "", // 自定义文本分类提示词（不支持工具和函数调用的模型
       "customExtractPrompt": "", // 自定义内容提取提示词
       "defaultSystemChatPrompt": "", // 对话默认携带的系统提示词
diff --git a/docs/development/docker/index.html b/docs/development/docker/index.html
index e971c39be4c..ca5440febd4 100644
--- a/docs/development/docker/index.html
+++ b/docs/development/docker/index.html
@@ -25,9 +25,9 @@
 menu
Docker Compose 快速部署
article

Docker Compose 快速部署

使用 Docker Compose 快速部署 FastGPT

推荐配置

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

部署架构图

1. 准备好代理环境（国外服务器可忽略）

确保可以访问 OpenAI，具体方案可以参考：代理方案。或直接在 Sealos 上 部署 OneAPI，既解决代理问题也能实现多 Key 轮询、接入其他大模型。

2. 多模型支持

FastGPT 使用了 one-api 项目来管理模型池，其可以兼容 OpenAI 、Azure 、国内主流模型和本地模型等。

可选择 Sealos 快速部署 OneAPI，更多部署方法可参考该项目的 README，也可以直接通过以下按钮一键部署：

Deploy on Sealos

一、安装 Docker 和 docker-compose 

+Table of Contents
article

Docker Compose 快速部署

使用 Docker Compose 快速部署 FastGPT

推荐配置

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

部署架构图

1. 准备好代理环境（国外服务器可忽略）

确保可以访问 OpenAI，具体方案可以参考：代理方案。或直接在 Sealos 上 部署 OneAPI，既解决代理问题也能实现多 Key 轮询、接入其他大模型。

2. 多模型支持

FastGPT 使用了 one-api 项目来管理模型池，其可以兼容 OpenAI 、Azure 、国内主流模型和本地模型等。

可选择 Sealos 快速部署 OneAPI，更多部署方法可参考该项目的 README，也可以直接通过以下按钮一键部署：

Deploy on Sealos

一、安装 Docker 和 docker-compose 

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

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

+

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

   brew install orbstack
-

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

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

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

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

二、创建目录并下载 docker-compose.yml

依次执行下面命令，创建 FastGPT 文件并拉取docker-compose.yml和config.json，执行完后目录下会有 2 个文件。

非 Linux 环境或无法访问外网环境，可手动创建一个目录，并下载下面2个链接的文件: docker-compose.yml,config.json

注意: docker-compose.yml 配置文件中 Mongo 为 5.x，部分服务器不支持，需手动更改其镜像版本为 4.4.24

+

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

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

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

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

二、创建目录并下载 docker-compose.yml

依次执行下面命令，创建 FastGPT 文件并拉取docker-compose.yml和config.json，执行完后目录下会有 2 个文件。

非 Linux 环境或无法访问外网环境，可手动创建一个目录，并下载下面2个链接的文件: docker-compose.yml,config.json

注意: docker-compose.yml 配置文件中 Mongo 为 5.x，部分服务器不支持，需手动更改其镜像版本为 4.4.24

   mkdir fastgpt
 cd fastgpt
 curl -O https://raw.githubusercontent.com/labring/FastGPT/main/files/deploy/fastgpt/docker-compose.yml
diff --git a/docs/development/index.xml b/docs/development/index.xml
index aba2ff4254e..7253e8e57c2 100644
--- a/docs/development/index.xml
+++ b/docs/development/index.xml
@@ -40,7 +40,7 @@ SESSION_SECRET=SESSION_SECRET POLLING_INTERVAL=60 BATCH_UPDATE_ENABLED=true BATC
 开发环境下，你需要将示例配置文件 config.json 复制成 config.local.json 文件才会生效。
 这个配置文件中包含了系统级参数、AI 对话的模型、function 模型等……
 4.6.8+ 版本新配置文件 linkllm模型全部合并
-{ "systemEnv": { "vectorMaxProcess": 15, "qaMaxProcess": 15, "pgHNSWEfSearch": 100 // 向量搜索参数。越大，搜索越精确，但是速度越慢。设置为100，有99%+精度。 }, "llmModels": [ { "model": "gpt-3.5-turbo", // 模型名 "name": "gpt-3.5-turbo", // 别名 "maxContext": 16000, // 最大上下文 "maxResponse": 4000, // 最大回复 "quoteMaxToken": 13000, // 最大引用内容 "maxTemperature": 1.2, // 最大温度 "charsPointsPrice": 0, "censor": false, "vision": false, // 是否支持图片输入 "datasetProcess": false, // 是否设置为知识库处理模型（QA），务必保证至少有一个为true，否则知识库会报错 "usedInClassify": true, // 是否用于问题分类（务必保证至少有一个为true） "usedInExtractFields": true, // 是否用于内容提取（务必保证至少有一个为true） "usedInToolCall": true, // 是否用于工具调用（务必保证至少有一个为true） "usedInQueryExtension": true, // 是否用于问题优化（务必保证至少有一个为true） "toolChoice": true, // 是否支持工具选择（务必保证至少有一个为true） "functionCall": false, // 是否支持函数调用（特殊功能，会优先使用 toolChoice，如果为false，则使用 functionCall，如果仍为 false，则使用提示词模式） "customCQPrompt": "", // 自定义文本分类提示词（不支持工具和函数调用的模型 "customExtractPrompt": "", // 自定义内容提取提示词 "defaultSystemChatPrompt": "", // 对话默认携带的系统提示词 "defaultConfig":{} // LLM默认配置，可以针对不同模型设置特殊值（比如 GLM4 的 top_p }, { "model": "gpt-3.常见开发 & 部署问题/docs/development/faq/Mon, 01 Jan 0001 00:00:00 +0000/docs/development/faq/错误排查方式 link遇到问题先按下面方式排查。
+{ "systemEnv": { "vectorMaxProcess": 15, "qaMaxProcess": 15, "pgHNSWEfSearch": 100 // 向量搜索参数。越大，搜索越精确，但是速度越慢。设置为100，有99%+精度。 }, "llmModels": [ { "model": "gpt-3.5-turbo", // 模型名 "name": "gpt-3.5-turbo", // 别名 "maxContext": 16000, // 最大上下文 "maxResponse": 4000, // 最大回复 "quoteMaxToken": 13000, // 最大引用内容 "maxTemperature": 1.2, // 最大温度 "charsPointsPrice": 0, "censor": false, "vision": false, // 是否支持图片输入 "datasetProcess": false, // 是否设置为知识库处理模型（QA），务必保证至少有一个为true，否则知识库会报错 "usedInClassify": true, // 是否用于问题分类（务必保证至少有一个为true） "usedInExtractFields": true, // 是否用于内容提取（务必保证至少有一个为true） "usedInToolCall": true, // 是否用于工具调用（务必保证至少有一个为true） "usedInQueryExtension": true, // 是否用于问题优化（务必保证至少有一个为true） "toolChoice": true, // 是否支持工具选择（分类，内容提取，工具调用会用到。目前只有gpt支持） "functionCall": false, // 是否支持函数调用（分类，内容提取，工具调用会用到。会优先使用 toolChoice，如果为false，则使用 functionCall，如果仍为 false，则使用提示词模式） "customCQPrompt": "", // 自定义文本分类提示词（不支持工具和函数调用的模型 "customExtractPrompt": "", // 自定义内容提取提示词 "defaultSystemChatPrompt": "", // 对话默认携带的系统提示词 "defaultConfig":{} // LLM默认配置，可以针对不同模型设置特殊值（比如 GLM4 的 top_p }, { "model": "gpt-3.常见开发 & 部署问题/docs/development/faq/Mon, 01 Jan 0001 00:00:00 +0000/docs/development/faq/错误排查方式 link遇到问题先按下面方式排查。
 docker ps -a 查看所有容器运行状态，检查是否全部 running，如有异常，尝试docker logs 容器名查看对应日志。 不懂 docker 不要瞎改端口，只需要改OPENAI_BASE_URL和CHAT_API_KEY即可。 容器都运行正常的，docker logs 容器名 查看报错日志 无法解决时，可以找找Issue，或新提 Issue，私有部署错误，务必提供详细的日志，否则很难排查。 通用问题 link能否纯本地运行 link可以。需要准备好向量模型和LLM模型。
 insufficient_user_quota user quota is not enough linkOneAPI 账号的余额不足，默认 root 用户只有 200 刀，可以手动修改。
 xxx渠道找不到 linkOneAPI 中没有配置该模型渠道。或者是修改了配置文件中一部分的模型，但没有全部修改。
diff --git a/docs/development/openapi/chat/index.html b/docs/development/openapi/chat/index.html
index c02200dd976..2b86603eee4 100644
--- a/docs/development/openapi/chat/index.html
+++ b/docs/development/openapi/chat/index.html
@@ -25,8 +25,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' \
@@ -45,10 +45,10 @@
         }
     ]
 }'
-

响应 

+

响应 

   {
     "id": "adsfasf",
     "model": "",
@@ -68,7 +68,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}]}
@@ -76,7 +76,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 自行查看最新值。
         {
@@ -160,7 +160,7 @@
         }
     ]
 }
-  
+  
   event: moduleStatus
 data: {"status":"running","name":"知识库搜索"}
 
diff --git a/docs/development/openapi/dataset/index.html b/docs/development/openapi/dataset/index.html
index d223195b5d4..54fbdc9e254 100644
--- a/docs/development/openapi/dataset/index.html
+++ b/docs/development/openapi/dataset/index.html
@@ -25,8 +25,8 @@
 menu
知识库接口
dataset

知识库接口

FastGPT OpenAPI 知识库接口

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

创建训练订单(4.6.9地址发生改动)

新例子

+Table of Contents
dataset

知识库接口

FastGPT OpenAPI 知识库接口

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

创建训练订单(4.6.9地址发生改动)

新例子

   curl --location --request POST 'https://api.fastgpt.in/api/support/wallet/usage/createTrainingUsage' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -40,16 +40,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' \
@@ -62,19 +62,19 @@
     "vectorModel": "text-embedding-ada-002",
     "agentModel": "gpt-3.5-turbo-16k"
 }'
-  
+  
   {
   "code": 200,
   "statusText": "",
   "message": "",
   "data": "65abc9bd9d1448617cba5e6c"
 }
-

获取知识库列表 

+

获取知识库列表 

   curl --location --request GET 'http://localhost:3000/api/core/dataset/list?parentId=' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -101,12 +101,12 @@
         }
     ]
 }
-

获取知识库详情 

+

获取知识库详情 

   curl --location --request GET 'http://localhost:3000/api/core/dataset/detail?id=6593e137231a2be9c5603ba7' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -142,21 +142,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
 }
-

集合

创建一个空的集合 

+

集合

创建一个空的集合 

   curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -169,16 +169,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' \
@@ -195,7 +195,7 @@
 
     "metadata":{}
 }'
-

data 为集合的 ID。

+

data 为集合的 ID。

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

创建一个链接集合

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

+

创建一个链接集合

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

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

data 为集合的 ID。

+

data 为集合的 ID。

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

创建一个文件集合(商业版)

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

+

创建一个文件集合(商业版)

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

   curl --location --request POST 'http://localhost:3000/api/proApi/core/dataset/collection/create/file' \
 --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": "",
@@ -261,9 +261,9 @@
         }
     }
 }
-

获取集合列表 

+

获取集合列表 

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

获取集合详情 

+

获取集合详情 

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

修改集合信息 

+

修改集合信息 

   curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -365,29 +365,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' \
@@ -415,7 +415,7 @@
         }
     ]
 }'
-  
+  
   {
     "code": 200,
     "statusText": "",
@@ -426,7 +426,7 @@
         "error": [] // 其他错误
     }
 }
-

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

+

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

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

获取集合的数据列表 

+

获取集合的数据列表 

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

获取单条数据详情 

+

获取单条数据详情 

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

修改单条数据 

+

修改单条数据 

   curl --location --request PUT 'http://localhost:3000/api/core/dataset/data/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -534,28 +534,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' \
@@ -567,7 +567,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 49afbca32b5..017d3457f3e 100644
--- a/docs/development/openapi/share/index.html
+++ b/docs/development/openapi/share/index.html
@@ -34,43 +34,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": "身份验证失败",
@@ -193,9 +193,9 @@
 
     tfSwitchResult?: 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) {
@@ -208,7 +208,7 @@
 
   return { success: false,message:"身份错误" }
 }
-

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

+

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

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

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

+

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

   import cloud from '@lafjs/cloud'
 
 export default async function (ctx: FunctionContext) {
diff --git a/docs/workflow/modules/http/index.html b/docs/workflow/modules/http/index.html
index 443fdd3046f..df23b909678 100644
--- a/docs/workflow/modules/http/index.html
+++ b/docs/workflow/modules/http/index.html
@@ -25,9 +25,9 @@
 menu
HTTP 模块
http

HTTP 模块

FastGPT HTTP 模块介绍

特点

  • 可重复添加
  • 有外部输入
  • 手动配置
  • 触发执行
  • 核中核模块

介绍

HTTP 模块会向对应的地址发送一个 POST/GET 请求，携带部分系统参数及自定义参数，并接收一个 JSON 响应值，字段也是自定义。

  • Params 为路径请求参数，GET请求中用的居多。
  • Body 为请求体，POST请求中用的居多。
  • Headers 为请求头，用于传递一些特殊的信息。
  • 3 种数据中均可以通过 {{}} 来引用变量。
  • 变量来自于全局变量、系统变量、局部传入

参数结构

系统变量说明

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

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

Params, Headers

不多描述，使用方法和Postman, ApiFox 基本一致，目前 Params 和 Headers 未提供语法提示，后续会加入。

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

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

Body

只有POST模式下会生效。

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

+Table of Contents
http

HTTP 模块

FastGPT HTTP 模块介绍

特点

  • 可重复添加
  • 有外部输入
  • 手动配置
  • 触发执行
  • 核中核模块

介绍

HTTP 模块会向对应的地址发送一个 POST/GET 请求，携带部分系统参数及自定义参数，并接收一个 JSON 响应值，字段也是自定义。

  • Params 为路径请求参数，GET请求中用的居多。
  • Body 为请求体，POST请求中用的居多。
  • Headers 为请求头，用于传递一些特殊的信息。
  • 3 种数据中均可以通过 {{}} 来引用变量。
  • 变量来自于全局变量、系统变量、局部传入

参数结构

系统变量说明

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

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

Params, Headers

不多描述，使用方法和Postman, ApiFox 基本一致，目前 Params 和 Headers 未提供语法提示，后续会加入。

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

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

Body

只有POST模式下会生效。

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

   {
   "string": "字符串",
   "number": 123,
@@ -38,7 +38,7 @@
     "url": "https://fastgpt.in"
   }
 }
-

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

+

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

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

如何获取返回值

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

+

如何获取返回值

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

   {
   "message": "测试",
   "data":{
@@ -80,7 +80,7 @@
       "psw": "xxx"
   }
 }
-  
+  
   {
   "message": "测试",
   "data.user": { "name": "xxx", "age": 12 },
diff --git a/index.xml b/index.xml
index 22001352668..1c2ea2bc512 100644
--- a/index.xml
+++ b/index.xml
@@ -261,7 +261,7 @@ SESSION_SECRET=SESSION_SECRET POLLING_INTERVAL=60 BATCH_UPDATE_ENABLED=true BATC
 开发环境下，你需要将示例配置文件 config.json 复制成 config.local.json 文件才会生效。
 这个配置文件中包含了系统级参数、AI 对话的模型、function 模型等……
 4.6.8+ 版本新配置文件 linkllm模型全部合并
-{ "systemEnv": { "vectorMaxProcess": 15, "qaMaxProcess": 15, "pgHNSWEfSearch": 100 // 向量搜索参数。越大，搜索越精确，但是速度越慢。设置为100，有99%+精度。 }, "llmModels": [ { "model": "gpt-3.5-turbo", // 模型名 "name": "gpt-3.5-turbo", // 别名 "maxContext": 16000, // 最大上下文 "maxResponse": 4000, // 最大回复 "quoteMaxToken": 13000, // 最大引用内容 "maxTemperature": 1.2, // 最大温度 "charsPointsPrice": 0, "censor": false, "vision": false, // 是否支持图片输入 "datasetProcess": false, // 是否设置为知识库处理模型（QA），务必保证至少有一个为true，否则知识库会报错 "usedInClassify": true, // 是否用于问题分类（务必保证至少有一个为true） "usedInExtractFields": true, // 是否用于内容提取（务必保证至少有一个为true） "usedInToolCall": true, // 是否用于工具调用（务必保证至少有一个为true） "usedInQueryExtension": true, // 是否用于问题优化（务必保证至少有一个为true） "toolChoice": true, // 是否支持工具选择（务必保证至少有一个为true） "functionCall": false, // 是否支持函数调用（特殊功能，会优先使用 toolChoice，如果为false，则使用 functionCall，如果仍为 false，则使用提示词模式） "customCQPrompt": "", // 自定义文本分类提示词（不支持工具和函数调用的模型 "customExtractPrompt": "", // 自定义内容提取提示词 "defaultSystemChatPrompt": "", // 对话默认携带的系统提示词 "defaultConfig":{} // LLM默认配置，可以针对不同模型设置特殊值（比如 GLM4 的 top_p }, { "model": "gpt-3.常见开发 & 部署问题/docs/development/faq/Mon, 01 Jan 0001 00:00:00 +0000/docs/development/faq/错误排查方式 link遇到问题先按下面方式排查。
+{ "systemEnv": { "vectorMaxProcess": 15, "qaMaxProcess": 15, "pgHNSWEfSearch": 100 // 向量搜索参数。越大，搜索越精确，但是速度越慢。设置为100，有99%+精度。 }, "llmModels": [ { "model": "gpt-3.5-turbo", // 模型名 "name": "gpt-3.5-turbo", // 别名 "maxContext": 16000, // 最大上下文 "maxResponse": 4000, // 最大回复 "quoteMaxToken": 13000, // 最大引用内容 "maxTemperature": 1.2, // 最大温度 "charsPointsPrice": 0, "censor": false, "vision": false, // 是否支持图片输入 "datasetProcess": false, // 是否设置为知识库处理模型（QA），务必保证至少有一个为true，否则知识库会报错 "usedInClassify": true, // 是否用于问题分类（务必保证至少有一个为true） "usedInExtractFields": true, // 是否用于内容提取（务必保证至少有一个为true） "usedInToolCall": true, // 是否用于工具调用（务必保证至少有一个为true） "usedInQueryExtension": true, // 是否用于问题优化（务必保证至少有一个为true） "toolChoice": true, // 是否支持工具选择（分类，内容提取，工具调用会用到。目前只有gpt支持） "functionCall": false, // 是否支持函数调用（分类，内容提取，工具调用会用到。会优先使用 toolChoice，如果为false，则使用 functionCall，如果仍为 false，则使用提示词模式） "customCQPrompt": "", // 自定义文本分类提示词（不支持工具和函数调用的模型 "customExtractPrompt": "", // 自定义内容提取提示词 "defaultSystemChatPrompt": "", // 对话默认携带的系统提示词 "defaultConfig":{} // LLM默认配置，可以针对不同模型设置特殊值（比如 GLM4 的 top_p }, { "model": "gpt-3.常见开发 & 部署问题/docs/development/faq/Mon, 01 Jan 0001 00:00:00 +0000/docs/development/faq/错误排查方式 link遇到问题先按下面方式排查。
 docker ps -a 查看所有容器运行状态，检查是否全部 running，如有异常，尝试docker logs 容器名查看对应日志。 不懂 docker 不要瞎改端口，只需要改OPENAI_BASE_URL和CHAT_API_KEY即可。 容器都运行正常的，docker logs 容器名 查看报错日志 无法解决时，可以找找Issue，或新提 Issue，私有部署错误，务必提供详细的日志，否则很难排查。 通用问题 link能否纯本地运行 link可以。需要准备好向量模型和LLM模型。
 insufficient_user_quota user quota is not enough linkOneAPI 账号的余额不足，默认 root 用户只有 200 刀，可以手动修改。
 xxx渠道找不到 linkOneAPI 中没有配置该模型渠道。或者是修改了配置文件中一部分的模型，但没有全部修改。