diff --git a/docs/agreement/index.html b/docs/agreement/index.html index f619cc4ae6df..be43ac27bf7c 100644 --- a/docs/agreement/index.html +++ b/docs/agreement/index.html @@ -16,7 +16,7 @@ 应用搭建案例
  • 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版本

    Milvus 的全托管服务，性能优于 Milvus 并提供 SLA，点击使用 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版本

    Milvus 的全托管服务，性能优于 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
@@ -45,9 +45,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
@@ -58,13 +58,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. 修改环境变量

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

    +

    2. 修改环境变量

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

       FE_DOMAIN=你的前端你访问地址,例如 http://192.168.0.1:3000;https://cloud.fastgpt.cn
-  
    +  
       FE_DOMAIN=你的前端你访问地址,例如 http://192.168.0.1:3000;https://cloud.fastgpt.cn
-

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

    zilliz_key

    3. 启动容器

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

    +

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

    zilliz_key

    3. 启动容器

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

       # 启动容器
 docker-compose up -d
 # 等待10s，OneAPI第一次总是要重启几次才能连上Mysql
diff --git a/docs/development/faq/index.html b/docs/development/faq/index.html
index ebeaca54a6bd..6c4829e16724 100644
--- a/docs/development/faq/index.html
+++ b/docs/development/faq/index.html
@@ -16,7 +16,7 @@
 应用搭建案例
    • Docker 数据库迁移(无脑操作)
    database

    Docker 数据库迁移(无脑操作)

    FastGPT Docker 数据库备份和迁移

    Copy文件

    Docker 部署数据库都会通过 volume 挂载本地的目录进入容器，如果要迁移，直接复制这些目录即可。

    PG 数据: pg/data -Mongo 数据: mongo/data

    编辑此页面
    diff --git a/docs/development/migration/docker_mongo/index.html b/docs/development/migration/docker_mongo/index.html index 0b08d7e6acaf..1ec55e32f8d6 100644 --- a/docs/development/migration/docker_mongo/index.html +++ b/docs/development/migration/docker_mongo/index.html @@ -16,7 +16,7 @@ 应用搭建案例
  • 对话接口
    chat

    对话接口

    FastGPT OpenAPI 对话接口

    发起对话

    • 请求简易应用和工作流

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

    请求 

    +Table of Contents
    chat

    对话接口

    FastGPT OpenAPI 对话接口

    发起对话

    请求简易应用和工作流

    对话接口兼容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' \
@@ -54,7 +54,7 @@
         }
     ]
 }'
-
    • 仅messages有部分区别，其他参数一致。
    • 目前不支持上次文件，需上传到自己的对象存储中，获取对应的文件链接。
    +
    • 仅messages有部分区别，其他参数一致。
    • 目前不支持上次文件，需上传到自己的对象存储中，获取对应的文件链接。
       curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
 --header 'Authorization: Bearer fastgpt-xxxxxx' \
 --header 'Content-Type: application/json' \
@@ -84,11 +84,11 @@
         }
     ]
 }'
-

    响应 

    +

    响应 

       {
     "id": "adsfasf",
     "model": "",
@@ -108,7 +108,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}]}
@@ -116,7 +116,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 自行查看最新值。
         {
@@ -200,7 +200,7 @@
         }
     ]
 }
-  
    +  
       event: flowNodeStatus
 data: {"status":"running","name":"知识库搜索"}
 
@@ -230,8 +230,8 @@
 
 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: 报错

    交互节点响应

    如果工作流中包含交互节点，依然是调用该 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",
@@ -250,7 +250,7 @@
         }
     }
 }
-  
    +  
       {
     "interactive": {
         "type": "userInput",
@@ -293,8 +293,8 @@
         }
     }
 }
-

    交互节点继续运行

    紧接着上一节，当你接收到交互节点信息后，可以根据这些数据进行 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' \
@@ -309,7 +309,7 @@
         }
     ]
 }'
-

    表单输入稍微麻烦一点，需要将输入的内容，以对象形式并序列化成字符串，作为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' \
@@ -335,9 +335,9 @@
         "query":"你好" # 我的插件输入有一个参数，变量名叫 query
     }
 }'
-

    响应示例

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

    响应示例

    • 插件的输出可以通过查找responseData中, moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
    • 流输出，仍可以通过choices进行获取。
       {
     "responseData": [
         {
@@ -394,7 +394,7 @@
         }
     ]
 }
-
    • 插件的输出可以通过获取event=flowResponses中的字符串，并将其反序列化后得到一个数组。同样的，查找 moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
    • 流输出，仍和对话接口一样获取。
    +
    • 插件的输出可以通过获取event=flowResponses中的字符串，并将其反序列化后得到一个数组。同样的，查找 moduleType=pluginOutput的元素，其pluginOutput是插件的输出。
    • 流输出，仍和对话接口一样获取。
       event: flowNodeStatus
 data: {"status":"running","name":"AI 对话"}
 
@@ -451,9 +451,9 @@
 
 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' \
@@ -463,7 +463,7 @@
     "pageSize": 20,
     "source: "api"
 }'
-  
    +  
       {
     "code": 200,
     "statusText": "",
@@ -490,9 +490,9 @@
         "total": 2
     }
 }
-

    修改某个对话的标题 

    +

    修改某个对话的标题 

       curl --location --request POST 'http://localhost:3000/api/core/chat/updateHistory' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -501,16 +501,16 @@
     "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' \
@@ -519,43 +519,43 @@
     "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
 }
-

    清空所有历史记录 

    +

    清空所有历史记录 

       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": "",
@@ -609,9 +609,9 @@
         }
     }
 }
-

    获取对话记录列表 

    +

    获取对话记录列表 

       curl --location --request POST 'http://localhost:3000/api/core/chat/getPaginationRecords' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -622,7 +622,7 @@
     "pageSize": 10,
     "loadCustomFeedbacks": true
 }'
-  
    +  
       {
     "code": 200,
     "statusText": "",
@@ -671,12 +671,12 @@
         "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": "",
@@ -722,21 +722,21 @@
         }
     ]
 }
-

    删除对话记录 

    +

    删除对话记录 

       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' \
@@ -746,16 +746,16 @@
     "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' \
@@ -765,16 +765,16 @@
     "dataId": "dataId",
     "userBadFeedback": "yes"
 }'
-  
    +  
       {
     "code": 200,
     "statusText": "",
     "message": "",
     "data": null
 }
-

    猜你想问 

    +

    猜你想问 

       curl --location --request POST 'http://localhost:3000/api/core/ai/agent/createQuestionGuide' \
 --header 'Authorization: Bearer {{apikey}}' \
 --header 'Content-Type: application/json' \
@@ -790,7 +790,7 @@
         }
     ]
 }'
-  
    +  
       {
     "code": 200,
     "statusText": "",
diff --git a/docs/development/openapi/dataset/index.html b/docs/development/openapi/dataset/index.html
index b0c1601fff53..8df73b661462 100644
--- a/docs/development/openapi/dataset/index.html
+++ b/docs/development/openapi/dataset/index.html
@@ -16,7 +16,7 @@
 应用搭建案例
    • 知识库接口
    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' \
@@ -41,16 +41,16 @@
     "datasetId": "知识库 ID",
     "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' \
@@ -63,23 +63,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": "",
@@ -106,12 +106,12 @@
         }
     ]
 }
-

    获取知识库详情 

    +

    获取知识库详情 

       curl --location --request GET 'http://localhost:3000/api/core/dataset/detail?id=6593e137231a2be9c5603ba7' \
 --header 'Authorization: Bearer {{authorization}}' \
-  
    +  
       {
     "code": 200,
     "statusText": "",
@@ -147,21 +147,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拆分提示词
    tags集合标签（字符串数组）
    createTime文件创建时间（Date / String）

    出参

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

    创建一个空的集合 

    +

    集合

    通用创建参数说明

    入参

    参数说明必填
    datasetId知识库ID✅
    parentId：父级ID，不填则默认为根目录
    trainingType训练模式。chunk: 按文本长度进行分割;qa: QA拆分;auto: 增强训练✅
    chunkSize预估块大小
    chunkSplitter自定义最高优先分割符号
    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' \
@@ -174,16 +174,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' \
@@ -200,7 +200,7 @@
 
     "metadata":{}
 }'
-

    data 为集合的 ID。

    +

    data 为集合的 ID。

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

    创建一个链接集合

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

    +

    创建一个链接集合

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

       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 @@
         "webPageSelector":".docs-content"
     }
 }'
-

    data 为集合的 ID。

    +

    data 为集合的 ID。

       {
     "code": 200,
     "statusText": "",
@@ -250,14 +250,14 @@
         }
     }
 }
-

    创建一个文件集合

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

    创建一个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 @@
     "chunkSplitter":"",
     "qaPrompt":""
 }'
-

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

    data 为集合的 ID。

    +

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

    data 为集合的 ID。

       {
     "code": 200,
     "statusText": "",
@@ -305,9 +305,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)' \
@@ -326,7 +326,7 @@
     "chunkSplitter":"",
     "qaPrompt":""
 }'
-
    参数说明必填
    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 @@
     }
   }
 }
-

    获取集合列表 

    +

    获取集合列表 

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

    获取集合详情 

    +

    获取集合详情 

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

    修改集合信息

    通过集合 ID 修改集合信息

    +

    修改集合信息

    通过集合 ID 修改集合信息

       curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -487,29 +487,29 @@
     "forbid": false,
     "createTime": "2024-01-01T00:00:00.000Z"
 }'
-  
    +  
       {
     "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' \
@@ -537,7 +537,7 @@
         }
     ]
 }'
-  
    +  
       {
     "code": 200,
     "statusText": "",
@@ -548,7 +548,7 @@
         "error": [] // 其他错误
     }
 }
-

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

    +

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

       我会给你一段文本，{{theme}}，学习它们，并整理学习成果，要求为：
 1. 提出最多 25 个问题。
 2. 给出每个问题的答案。
@@ -562,9 +562,9 @@
 ……
 
 我的文本："""{{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' \
@@ -584,7 +584,7 @@
     "collectionId":"65abd4ac9d1448617cba6171",
     "searchText":""
 }'
-  
    +  
       {
     "code": 200,
     "statusText": "",
@@ -613,12 +613,12 @@
         "total": 63
     }
 }
-

    获取单条数据详情 

    +

    获取单条数据详情 

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

    修改单条数据 

    +

    修改单条数据 

       curl --location --request PUT 'http://localhost:3000/api/core/dataset/data/update' \
 --header 'Authorization: Bearer {{authorization}}' \
 --header 'Content-Type: application/json' \
@@ -666,28 +666,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' \
@@ -699,7 +699,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/index.html b/docs/development/openapi/index.html
index ba6e9e8cab88..7659347bd056 100644
--- a/docs/development/openapi/index.html
+++ b/docs/development/openapi/index.html
@@ -16,7 +16,7 @@
 应用搭建案例

  • 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": "身份验证失败",
@@ -200,9 +200,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) {
@@ -215,7 +215,7 @@
 
   return { success: false,message:"身份错误" }
 }
-

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

    +

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

       import cloud from '@lafjs/cloud'
 
 export default async function (ctx: FunctionContext) {
@@ -233,7 +233,7 @@
 
   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 3857c2bb8063..23e2f784dc19 100644
--- a/docs/development/proxy/cloudflare/index.html
+++ b/docs/development/proxy/cloudflare/index.html
@@ -16,7 +16,7 @@
 应用搭建案例

  • 改动目的是，我们认为不需要留有选择余地，选择一个最合适的模型去进行任务即可。

    • 编辑此页面
    diff --git a/docs/development/upgrading/43/index.html b/docs/development/upgrading/43/index.html index 2c0a441a27e5..362fa7e3fd04 100644 --- a/docs/development/upgrading/43/index.html +++ b/docs/development/upgrading/43/index.html @@ -1,4 +1,4 @@ -升级到 V4.3(需要初始化) | FastGPT
    diff --git a/docs/development/upgrading/462/index.html b/docs/development/upgrading/462/index.html index f2dce2a99c76..76f15a12e408 100644 --- a/docs/development/upgrading/462/index.html +++ b/docs/development/upgrading/462/index.html @@ -1,4 +1,4 @@ -V4.6.2(需要初始化) | FastGPT
    编辑此页面

    © 2024 the FastGPT Authors.

    云操作系统Sealos +

    会初始化计费系统，内部使用可把免费的存储拉大。

    V4.6.8 更新说明

    1. 新增 - 知识库搜索合并模块。
    2. 新增 - 新的 Http 模块，支持更加灵活的参数传入。同时支持了输入输出自动数据类型转化，例如：接口输出的 JSON 类型会自动转成字符串类型，直接给其他模块使用。此外，还补充了一些例子，可在文档中查看。
    3. 优化 - 内容补全。将内容补全内置到【知识库搜索】中，并实现了一次内容补全，即可完成“指代消除”和“问题扩展”。FastGPT知识库搜索详细流程可查看：知识库搜索介绍
    4. 优化 - LLM 模型配置，不再区分对话、分类、提取模型。同时支持模型的默认参数，避免不同模型参数冲突，可通过defaultConfig传入默认的配置。
    5. 优化 - 流响应，参考了ChatNextWeb的流，更加丝滑。此外，之前提到的乱码、中断，刷新后又正常了，可能会修复）
    6. 修复 - 语音输入文件无法上传。
    7. 修复 - 对话框重新生成无法使用。
    编辑此页面
    diff --git a/docs/development/upgrading/469/index.html b/docs/development/upgrading/469/index.html index eb89aa0faff9..2fa01092d488 100644 --- a/docs/development/upgrading/469/index.html +++ b/docs/development/upgrading/469/index.html @@ -1,4 +1,4 @@ -V4.6.9(需要初始化) | FastGPT
    编辑此页面