FastGPTFastGPT

通过文本创建集合

将纯文本或 Markdown 内容保存为集合文件并按分块与训练规则入库,触发异步索引训练以供知识库检索。

端点概览

  • HTTP 方法:POST
  • 请求路径:/api/core/dataset/collection/create/text
  • 所属模块:知识库 / 集合创建
  • 鉴权方式:Authorization: Bearer <apiKey>—个人密钥(按归属团队成员资源权限校验)(详见 API 入门:完成首次请求)
  • 在线调试:在云服务 Scalar 调试台打开(自部署实例请将域名替换为 <instance>/apidoc/systemopenapi#tag/%E9%9B%86%E5%90%88%E5%88%9B%E5%BB%BA/POST/core/dataset/collection/create/text)

接口说明与注意事项

将文本内容存储为文件后创建集合并触发训练

请求参数

Request Body 请求体(application/json)

字段类型必填默认值约束与说明
trainingTypestring (enum)否-训练类型。可选值:chunk , qa , imageParse , backup , template , auto
chunkTriggerTypestring (enum)否-分块触发时机。可选值:minSize , forceChunk , maxSize
chunkTriggerMinSizenumber否-分块触发最小大小
dataEnhanceCollectionNameboolean否-增加集合名到分块里
imageIndexboolean否-图片索引
autoIndexesboolean否-自动生成索引
indexPrefixTitleboolean否-索引前缀标题
chunkSettingModestring (enum)否-系统参数/自定义参数。可选值:auto , custom , intelligent
chunkSplitModestring (enum)否-分块拆分模式。可选值:paragraph , size , char
paragraphChunkAIModestring (enum)否-段落分块 AI 模式。可选值:auto , force , forbid
paragraphChunkDeepnumber否-段落分块深度
paragraphChunkMinSizenumber否-段落分块最小大小
chunkSizenumber否-分块大小
chunkSplitterstring否-自定义最高优先分割符号
indexSizenumber否-索引大小
qaPromptstring否-QA 拆分提示词
parentIdstring | null否-父级目录 ID
metadataobject否-元数据
customPdfParseboolean否-自定义 PDF 解析
datasetIdstring是-数据集 ID
tagsstring | object[]否-标签列表。字符串元素为旧格式标签名(按名称归并到 default_tag array 标签);对象元素为 { tag: 标签名, value: 标签值 },按标签名解析
namestring是-集合名称
textstring是-文本内容

请求示例

调用前请将 YOUR_API_KEY 与示例 ID 替换为真实值;私有化部署实例请将基础域名替换为 <instance>/api。

cURL 请求示例

curl --fail-with-body -X POST "https://cloud.fastgpt.cn/api/core/dataset/collection/create/text" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "datasetId": "string",
  "name": "string",
  "text": "string"
}'

最小合法 JSON 请求体示例

{
  "datasetId": "string",
  "name": "string",
  "text": "string"
}

响应结构与示例

除兼容 OpenAI 协议的对话补全或二进制下载接口外,成功响应统一包裹在 { "code": 200, "statusText": "", "message": "", "data": ... } 标准结构中;下方 200 字段表对应 data 载荷结构(若契约未声明具体载荷结构,请以上方状态描述及实际响应为准)。

HTTP 200

成功返回集合 ID 及数据插入结果

返回 FastGPT 标准成功响应结构({ "code": 200, "statusText": "", "message": "", "data": ... })。当前 OpenAPI 契约暂未声明 data 的具体字段结构,请结合上方状态描述或实际返回结果处理。

在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

让你的企业知识真正被 AI 用起来