集成官方文档3 分钟阅读集成与发布渠道

FastGPT第三方知识库接入的开发配置与实现步骤

FastGPT内置了部分官方知识库,若需接入其他第三方文档库,需遵循统一接口规范进行开发。所有内置知识库均基于标准API文件库扩展,开发者可参考FastGPT/packages/service/core/dataset/apiDataset/yuqueDataset/api.ts中的代码完成自定义开发,需实…

概述

FastGPT内置了部分官方知识库,若需接入其他第三方文档库,需遵循统一接口规范进行开发。所有内置知识库均基于标准API文件库扩展,开发者可参考FastGPT/packages/service/core/dataset/apiDataset/yuqueDataset/api.ts中的代码完成自定义开发,需实现对应接口逻辑。

开发核心规范

第三方知识库开发需遵循统一接口标准,共需实现5个核心函数,涵盖文件列表获取、内容读取、详情查询、预览地址生成与真实ID提取。同时需配置知识库的鉴权参数、多语言翻译、UI图标与页面配置项,确保接入后可正常使用。

具体配置步骤

  1. 添加知识库类型定义:进入FastGPT\packages\global\core\dataset\apiDataset.d.ts,定义第三方知识库的Server类型,需包含鉴权与基础配置字段,例如若需支持根目录选择,需添加可选字段basePath,示例配置需包含userIdtokenbasePath
  2. 创建Hook接口文件:在FastGPT\packages\service\core\dataset\apiDataset\下新建专属文件夹与api.ts文件,实现5个必填函数:listFiles(获取文件列表)、getFileContent(获取文件内容/链接)、getFileDetail(获取文件详情信息)、getFilePreviewUrl(获取原文预览地址)、getFileId(获取原文件真实ID)。
  3. 完成全链路配置:依次在type.d.ts导入自定义知识库类型,在utils.ts添加数据获取逻辑,在index.ts注册调用方法;在多语言文件中添加对应翻译,在图标目录添加Outline与Color两种格式的图标,在constants.tsDatasetTypeEnumApiDatasetTypeMap中注册知识库类型;最后在知识库列表页与创建表单页添加对应的配置项。若支持根目录选择,需在ApiDatasetForm.tsx中引入renderBaseUrlSelector()renderDirectoryModal()组件。

来源:https://doc.fastgpt.cn/zh-CN/guide/dataset/third-party/third_dataset