FastGPTFastGPT

获取知识库详情

根据知识库 ID 获取完整配置详情,包括向量模型、Agent 模型、VLM 模型、分块默认配置、同步状态与当前成员有效权限。

端点概览

  • HTTP 方法:GET
  • 请求路径:/api/core/dataset/detail
  • 所属模块:知识库 / 知识库管理
  • 鉴权方式:Authorization: Bearer <apiKey>—个人密钥(按归属团队成员资源权限校验)(详见 API 入门:完成首次请求)
  • 在线调试:在云服务 Scalar 调试台打开(自部署实例请将域名替换为 <instance>/apidoc/systemopenapi#tag/%E7%9F%A5%E8%AF%86%E5%BA%93%E7%AE%A1%E7%90%86/GET/core/dataset/detail)

接口说明与注意事项

获取知识库详细信息,包括模型配置、权限和同步状态

请求参数

Query 查询参数

字段类型必填默认值约束与说明
idstring是-知识库 ID。正则:^[0-9a-fA-F]{24}$

请求示例

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

cURL 请求示例

curl --fail-with-body -X GET "https://cloud.fastgpt.cn/api/core/dataset/detail?id=68ad85a7463006c963799a05" \
  -H "Authorization: Bearer YOUR_API_KEY"

响应结构与示例

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

HTTP 200

成功返回知识库详情(不包含创建时间)

Content-Type : application/json

字段类型必填默认值约束与说明
_idstring是-数据集 ID。正则:^[0-9a-fA-F]{24}$
parentIdstring | null否-父级 ID
userIdstring否-已弃用。用户 ID。正则:^[0-9a-fA-F]{24}$
teamIdstring是-团队 ID。正则:^[0-9a-fA-F]{24}$
tmbIdstring是-团队成员 ID。正则:^[0-9a-fA-F]{24}$
updateTimestring是-更新时间
inheritPermissionboolean是-继承权限
collectionPermissionEnabledboolean否-collection 级权限开关:false 表示关闭态(默认,可读性等于 dataset)
avatarstring是"/icon/logo.svg"头像
namestring是-名称
introstring是-简介
typestring (enum)是-数据集类型。可选值:folder , dataset , websiteDataset , externalFile , apiDataset , feishu , yuque , dingtalk
vectorModelIdstring否-向量模型 ID
agentModelIdstring否-AI 模型 ID
vlmModelIdstring否-视觉语言模型 ID
websiteConfigobject否-网站配置
websiteConfig.urlstring是-网站 URL
websiteConfig.selectorstring是-网站选择器
chunkSettingsobject否-分块配置
chunkSettings.trainingTypestring (enum)否-训练类型。可选值:chunk , qa , imageParse , backup , template , auto
chunkSettings.chunkTriggerTypestring (enum)否-分块触发时机。可选值:minSize , forceChunk , maxSize
chunkSettings.chunkTriggerMinSizenumber否-分块触发最小大小
chunkSettings.dataEnhanceCollectionNameboolean否-增加集合名到分块里
chunkSettings.imageIndexboolean否-图片索引
chunkSettings.autoIndexesboolean否-自动生成索引
chunkSettings.indexPrefixTitleboolean否-索引前缀标题
chunkSettings.chunkSettingModestring (enum)否-系统参数/自定义参数。可选值:auto , custom , intelligent
chunkSettings.chunkSplitModestring (enum)否-分块拆分模式。可选值:paragraph , size , char
chunkSettings.paragraphChunkAIModestring (enum)否-段落分块 AI 模式。可选值:auto , force , forbid
chunkSettings.paragraphChunkDeepnumber否-段落分块深度
chunkSettings.paragraphChunkMinSizenumber否-段落分块最小大小
chunkSettings.chunkSizenumber否-分块大小
chunkSettings.chunkSplitterstring否-自定义最高优先分割符号
chunkSettings.indexSizenumber否-索引大小
chunkSettings.qaPromptstring否-QA 拆分提示词
sangforFileParseConfigobject否-外部文档解析配置
sangforFileParseConfig.keep_header_footerboolean否-是否保留页眉页脚,默认关闭(删除页眉页脚)
sangforFileParseConfig.keep_appendixboolean否-是否保留附录,默认开启
sangforFileParseConfig.image_analysisboolean否-是否保留图片识别(含印章)结果,默认关闭
sangforFileParseConfig.chart_analysisboolean否-是否保留图表转表格结果(同时保留原图片),默认关闭
apiDatasetServerobject否-API 服务器配置
apiDatasetServer.apiServerobject否-API 服务器配置
apiDatasetServer.apiServer.baseUrlstring是--
apiDatasetServer.apiServer.authorizationstring否--
apiDatasetServer.apiServer.basePathstring否--
apiDatasetServer.feishuServerobject否-飞书服务器配置
apiDatasetServer.feishuServer.appIdstring是--
apiDatasetServer.feishuServer.appSecretstring否--
apiDatasetServer.feishuServer.folderTokenstring是--
apiDatasetServer.yuqueServerobject否-语雀服务器配置
apiDatasetServer.yuqueServer.userIdstring是--
apiDatasetServer.yuqueServer.tokenstring否--
apiDatasetServer.yuqueServer.basePathstring否--
apiDatasetServer.dingtalkServerobject否-钉钉知识库配置
apiDatasetServer.dingtalkServer.appKeystring是--
apiDatasetServer.dingtalkServer.appSecretstring否--
apiDatasetServer.dingtalkServer.userIdstring是--
apiDatasetServer.dingtalkServer.operatorIdstring否--
apiDatasetServer.dingtalkServer.workspaceIdstring否--
apiDatasetServer.dingtalkServer.rootNodeIdstring否--
apiDatasetServer.dingtalkServer.workspaceNamestring否--
deleteTimestring | null否-删除时间
autoSyncboolean否-自动同步
externalReadUrlstring否-已弃用。外部读取 URL
defaultPermissionnumber否-已弃用。默认权限
apiServerobject否-已弃用。API 服务器配置
apiServer.baseUrlstring是--
apiServer.authorizationstring否--
apiServer.basePathstring否--
feishuServerobject否-已弃用。飞书服务器配置
feishuServer.appIdstring是--
feishuServer.appSecretstring否--
feishuServer.folderTokenstring是--
yuqueServerobject否-已弃用。语雀服务器配置
yuqueServer.userIdstring是--
yuqueServer.tokenstring否--
yuqueServer.basePathstring否--
dingtalkServerobject否-已弃用。钉钉知识库配置
dingtalkServer.appKeystring是--
dingtalkServer.appSecretstring否--
dingtalkServer.userIdstring是--
dingtalkServer.operatorIdstring否--
dingtalkServer.workspaceIdstring否--
dingtalkServer.rootNodeIdstring否--
dingtalkServer.workspaceNamestring否--
statusstring (enum)是-状态。可选值:active , syncing , waiting , error
hasTrainingTaskboolean是-是否存在普通训练任务或待处理、处理中、失败的索引/同义词重建数据
errorMsgstring否-错误信息
vectorModelobject否-向量模型;模型已删除时为空,已停用模型仍返回展示数据
vectorModel.pricingobject否-每固定计价单位的积分单价;缺省免费
vectorModel.pricing.unitPricenumber否-综合单价;Token/TTS 每百万数量,STT 时长模式固定为每 60 秒。最小值:0
vectorModel.providerstring是-最小长度:1
vectorModel.modelstring是-最小长度:1
vectorModel.namestring是-最小长度:1
vectorModel.scopestring (enum)是"system"可选值:system , team
vectorModel.sortOrderinteger否-同一作用域内的模型展示 rank,数值越小越靠前。最小值:0;最大值:9007199254740991
vectorModel.tmbIdstring | null否--
vectorModel.teamIdstring | null否--
vectorModel.isActiveboolean否--
vectorModel.isUpcomingDeprecationboolean否-模型是否即将下架
vectorModel.requestUrlstring否--
vectorModel.requestAuthstring否--
vectorModel.testModeboolean否--
vectorModel.type"embedding"是-固定值:"embedding"
vectorModel.configobject是--
vectorModel.config.defaultTokennumber是--
vectorModel.config.maxTokennumber是--
vectorModel.config.weightnumber是0-
vectorModel.config.hiddenboolean否--
vectorModel.config.visionboolean否--
vectorModel.config.normalizationboolean否--
vectorModel.config.batchSizenumber否--
vectorModel.config.defaultConfigobject否--
vectorModel.config.dbConfigobject否--
vectorModel.config.queryConfigobject否--
vectorModel.modelIdstring是--
vectorModel.avatarstring否--
agentModelobject否-AI 模型;模型已删除时为空,已停用模型仍返回展示数据
agentModel.pricingobject否-LLM 每百万 Tokens 阶梯价格;缺省免费
agentModel.pricing.tiersobject[]否-LLM 阶梯价格,下限从上一档上限推导。最多项数:5
agentModel.pricing.tiers[].maxInputTokensnumber否-本档输入上限,单位 M Tokens;省略表示无限。最小值:0
agentModel.pricing.tiers[].inputPricenumber是-每百万输入 Tokens 的积分单价。最小值:0
agentModel.pricing.tiers[].outputPricenumber是-每百万输出 Tokens 的积分单价。最小值:0
agentModel.providerstring是-最小长度:1
agentModel.modelstring是-最小长度:1
agentModel.namestring是-最小长度:1
agentModel.scopestring (enum)是"system"可选值:system , team
agentModel.sortOrderinteger否-同一作用域内的模型展示 rank,数值越小越靠前。最小值:0;最大值:9007199254740991
agentModel.tmbIdstring | null否--
agentModel.teamIdstring | null否--
agentModel.isActiveboolean否--
agentModel.isUpcomingDeprecationboolean否-模型是否即将下架
agentModel.requestUrlstring否--
agentModel.requestAuthstring否--
agentModel.testModeboolean否--
agentModel.type"llm"是-固定值:"llm"
agentModel.configobject是--
agentModel.config.maxContextnumber是--
agentModel.config.maxResponsenumber是--
agentModel.config.quoteMaxTokennumber是--
agentModel.config.maxTemperaturenumber | null否--
agentModel.config.showTopPboolean否--
agentModel.config.responseFormatListstring[]否--
agentModel.config.showStopSignboolean否--
agentModel.config.censorboolean否--
agentModel.config.visionboolean否--
agentModel.config.audioboolean否--
agentModel.config.videoboolean否--
agentModel.config.reasoningboolean否--
agentModel.config.reasoningEffortboolean否--
agentModel.config.functionCallboolean否--
agentModel.config.toolChoiceboolean否--
agentModel.config.defaultSystemChatPromptstring否--
agentModel.config.defaultConfigobject否--
agentModel.config.fieldMapobject否--
agentModel.modelIdstring是--
agentModel.avatarstring否--
vlmModelobject否-视觉语言模型
vlmModel.pricingobject否-LLM 每百万 Tokens 阶梯价格;缺省免费
vlmModel.pricing.tiersobject[]否-LLM 阶梯价格,下限从上一档上限推导。最多项数:5
vlmModel.pricing.tiers[].maxInputTokensnumber否-本档输入上限,单位 M Tokens;省略表示无限。最小值:0
vlmModel.pricing.tiers[].inputPricenumber是-每百万输入 Tokens 的积分单价。最小值:0
vlmModel.pricing.tiers[].outputPricenumber是-每百万输出 Tokens 的积分单价。最小值:0
vlmModel.providerstring是-最小长度:1
vlmModel.modelstring是-最小长度:1
vlmModel.namestring是-最小长度:1
vlmModel.scopestring (enum)是"system"可选值:system , team
vlmModel.sortOrderinteger否-同一作用域内的模型展示 rank,数值越小越靠前。最小值:0;最大值:9007199254740991
vlmModel.tmbIdstring | null否--
vlmModel.teamIdstring | null否--
vlmModel.isActiveboolean否--
vlmModel.isUpcomingDeprecationboolean否-模型是否即将下架
vlmModel.requestUrlstring否--
vlmModel.requestAuthstring否--
vlmModel.testModeboolean否--
vlmModel.type"llm"是-固定值:"llm"
vlmModel.configobject是--
vlmModel.config.maxContextnumber是--
vlmModel.config.maxResponsenumber是--
vlmModel.config.quoteMaxTokennumber是--
vlmModel.config.maxTemperaturenumber | null否--
vlmModel.config.showTopPboolean否--
vlmModel.config.responseFormatListstring[]否--
vlmModel.config.showStopSignboolean否--
vlmModel.config.censorboolean否--
vlmModel.config.visionboolean否--
vlmModel.config.audioboolean否--
vlmModel.config.videoboolean否--
vlmModel.config.reasoningboolean否--
vlmModel.config.reasoningEffortboolean否--
vlmModel.config.functionCallboolean否--
vlmModel.config.toolChoiceboolean否--
vlmModel.config.defaultSystemChatPromptstring否--
vlmModel.config.defaultConfigobject否--
vlmModel.config.fieldMapobject否--
vlmModel.modelIdstring是--
vlmModel.avatarstring否--
permissionobject是-权限对象序列化后的 JSON 结构
permission.roleinteger是-权限角色值。最小值:-9007199254740991;最大值:9007199254740991
permission.isOwnerboolean是-是否为所有者
permission.hasManagePerboolean是-是否拥有管理权限
permission.hasWritePerboolean是-是否拥有写权限
permission.hasReadPerboolean是-是否拥有读权限
permission.hasManageRoleboolean是-是否包含管理角色
permission.hasWriteRoleboolean是-是否包含写角色
permission.hasReadRoleboolean是-是否包含读角色
在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

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