接口概述
该OpenAPI属于FastGPT知识库管理模块,用于查询单个已创建的知识库集合的详细元数据,可获取集合归属、训练配置、文本统计等核心信息,帮助开发者快速获取集合的完整配置详情。请求方式为GET,请求路径为/api/core/dataset/collection/detail,需携带合法的认证令牌完成身份校验。
调用步骤
- 准备认证令牌:从FastGPT平台获取有效的API访问令牌,用于构造
Authorization请求头,格式为Bearer {{authorization}},其中{{authorization}}需替换为实际的令牌内容。 - 配置请求参数:请求需携带必填参数
id,用于指定目标集合的唯一标识ID,示例值为65abcfab9d1448617cba5f0d。 - 发起请求,完整的curl调用示例如下:
curl --location --request GET 'http://localhost:3000/api/core/dataset/collection/detail?id=65abcfab9d1448617cba5f0d' \
--header 'Authorization: Bearer {{authorization}}'响应说明
当请求成功时,将返回状态码为200的响应,顶层字段包含code、statusText、message和data。其中data为集合的详细元数据对象,核心字段包括:
_id:集合的唯一标识ID,与请求参数id一致parentId:集合的父级ID,当前示例为nullteamId:集合所属团队的IDdatasetId:所属知识库的详细信息,包含知识库ID、名称、向量模型vectorModel、对话模型agentModel、权限设置permission等配置type:集合类型,示例值为virtualname:集合的显示名称trainingType:集合的训练类型,示例值为qachunkSize:文本分片大小,示例值为8000rawTextLength:集合内原始文本的总长度,示例值为40466createTime、updateTime:集合的创建和更新时间,采用ISO 8601格式canWrite:当前用户是否拥有该集合的写入权限,示例值为true
完整的响应示例可参考官方文档提供的标准返回格式,若请求参数缺失或无效,将返回对应错误码及提示信息。
来源:FastGPT 官方文档