协议
加入社区
forum
加入社区
加入 FastGPT 开发者社区和我们一起成长
FastGPT 是一个由用户和贡献者参与推动的开源项目，如果您对产品使用存在疑问和建议，可尝试以下方式寻求支持。我们的团队与社区会竭尽所能为您提供帮助。
📱 扫码加入社区微信交流群👇
🐞 请将任何 FastGPT 的 Bug、问题和需求提交到 GitHub Issue。
Docker Compose 快速部署
article
Docker Compose 快速部署
使用 Docker Compose 快速部署 FastGPT
推荐配置
| 环境 | 最低配置（单节点） | 推荐配置 |
|---|---|---|
| 测试 | 2c2g | 2c4g |
| 100w 组向量 | 4c8g 50GB | 4c16g 50GB |
| 500w 组向量 | 8c32g | 16c64g 200GB |
部署架构图
1. 准备好代理环境（国外服务器可忽略）
确保可以访问 OpenAI，具体方案可以参考：代理方案。或直接在 Sealos 上 部署 OneAPI，既解决代理问题也能实现多 Key 轮询、接入其他大模型。
2. 多模型支持
FastGPT 使用了 one-api 项目来管理模型池，其可以兼容 OpenAI 、Azure 、国内主流模型和本地模型等。
可选择 Sealos 快速部署 OneAPI，更多部署方法可参考该项目的 README，也可以直接通过以下按钮一键部署：
一、安装 Docker 和 docker-compose
+Table of Contents
article
Docker Compose 快速部署
使用 Docker Compose 快速部署 FastGPT
推荐配置
| 环境 | 最低配置（单节点） | 推荐配置 |
|---|---|---|
| 测试 | 2c2g | 2c4g |
| 100w 组向量 | 4c8g 50GB | 4c16g 50GB |
| 500w 组向量 | 8c32g | 16c64g 200GB |
部署架构图
1. 准备好代理环境（国外服务器可忽略）
确保可以访问 OpenAI，具体方案可以参考：代理方案。或直接在 Sealos 上 部署 OneAPI，既解决代理问题也能实现多 Key 轮询、接入其他大模型。
2. 多模型支持
FastGPT 使用了 one-api 项目来管理模型池，其可以兼容 OpenAI 、Azure 、国内主流模型和本地模型等。
可选择 Sealos 快速部署 OneAPI，更多部署方法可参考该项目的 README，也可以直接通过以下按钮一键部署：
一、安装 Docker 和 docker-compose
二、创建目录并下载 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/faq/index.html b/docs/development/faq/index.html
index 5c09851f14f..09ac5da35ce 100644
--- a/docs/development/faq/index.html
+++ b/docs/development/faq/index.html
@@ -20,7 +20,7 @@
商业版介绍currency_yen
线上版定价 forum
+协议 forum
加入社区 对话接口
chat
对话接口
FastGPT OpenAPI 对话接口
发起对话
该接口的 API Key 需使用应用特定的 key，否则会报错。
有些包调用时，BaseUrl需要添加v1路径，有些不需要，如果出现404情况，可补充v1重试。
对话接口兼容GPT的接口！如果你的项目使用的是标准的GPT官方接口，可以直接通过修改BaseUrl和 Authorization来访问 FastGpt 应用。
请求
+Table of Contents
chat
对话接口
FastGPT OpenAPI 对话接口
发起对话
该接口的 API Key 需使用应用特定的 key，否则会报错。
有些包调用时，BaseUrl需要添加v1路径，有些不需要，如果出现404情况，可补充v1重试。
对话接口兼容GPT的接口！如果你的项目使用的是标准的GPT官方接口，可以直接通过修改BaseUrl和 Authorization来访问 FastGpt 应用。
请求
响应
响应
{
"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 e60450a7144..00ca4df54d4 100644
--- a/docs/development/openapi/dataset/index.html
+++ b/docs/development/openapi/dataset/index.html
@@ -20,13 +20,13 @@
商业版介绍currency_yen
线上版定价 forum
+协议 forum
加入社区 知识库接口
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地址发生改动)
知识库
创建一个知识库
知识库
创建一个知识库
获取知识库列表
获取知识库列表
获取知识库详情
获取知识库详情
删除一个知识库
删除一个知识库
集合
创建一个空的集合
集合
创建一个空的集合
创建一个纯文本集合
传入一段文字，创建一个集合，会根据传入的文字进行分割。
创建一个纯文本集合
传入一段文字，创建一个集合，会根据传入的文字进行分割。
创建一个链接集合
传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。
创建一个链接集合
传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。
创建一个文件集合(商业版)
传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。
创建一个文件集合(商业版)
传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。
获取集合列表
获取集合列表
获取集合详情
获取集合详情
修改集合信息
修改集合信息
删除一个集合
删除一个集合
数据
数据的结构
Data结构
| 字段 | 类型 | 说明 | 必填 |
|---|---|---|---|
| teamId | String | 团队ID | ✅ |
| tmbId | String | 成员ID | ✅ |
| datasetId | String | 知识库ID | ✅ |
| collectionId | String | 集合ID | ✅ |
| q | String | 主要数据 | ✅ |
| a | String | 辅助数据 | ✖ |
| fullTextToken | String | 分词 | ✖ |
| indexes | Index[] | 向量索引 | ✅ |
| updateTime | Date | 更新时间 | ✅ |
| chunkIndex | Number | 分块下表 | ✖ |
Index结构
每组数据的自定义索引最多5个
| 字段 | 类型 | 说明 | 必填 |
|---|---|---|---|
| defaultIndex | Boolean | 是否为默认索引 | ✅ |
| dataId | String | 关联的向量ID | ✅ |
| text | String | 文本内容 | ✅ |
为集合批量添加添加数据
注意，每次最多推送 200 组数据。
数据
数据的结构
Data结构
| 字段 | 类型 | 说明 | 必填 |
|---|---|---|---|
| teamId | String | 团队ID | ✅ |
| tmbId | String | 成员ID | ✅ |
| datasetId | String | 知识库ID | ✅ |
| collectionId | String | 集合ID | ✅ |
| q | String | 主要数据 | ✅ |
| a | String | 辅助数据 | ✖ |
| fullTextToken | String | 分词 | ✖ |
| indexes | Index[] | 向量索引 | ✅ |
| updateTime | Date | 更新时间 | ✅ |
| chunkIndex | Number | 分块下表 | ✖ |
Index结构
每组数据的自定义索引最多5个
| 字段 | 类型 | 说明 | 必填 |
|---|---|---|---|
| defaultIndex | Boolean | 是否为默认索引 | ✅ |
| dataId | String | 关联的向量ID | ✅ |
| text | String | 文本内容 | ✅ |
为集合批量添加添加数据
注意，每次最多推送 200 组数据。
获取集合的数据列表
获取集合的数据列表
获取单条数据详情
获取单条数据详情
修改单条数据
修改单条数据
删除单条数据
删除单条数据
搜索测试
搜索测试
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
}'
- - datasetId - 知识库ID
- text - 需要测试的文本
- limit - 最大 tokens 数量
- similarity - 最低相关度（0~1，可选）
- searchMode - 搜索模式：embedding | fullTextRecall | mixedRecall
- usingReRank - 使用重排
返回 top k 结果， limit 为最大 Tokens 数量，最多 20000 tokens。
+
- datasetId - 知识库ID
- text - 需要测试的文本
- limit - 最大 tokens 数量
- similarity - 最低相关度（0~1，可选）
- searchMode - 搜索模式：embedding | fullTextRecall | mixedRecall
- usingReRank - 使用重排
返回 top k 结果， limit 为最大 Tokens 数量，最多 20000 tokens。
{
"code": 200,
"statusText": "",
diff --git a/docs/development/openapi/index.html b/docs/development/openapi/index.html
index a6a93d012f0..f046c1ccc8c 100644
--- a/docs/development/openapi/index.html
+++ b/docs/development/openapi/index.html
@@ -20,7 +20,7 @@
商业版介绍currency_yen
线上版定价 forum
+协议 forum
加入社区 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. 编写聊天初始化校验接口
4. 编写对话前校验接口
4. 编写对话前校验接口
5. 编写对话结果上报接口（可选）
该接口无规定返回值。
响应值与chat 接口格式相同，仅多了一个token。
+
5. 编写对话结果上报接口（可选）
该接口无规定返回值。
响应值与chat 接口格式相同，仅多了一个token。
curl --location --request POST '{{host}}/shareAuth/finish' \
--header 'Content-Type: application/json' \
--data-raw '{
@@ -92,7 +92,7 @@
"totalPoints": 1.5278,
"query": "导演是谁\n《铃芽之旅》的导演是谁？\n这部电影的导演是谁？\n谁是《铃芽之旅》的导演？",
"model": "Embedding-2(旧版，不推荐使用)",
- "charsLength": 1524,
+ "tokens": 1524,
"similarity": 0.83,
"limit": 400,
"searchMode": "embedding",
@@ -106,7 +106,7 @@
"moduleType": "chatNode",
"totalPoints": 0.593,
"model": "FastAI-4k",
- "charsLength": 593,
+ "tokens": 593,
"query": "导演是谁",
"maxToken": 2000,
"quoteList": [
@@ -150,7 +150,7 @@
}'
- responseData 完整字段说明：
+
responseData 完整字段说明：
type ResponseType = {
moduleType: `${FlowNodeTypeEnum}`; // 模块类型
moduleName: string; // 模块名
@@ -159,7 +159,7 @@
query?: string; // 用户问题/检索词
textOutput?: string; // 文本输出
- charsLength?: number; // 上下文总字数
+ tokens?: number; // 上下文总Tokens
model?: string; // 使用到的模型
contextTotalLen?: number; // 上下文总长度
totalPoints?: number; // 总消耗AI积分
@@ -175,7 +175,7 @@
searchUsingReRank?: boolean; // 是否使用rerank
extensionModel?: string; // 问题扩展模型
extensionResult?: string; // 问题扩展结果
- extensionCharsLength?: number; // 问题扩展总字符长度
+ extensionTokens?: number; // 问题扩展总字符长度
cqList?: ClassifyQuestionAgentItemType[]; // 分类问题列表
cqResult?: string; // 分类问题结果
@@ -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/development/proxy/cloudflare/index.html b/docs/development/proxy/cloudflare/index.html
index 13bbb273d6f..cbe39a9f044 100644
--- a/docs/development/proxy/cloudflare/index.html
+++ b/docs/development/proxy/cloudflare/index.html
@@ -20,7 +20,7 @@
商业版介绍currency_yen
线上版定价 forum
+协议 forum
加入社区 线上版定价
currency_yen
线上版定价
FastGPT 线上版定价
Tokens 说明
OpenAI 的 API 官方计费模式为：按每次 API 请求内容和返回内容 tokens 长度来定价。每个模型具有不同的计价方式，以每 1,000 个 tokens 消耗为单位定价。其中 1,000 个 tokens 约为 900 个英文，约 600 个中文（不是很准确，与上下长度有关，相同的词出现越多，词:Tokens 的比例越大）。平台的 tokens 数量计算算法与 OpenAI 一致，您可以随时通过「使用记录」来查看余额消耗明细的说明，来对比计算是否一致。
FastGPT 线上计费
https://fastgpt.in 采用按量计费的模式，最新计费标准可在 账号-计费标准 查看。同时可以在 账号-使用记录 中查看具体使用情况，
