| 如何获取知识库ID（datasetId） | 如何获取文件集合ID（collection_id） |
|---|
 |  |
创建训练订单(4.6.9地址发生改动) link
新例子
curl --location --request POST 'https://api.fastgpt.in/api/support/wallet/usage/createTrainingUsage' \
--header 'Authorization: Bearer {{apikey}}' \
--header 'Content-Type: application/json' \
@@ -41,16 +41,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' \
@@ -63,19 +63,19 @@
"vectorModel": "text-embedding-ada-002",
"agentModel": "gpt-3.5-turbo-16k"
}'
-
- parentId - 父级ID，用于构建目录结构。通常可以为 null 或者直接不传。
- type -
dataset或者folder，代表普通知识库和文件夹。不传则代表创建普通知识库。 - name - 知识库名（必填）
- intro - 介绍（可选）
- avatar - 头像地址（可选）
- vectorModel - 向量模型（建议传空，用系统默认的）
- agentModel - 文本处理模型（建议传空，用系统默认的）
- parentId - 父级ID，用于构建目录结构。通常可以为 null 或者直接不传。
- type -
dataset或者folder，代表普通知识库和文件夹。不传则代表创建普通知识库。 - name - 知识库名（必填）
- intro - 介绍（可选）
- avatar - 头像地址（可选）
- vectorModel - 向量模型（建议传空，用系统默认的）
- agentModel - 文本处理模型（建议传空，用系统默认的）
{
"code": 200,
"statusText": "",
"message": "",
"data": "65abc9bd9d1448617cba5e6c"
}
-
curl --location --request GET 'http://localhost:3000/api/core/dataset/list?parentId=' \
--header 'Authorization: Bearer {{authorization}}' \
-
- parentId - 父级ID，不传或为空，代表获取根目录下的知识库
- parentId - 父级ID，不传或为空，代表获取根目录下的知识库
{
"code": 200,
"statusText": "",
@@ -102,12 +102,12 @@
}
]
}
-
curl --location --request GET 'http://localhost:3000/api/core/dataset/detail?id=6593e137231a2be9c5603ba7' \
--header 'Authorization: Bearer {{authorization}}' \
-
{
"code": 200,
"statusText": "",
@@ -143,21 +143,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
}
-
通用创建参数说明 link
入参
| 参数 | 说明 | 必填 |
|---|
| datasetId | 知识库ID | ✅ |
| parentId： | 父级ID，不填则默认为根目录 | |
| trainingType | 训练模式。chunk: 按文本长度进行分割;qa: QA拆分;auto: 增强训练 | ✅ |
| chunkSize | 预估块大小 | |
| chunkSplitter | 自定义最高优先分割符号 | |
| qaPrompt | qa拆分提示词 | |
出参
- collectionId - 新建的集合ID
- insertLen：插入的块数量
创建一个空的集合 link
通用创建参数说明 link
入参
| 参数 | 说明 | 必填 |
|---|
| datasetId | 知识库ID | ✅ |
| parentId： | 父级ID，不填则默认为根目录 | |
| trainingType | 训练模式。chunk: 按文本长度进行分割;qa: QA拆分;auto: 增强训练 | ✅ |
| chunkSize | 预估块大小 | |
| chunkSplitter | 自定义最高优先分割符号 | |
| qaPrompt | qa拆分提示词 | |
出参
- collectionId - 新建的集合ID
- insertLen：插入的块数量
创建一个空的集合 link
curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -170,16 +170,16 @@
"test":111
}
}'
-
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- name: 集合名称（必填）
- type:
- folder：文件夹
- virtual：虚拟集合(手动集合)
- metadata： 元数据（暂时没啥用）
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- name: 集合名称（必填）
- type:
- folder：文件夹
- virtual：虚拟集合(手动集合)
- metadata： 元数据（暂时没啥用）
data 为集合的 ID。
{
"code": 200,
"statusText": "",
"message": "",
"data": "65abcd009d1448617cba5ee1"
}
-
创建一个纯文本集合 link
传入一段文字，创建一个集合，会根据传入的文字进行分割。
创建一个纯文本集合 link
传入一段文字，创建一个集合，会根据传入的文字进行分割。
curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/text' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -196,7 +196,7 @@
"metadata":{}
}'
-
- text: 原文本
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- name: 集合名称（必填）
- metadata： 元数据（暂时没啥用）
- trainingType:（必填）
- chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）
- chunkSplitter: 自定义最高优先分割符号（可选）
- qaPrompt: qa拆分自定义提示词（可选）
- text: 原文本
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- name: 集合名称（必填）
- metadata： 元数据（暂时没啥用）
- trainingType:（必填）
- chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）
- chunkSplitter: 自定义最高优先分割符号（可选）
- qaPrompt: qa拆分自定义提示词（可选）
data 为集合的 ID。
{
"code": 200,
"statusText": "",
@@ -211,9 +211,9 @@
}
}
}
-
创建一个链接集合 link
传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。
创建一个链接集合 link
传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。
curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/link' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -231,7 +231,7 @@
"webPageSelector":".docs-content"
}
}'
-
- link: 网络链接
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- metadata.webPageSelector: 网页选择器，用于指定网页中的哪个元素作为文本(可选)
- trainingType:（必填）
- chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）
- chunkSplitter: 自定义最高优先分割符号（可选）
- qaPrompt: qa拆分自定义提示词（可选）
- link: 网络链接
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- metadata.webPageSelector: 网页选择器，用于指定网页中的哪个元素作为文本(可选)
- trainingType:（必填）
- chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）
- chunkSplitter: 自定义最高优先分割符号（可选）
- qaPrompt: qa拆分自定义提示词（可选）
data 为集合的 ID。
{
"code": 200,
"statusText": "",
@@ -240,14 +240,14 @@
"collectionId": "65abd0ad9d1448617cba6031"
}
}
-
创建一个文件集合 link
传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。
创建一个文件集合 link
传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。
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 两个字段。
- file: 文件
- data: 知识库相关信息（json序列化后传入）
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- trainingType:（必填）
- chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）
- chunkSplitter: 自定义最高优先分割符号（可选）
- qaPrompt: qa拆分自定义提示词（可选）
需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。
- file: 文件
- data: 知识库相关信息（json序列化后传入）
- datasetId: 知识库的ID(必填)
- parentId： 父级ID，不填则默认为根目录
- trainingType:（必填）
- chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）
- chunkSplitter: 自定义最高优先分割符号（可选）
- qaPrompt: qa拆分自定义提示词（可选）
data 为集合的 ID。
{
"code": 200,
"statusText": "",
@@ -262,9 +262,9 @@
}
}
}
-
创建一个外部文件库集合（商业版） link
创建一个外部文件库集合（商业版） link
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)' \
@@ -281,7 +281,7 @@
"chunkSplitter":"",
"qaPrompt":""
}'
-
| 参数 | 说明 | 必填 |
|---|
| externalFileUrl | 文件访问链接（可以是临时链接） | ✅ |
| externalFileId | 外部文件ID | |
| filename | 自定义文件名 | |
| 参数 | 说明 | 必填 |
|---|
| externalFileUrl | 文件访问链接（可以是临时链接） | ✅ |
| externalFileId | 外部文件ID | |
| filename | 自定义文件名 | |
data 为集合的 ID。
{
"code": 200,
"statusText": "",
@@ -291,9 +291,9 @@
"insertLen": 3
}
}
-
curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/list' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -304,7 +304,7 @@
"parentId": null,
"searchText":""
}'
-
- pageNum: 页码（选填）
- pageSize: 每页数量，最大30（选填）
- datasetId: 知识库的ID(必填)
- parentId: 父级Id（选填）
- searchText: 模糊搜索文本（选填）
- pageNum: 页码（选填）
- pageSize: 每页数量，最大30（选填）
- datasetId: 知识库的ID(必填)
- parentId: 父级Id（选填）
- searchText: 模糊搜索文本（选填）
{
"code": 200,
"statusText": "",
@@ -340,12 +340,12 @@
"total": 93
}
}
-
curl --location --request GET 'http://localhost:3000/api/core/dataset/collection/detail?id=65abcfab9d1448617cba5f0d' \
--header 'Authorization: Bearer {{authorization}}' \
-
{
"code": 200,
"statusText": "",
@@ -384,9 +384,9 @@
"sourceName": "测试训练"
}
}
-
curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -395,29 +395,29 @@
"parentId":null,
"name":"测2222试"
}'
-
- id: 集合的ID
- parentId: 修改父级ID（可选）
- name: 修改集合名称（可选）
- id: 集合的ID
- parentId: 修改父级ID（可选）
- name: 修改集合名称（可选）
{
"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结构
| 字段 | 类型 | 说明 | 必填 |
|---|
| 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 | 文本内容 | ✅ |
为集合批量添加添加数据 link
注意，每次最多推送 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 | 文本内容 | ✅ |
为集合批量添加添加数据 link
注意，每次最多推送 200 组数据。
curl --location --request POST 'https://api.fastgpt.in/api/core/dataset/data/pushData' \
--header 'Authorization: Bearer apikey' \
--header 'Content-Type: application/json' \
@@ -445,7 +445,7 @@
}
]
}'
-
- collectionId: 集合ID（必填）
- trainingType:（必填）
- prompt: 自定义 QA 拆分提示词，需严格按照模板，建议不要传入。（选填）
- data：（具体数据）
- q: 主要数据（必填）
- a: 辅助数据（选填）
- indexes: 自定义索引（选填）。可以不传或者传空数组，默认都会使用q和a组成一个索引。
- collectionId: 集合ID（必填）
- trainingType:（必填）
- prompt: 自定义 QA 拆分提示词，需严格按照模板，建议不要传入。（选填）
- data：（具体数据）
- q: 主要数据（必填）
- a: 辅助数据（选填）
- indexes: 自定义索引（选填）。可以不传或者传空数组，默认都会使用q和a组成一个索引。
{
"code": 200,
"statusText": "",
@@ -456,7 +456,7 @@
"error": [] // 其他错误
}
}
-
{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容
{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容
我会给你一段文本，{{theme}}，学习它们，并整理学习成果，要求为：
1. 提出最多 25 个问题。
2. 给出每个问题的答案。
@@ -470,9 +470,9 @@
……
我的文本："""{{text}}"""
-
获取集合的数据列表 link
获取集合的数据列表 link
curl --location --request POST 'http://localhost:3000/api/core/dataset/data/list' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -482,7 +482,7 @@
"collectionId":"65abd4ac9d1448617cba6171",
"searchText":""
}'
-
- pageNum: 页码（选填）
- pageSize: 每页数量，最大30（选填）
- collectionId: 集合的ID（必填）
- searchText: 模糊搜索词（选填）
- pageNum: 页码（选填）
- pageSize: 每页数量，最大30（选填）
- collectionId: 集合的ID（必填）
- searchText: 模糊搜索词（选填）
{
"code": 200,
"statusText": "",
@@ -511,12 +511,12 @@
"total": 63
}
}
-
获取单条数据详情 link
获取单条数据详情 link
curl --location --request GET 'http://localhost:3000/api/core/dataset/data/detail?id=65abd4b29d1448617cba61db' \
--header 'Authorization: Bearer {{authorization}}' \
-
{
"code": 200,
"statusText": "",
@@ -543,9 +543,9 @@
"canWrite": true
}
}
-
curl --location --request PUT 'http://localhost:3000/api/core/dataset/data/update' \
--header 'Authorization: Bearer {{authorization}}' \
--header 'Content-Type: application/json' \
@@ -564,28 +564,28 @@
}
]
}'
-
- id: 数据的id
- q: 主要数据（选填）
- a: 辅助数据（选填）
- indexes: 自定义索引（选填），类型参考
为集合批量添加添加数据。如果创建时候有自定义索引，
- id: 数据的id
- q: 主要数据（选填）
- a: 辅助数据（选填）
- indexes: 自定义索引（选填），类型参考
为集合批量添加添加数据。如果创建时候有自定义索引，
{
"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' \
@@ -597,7 +597,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/share/index.html b/docs/development/openapi/share/index.html
index 2fa4228efe5a..7808bc0e51cb 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. 配置身份校验地址 link
配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。
2. 分享链接中增加额外 query link
在分享链接的地址中，增加一个额外的参数: 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. 编写聊天初始化校验接口 link
FastGPT 将会判断success是否为true决定是允许用户继续操作。message与msg是等同的，你可以选择返回其中一个，当success不为true时，将会提示这个错误。
uid是用户的唯一凭证，将会用于拉取对话记录以及保存对话记录。可参考下方实践案例。
1. 配置身份校验地址 link
配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。
2. 分享链接中增加额外 query link
在分享链接的地址中，增加一个额外的参数: 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. 编写聊天初始化校验接口 link
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. 编写对话前校验接口 link
4. 编写对话前校验接口 link
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接口 link
这个接口中，我们设置了token必须等于fastgpt才能通过校验。（实际生产中不建议固定写死）
我们以Laf作为服务器为例，简单展示这 3 个接口的使用方式。
1. 创建3个Laf接口 link
这个接口中，我们设置了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/workflow/modules/http/index.html b/docs/workflow/modules/http/index.html
index 74ea8e648d44..b479d88fb8d8 100644
--- a/docs/workflow/modules/http/index.html
+++ b/docs/workflow/modules/http/index.html
@@ -26,9 +26,9 @@
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条，无法修改长度）
不多描述，使用方法和Postman, ApiFox 基本一致。
可通过 {{key}} 来引入变量。例如：
| key | value |
|---|
| appId | {{appId}} |
| Authorization | Bearer {{token}} |
只有特定请求类型下会生效。
可以写一个自定义的 Json，并通过 {{key}} 来引入变量。例如：
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条，无法修改长度）
不多描述，使用方法和Postman, ApiFox 基本一致。
可通过 {{key}} 来引入变量。例如：
| key | value |
|---|
| appId | {{appId}} |
| Authorization | Bearer {{token}} |
只有特定请求类型下会生效。
可以写一个自定义的 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 },
diff --git a/index.xml b/index.xml
index 9deceda4d65d..341689d7d02a 100644
--- a/index.xml
+++ b/index.xml
@@ -90,8 +90,10 @@ waiting：被连接的节点等待执行。 active：被连接的节点可以执
你可以直接在 FastGPT 中配置词库，或者提供自定义词库接口。
自定义词库接口 link需要保证这个接口可以被用户浏览器访问。
请求：
-curl --location --request GET 'http://localhost:3000/api/core/chat/inputGuide/query?appId=663c75302caf8315b1c00194&searchKey=你' 响应
-{ "code": 200, "statusText": "", "message": "", "data": [ "是你", "你是谁呀", "你好好呀", "你好呀", "你是谁！", "你好" ] } 参数说明：
+curl --location --request GET 'http://localhost:3000/api/core/chat/inputGuide/query?appId=663c75302caf8315b1c00194&searchKey=你' 其中 appId 为应用ID，searchKey 为搜索关键字，最多是50个字符。
+响应
+{ "code": 200, "statusText": "", "message": "", "data": [ "是你", "你是谁呀", "你好好呀", "你好呀", "你是谁！", "你好" ] } data是一个数组，包含了搜索到的问题，最多只需要返回5个问题。
+参数说明：
appId - 应用ID searchKey - 搜索关键字- AI 对话/docs/workflow/modules/ai_chat/Mon, 01 Jan 0001 00:00:00 +0000/docs/workflow/modules/ai_chat/特点 link 可重复添加 触发执行 核心模块 参数说明 linkAI模型 link可以通过 config.json 配置可选的对话模型，通过 one-api 来实现多模型接入。
点击AI模型后，可以配置模型的相关参数。
🍅
