@@ -20,7 +20,8 @@ weight: 410
20
20
首先,要进入 FastGPT 项目路径下的` FastGPT\packages\global\core\dataset\apiDataset.d.ts ` 文件,添加自己的知识库 Server 类型。
21
21
22
22
{{% alert icon="🤖 " context="success" %}}
23
- 知识库类型的字段设计是依赖于自己的知识库需要什么字段进行后续的api调用
23
+ 知识库类型的字段设计是依赖于自己的知识库需要什么字段进行后续的api调用。
24
+ 如果知识库有` 根目录 ` 选择的功能,需要设置添加一个字段` basePath ` 。[ 点击查看` 根目录 ` 功能] ( /docs/guide/knowledge_base/third_dataset/#添加配置表单 )
24
25
{{% /alert %}}
25
26
26
27
![ ] ( /imgs/thirddataset-1.png )
@@ -111,7 +112,7 @@ export const useFeishuKnowledgeDatasetRequest = ({
111
112
![ ] ( /imgs/thirddataset-4.png )
112
113
113
114
{{% alert icon="🤖 " context="warning" %}}
114
- 其中` getCatalog.ts ` 和` getPathNames.ts ` 文件是对根路径设置的支持,如果你的知识库不支持根路径设置,可以设置返回空。如图:
115
+ 其中` getCatalog.ts ` 和` getPathNames.ts ` 文件是对根路径设置的支持,如果你的知识库不支持根路径设置,可以设置返回空。[ 点击查看 ` 根目录 ` 功能 ] ( /docs/guide/knowledge_base/third_dataset/#添加配置表单 ) 如图:
115
116
116
117
![ ] ( /imgs/thirddataset-6.png )
117
118
@@ -125,6 +126,19 @@ export const useFeishuKnowledgeDatasetRequest = ({
125
126
方法的具体添加,可以参考文件内的其他知识库。
126
127
{{% /alert %}}
127
128
129
+ 在` FastGPT\projects\app\src\pages\api\core\dataset\detail.ts ` 文件中,添加如下内容。
130
+
131
+ ![ ] ( /imgs/thirddataset-22.png )
132
+
133
+ 在` FastGPT\projects\app\src\pages\api\core\dataset\update.ts ` 文件中,添加如下内容。
134
+
135
+ {{% alert icon="🤖 " context="warning" %}}
136
+ 该文件主要是负责更新知识库配置的,如果不添加,会导致无法正常更新配置。
137
+ {{% /alert %}}
138
+
139
+ ![ ] ( /imgs/thirddataset-23.png )
140
+
141
+
128
142
129
143
## 数据库类型添加
130
144
@@ -159,3 +173,77 @@ export const datasetTypeCourseMap: Record<`${DatasetTypeEnum}`, string> = {
159
173
文档添加在` FastGPT\docSite\content\zh-cn\docs\guide\knowledge_base\ `
160
174
{{% /alert %}}
161
175
176
+ ## 添加前端
177
+
178
+ ` FastGPT\packages\web\i18n\zh-CN\dataset.json ` ,` FastGPT\packages\web\i18n\en\dataset.json ` 和` FastGPT\packages\web\i18n\zh-Hant\dataset.json ` 中添加自己的 I18n 翻译,以中文翻译为例,大体需要如下几个内容:
179
+
180
+ ![ ] ( /imgs/thirddataset-24.png )
181
+
182
+ ` FastGPT\packages\web\components\common\Icon\icons\core\dataset\ ` 添加自己的知识库图标,一共是两个,分为` Outline ` 和` Color ` ,分别是有颜色的和无色的,具体看如下图片。
183
+
184
+ ![ ] ( /imgs/thirddataset-10.png )
185
+
186
+
187
+ 在` FastGPT\packages\web\components\common\Icon\constants.ts ` 文件中,添加自己的图标。 ` import ` 是图标的存放路径。
188
+
189
+ ![ ] ( /imgs/thirddataset-9.png )
190
+
191
+ 在` FastGPT\packages\global\core\dataset\constants.ts ` 文件中,添加自己的知识库类型。
192
+
193
+ ![ ] ( /imgs/thirddataset-8.png )
194
+
195
+ {{% alert icon="🤖 " context="success" %}}
196
+ ` label ` 内容是自己之前通过 i18n 翻译添加的知识库名称的
197
+ ` icon ` 是自己之前添加的 Icon , I18n 的添加看最后清单。
198
+ {{% /alert %}}
199
+
200
+ 在` FastGPT\projects\app\src\pages\dataset\list\index.tsx ` 文件下,添加如下内容。这个文件负责的是知识库列表页的` 新建 ` 按钮点击后的菜单,只有在该文件添加知识库后,才能创建知识库。
201
+
202
+ ![ ] ( /imgs/thirddataset-12.png )
203
+
204
+ 在` FastGPT\projects\app\src\pageComponents\dataset\detail\Info\index.tsx ` 文件下,添加如下内容。
205
+
206
+ ![ ] ( /imgs/thirddataset-18.png )
207
+
208
+ 在` FastGPT\projects\app\src\pageComponents\dataset\list\CreateModal.tsx ` 文件下,添加如下内容。
209
+
210
+ | | |
211
+ | --- | --- |
212
+ | ![ ] ( /imgs/thirddataset-19.png ) | ![ ] ( /imgs/thirddataset-20.png ) |
213
+
214
+ 在` FastGPT\projects\app\src\pageComponents\dataset\list\SideTag.tsx ` 文件下,添加如下内容。
215
+
216
+ ![ ] ( /imgs/thirddataset-21.png )
217
+
218
+ 在` FastGPT\projects\app\src\web\core\dataset\context\datasetPageContext.tsx ` 文件下,添加如下内容。
219
+
220
+ ![ ] ( /imgs/thirddataset-23.png )
221
+
222
+ ## 添加配置表单
223
+
224
+ 在` FastGPT\projects\app\src\pageComponents\dataset\ApiDatasetForm.tsx ` 文件下,添加自己如下内容。这个文件负责的是创建知识库页的字段填写。
225
+
226
+ | | | |
227
+ | --- | --- | --- |
228
+ | ![ ] ( /imgs/thirddataset-13.png ) | ![ ] ( /imgs/thirddataset-14.png ) | ![ ] ( /imgs/thirddataset-15.png ) |
229
+
230
+ 代码中添加的两个组件是对根目录选择的渲染,对应设计的 api 的 getfiledetail 方法,如果你的文件不支持,你可以不引用。
231
+
232
+ ```
233
+ {renderBaseUrlSelector()} //这是对`Base URL`字段的渲染
234
+ {renderDirectoryModal()} //点击`选择`后出现的`选择根目录`窗口,见图
235
+ ```
236
+
237
+ | | |
238
+ | --- | --- |
239
+ | ![ ] ( /imgs/thirddataset-16.png ) | ![ ] ( /imgs/thirddataset-17.png ) |
240
+
241
+ 如果知识库需要支持根目录,还需要在` ApiDatasetForm ` 文件中添加相关内容。
242
+
243
+ ## 添加杂项
244
+
245
+ 最后,需要在很多文件里添加` server ` 类型,这里由于文件过多,且不大,不一一列举文件的清单。只提供方法:使用自己编程工具的全局搜索功能,搜索` YuqueServer ` 和` yuqueServer ` 。在搜索到的文件中,逐一添加自己的知识库类型。
246
+
247
+ ## 提示
248
+
249
+ 建议知识库创建完成后,完整测试一遍知识库的功能,以确定有无漏洞,如果你的知识库添加有问题,且无法在文档找到对应的文件解决,一定是杂项没有添加完全,建议重复一次全局搜索` YuqueServer ` 和` yuqueServer ` ,检查是否有地方没有加上自己的类型。
0 commit comments