背景与功能说明
FastGPT默认支持本地文件导入,但当用户已搭建自有文档库时,重复导入文件会造成二次存储资源浪费,且难以实现统一管理。API文件库功能通过标准化API接口拉取自有文档库内容,无需重复存储文件,仅需按规范提供对应接口,即可在FastGPT页面展示自有文档库的文件列表,并支持选择性导入到知识库中,大幅提升文档管理效率。
接口规范要求
所有接口需遵循统一响应格式:{success: boolean; message: string; data: any;}。文件列表单项的标准类型FileListItem需包含id、parentId(可为null)、name、type(可选file或folder)、updateTime、createTime,可选字段hasChild(默认folder类型为true)。需实现四个核心接口:
- 获取文件树:POST请求
{{baseURL}}/v1/file/list,支持可选参数parentId(父级ID,不传则使用配置的basePath作为根目录)和searchKey(检索词),返回符合格式的文件列表。 - 获取单个文件内容:GET请求
{{baseURL}}/v1/file/content?id=xx,返回的data需包含title(可选,用于显示文件名)、content(文件文本内容,优先级更高)或previewUrl(文件访问链接),二者必须至少返回其一,若同时返回则优先使用content。 - 获取文件阅读链接:GET请求
{{baseURL}}/v1/file/read?id=xx,返回包含url的data,用于打开文件原文。 - 获取文件详情:GET请求
{{baseURL}}/v1/file/detail?id=xx,返回文件的完整元数据,包括id、name、parentId、type、updateTime、createTime。
若未返回content和previewUrl任意一项,系统将抛出报错。
快速配置步骤
创建知识库时选择API文件库类型,需配置三个核心参数:
baseURL:文件服务接口的基础地址authorization:身份验证请求头,格式为Authorization: Bearer tokenbasePath(可选):根目录路径,用于指定文件树的起始位置
最小配置示例:仅需填入baseURL为https://your-custom-file-api.com,authorization为Bearer your-auth-token,即可完成基础配置,系统将自动拉取并展示自有文档库的文件列表,支持按需选择性导入文件到FastGPT知识库。
来源:https://doc.fastgpt.cn/zh-CN/guide/dataset/third-party/api_dataset