feat: support lark document

--story=1017908 --user=王孝刚 【知识库】 - X-Pack支持对接飞书文档 https://www.tapd.cn/57709429/s/1673069

Author: wxg0103

ui/src/api/dataset.ts

@@ -4,18 +4,19 @@ import type { datasetData } from '@/api/type/dataset'
 import type { pageRequest } from '@/api/type/common'
 import type { ApplicationFormType } from '@/api/type/application'
 import { type Ref } from 'vue'
+
 const prefix = '/dataset'
 
 /**
  * 获取分页知识库
- * @param 参数  
+ * @param 参数
  * page {
-          "current_page": "string",
-          "page_size": "string",
-        }
+ "current_page": "string",
+ "page_size": "string",
+ }
  * param {
-          "name": "string",
-        }
+ "name": "string",
+ }
  */
 const getDataset: (
   page: pageRequest,
@@ -46,28 +47,28 @@ const delDataset: (dataset_id: String, loading?: Ref<boolean>) => Promise<Result
 
 /**
  * 创建知识库
- * @param 参数 
+ * @param 参数
  * {
-  "name": "string",
-  "desc": "string",
-  "documents": [
-    {
-      "name": "string",
-      "paragraphs": [
-        {
-          "content": "string",
-          "title": "string",
-          "problem_list": [
-            {
-              "id": "string",
-              "content": "string"
-            }
-          ]
-        }
-      ]
-    }
-  ]
-}
+ "name": "string",
+ "desc": "string",
+ "documents": [
+ {
+ "name": "string",
+ "paragraphs": [
+ {
+ "content": "string",
+ "title": "string",
+ "problem_list": [
+ {
+ "id": "string",
+ "content": "string"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
  */
 const postDataset: (data: datasetData, loading?: Ref<boolean>) => Promise<Result<any>> = (
   data,
@@ -78,29 +79,46 @@ const postDataset: (data: datasetData, loading?: Ref<boolean>) => Promise<Result
 
 /**
  * 创建Web知识库
- * @param 参数 
+ * @param 参数
  * {
-  "name": "string",
-  "desc": "string",
-  "source_url": "string",
-  "selector": "string",
-}
+ "name": "string",
+ "desc": "string",
+ "source_url": "string",
+ "selector": "string",
+ }
  */
 const postWebDataset: (data: any, loading?: Ref<boolean>) => Promise<Result<any>> = (
   data,
   loading
 ) => {
   return post(`${prefix}/web`, data, undefined, loading)
 }
+/**
+ * 创建Lark知识库
+ * @param 参数
+ * {
+ "name": "string",
+ "desc": "string",
+ "app_id": "string",
+ "app_secret": "string",
+ "folder_token": "string",
+ }
+ */
+const postLarkDataset: (data: any, loading?: Ref<boolean>) => Promise<Result<any>> = (
+  data,
+  loading
+) => {
+  return post(`${prefix}/lark/save`, data, undefined, loading)
+}
 
 /**
  * 创建QA知识库
-  * @param 参数 formData
+ * @param 参数 formData
  * {
-  "file": "file",
-  "name": "string",
-  "desc": "string",
-  }
+ "file": "file",
+ "name": "string",
+ "desc": "string",
+ }
  */
 const postQADataset: (data: any, loading?: Ref<boolean>) => Promise<Result<any>> = (
   data,
@@ -122,12 +140,12 @@ const getDatasetDetail: (dataset_id: string, loading?: Ref<boolean>) => Promise<
 
 /**
  * 修改知识库信息
- * @param 参数 
+ * @param 参数
  * dataset_id
  * {
-      "name": "string",
-      "desc": true
-    }
+ "name": "string",
+ "desc": true
+ }
  */
 const putDataset: (
   dataset_id: string,
@@ -136,6 +154,13 @@ const putDataset: (
 ) => Promise<Result<any>> = (dataset_id, data, loading) => {
   return put(`${prefix}/${dataset_id}`, data, undefined, loading)
 }
+const putLarkDataset: (
+  dataset_id: string,
+  data: any,
+  loading?: Ref<boolean>
+) => Promise<Result<any>> = (dataset_id, data, loading) => {
+  return put(`${prefix}/lark/${dataset_id}`, data, undefined, loading)
+}
 /**
  * 获取知识库 可关联的应用列表
  * @param dataset_id
@@ -229,6 +254,29 @@ const getDatasetModel: (
 ) => Promise<Result<Array<any>>> = (dataset_id, loading) => {
   return get(`${prefix}/${dataset_id}/model`, loading)
 }
+/**
+ * 获取飞书文档列表
+ * @param dataset_id
+ * @param folder_token
+ * @param loading
+ * @returns
+ */
+const getLarkDocumentList: (
+  dataset_id: string,
+  folder_token: string,
+  data: any,
+  loading?: Ref<boolean>
+) => Promise<Result<Array<any>>> = (dataset_id, folder_token, data, loading) => {
+  return post(`${prefix}/lark/${dataset_id}/${folder_token}/doc_list`, data, null, loading)
+}
+
+const importLarkDocument: (
+  dataset_id: string,
+  data: any,
+  loading?: Ref<boolean>
+) => Promise<Result<Array<any>>> = (dataset_id, data, loading) => {
+  return post(`${prefix}/lark/${dataset_id}/import`, data, null, loading)
+}
 
 export default {
   getDataset,
@@ -245,5 +293,9 @@ export default {
   postQADataset,
   exportDataset,
   getDatasetModel,
-  exportZipDataset
+  exportZipDataset,
+  postLarkDataset,
+  getLarkDocumentList,
+  importLarkDocument,
+  putLarkDataset
 }

ui/src/api/document.ts

@@ -181,6 +181,18 @@ const putDocumentSync: (
 ) => Promise<Result<any>> = (dataset_id, document_id, loading) => {
   return put(`${prefix}/${dataset_id}/document/${document_id}/sync`, undefined, undefined, loading)
 }
+const putLarkDocumentSync: (
+  dataset_id: string,
+  document_id: string,
+  loading?: Ref<boolean>
+) => Promise<Result<any>> = (dataset_id, document_id, loading) => {
+  return put(
+    `${prefix}/lark/${dataset_id}/document/${document_id}/sync`,
+    undefined,
+    undefined,
+    loading
+  )
+}
 
 /**
  * 批量同步文档
@@ -193,6 +205,13 @@ const delMulSyncDocument: (
 ) => Promise<Result<boolean>> = (dataset_id, data, loading) => {
   return put(`${prefix}/${dataset_id}/document/_bach`, { id_list: data }, undefined, loading)
 }
+const delMulLarkSyncDocument: (
+  dataset_id: string,
+  data: any,
+  loading?: Ref<boolean>
+) => Promise<Result<boolean>> = (dataset_id, data, loading) => {
+  return put(`${prefix}/lark/${dataset_id}/_batch`, { id_list: data }, undefined, loading)
+}
 
 /**
  * 创建Web站点文档
@@ -394,5 +413,7 @@ export default {
   batchGenerateRelated,
   cancelTask,
   exportDocumentZip,
-  batchCancelTask
+  batchCancelTask,
+  putLarkDocumentSync,
+  delMulLarkSyncDocument
 }

ui/src/locales/lang/en-US/views/application.ts

@@ -210,7 +210,8 @@ export default {
       appSecretPlaceholder: 'Please enter APP secret',
       verificationTokenPlaceholder: 'Please enter verification token',
       urlInfo:
-        '-Events and callbacks - event configuration - configure the "request address" of the subscription method'
+        '-Events and callbacks - event configuration - configure the "request address" of the subscription method',
+      folderTokenPlaceholder: 'Please enter folder token'
     },
     slackSetting: {
       title: 'Slack Configuration',

ui/src/locales/lang/en-US/views/dataset.ts

@@ -49,13 +49,21 @@ export default {
       datasetType: {
         label: 'Type',
         generalInfo: 'Upload local documents',
-        webInfo: 'Sync text data from a web site'
+        webInfo: 'Sync text data from a web site',
+        larkInfo: 'Sync documents from Feishu',
+        yuqueInfo: 'Sync documents from Yuque'
       },
       source_url: {
         label: 'Web Root URL',
         placeholder: 'Please enter the web root URL',
         requiredMessage: 'Please enter the web root URL'
       },
+      user_id: {
+        requiredMessage: 'Please enter User ID'
+      },
+      token: {
+        requiredMessage: 'Please enter Token'
+      },
       selector: {
         label: 'Selector',
         placeholder: 'Default is body, can input .classname/#idname/tagname'
@@ -79,8 +87,7 @@ export default {
     replace: 'Replace Sync',
     replaceText: 'Re-fetch Web site documents, replacing the documents in the local knowledge',
     complete: 'Full Sync',
-    completeText:
-      'Delete all documents in the local knowledge and re-fetch web site documents',
+    completeText: 'Delete all documents in the local knowledge and re-fetch web site documents',
     tip: 'Note: All syncs will delete existing data and re-fetch new data. Please proceed with caution.'
   }
 }

ui/src/locales/lang/zh-CN/views/application.ts

@@ -197,7 +197,8 @@ export default {
       appIdPlaceholder: '请输入App ID',
       appSecretPlaceholder: '请输入App Secret',
       verificationTokenPlaceholder: '请输入Verification Token',
-      urlInfo: '-事件与回调-事件配置-配置订阅方式的 "请求地址" 中'
+      urlInfo: '-事件与回调-事件配置-配置订阅方式的 "请求地址" 中',
+      folderTokenPlaceholder: '请输入Folder Token'
     },
     slackSetting: {
       title: 'Slack 应用配置',

ui/src/locales/lang/zh-CN/views/dataset.ts

@@ -3,6 +3,8 @@ export default {
   createDataset: '创建知识库',
   general: '通用型',
   web: 'web 站点',
+  lark: '飞书',
+  yuque: '语雀',
   relatedApplications: '关联应用',
   document_count: '文档数',
   relatedApp_count: '关联应用',
@@ -47,14 +49,22 @@ export default {
       },
       datasetType: {
         label: '知识库类型',
-        generalInfo: '上传本地文档',
-        webInfo: '同步Web网站文本数据'
+        generalInfo: '通过上传文件或手动录入构建知识库',
+        webInfo: '通过网站链接构建知识库',
+        larkInfo: '通过飞书文档构建知识库',
+        yuqueInfo: '通过语雀文档构建知识库'
       },
       source_url: {
         label: 'Web 根地址',
         placeholder: '请输入 Web 根地址',
         requiredMessage: ' 请输入 Web 根地址'
       },
+      user_id: {
+        requiredMessage: '请输入User ID'
+      },
+      token: {
+        requiredMessage: '请输入Token'
+      },
       selector: {
         label: '选择器',
         placeholder: '默认为 body，可输入 .classname/#idname/tagname'

ui/src/locales/lang/zh-CN/views/document.ts

@@ -55,7 +55,8 @@ export default {
       tip1: '1、点击下载对应模版并完善信息',
       tip2: '2、上传的表格文件中每个 sheet 会作为一个文档，sheet名称为文档名称',
       tip3: '3、每次最多上传 50 个文件，每个文件不超过 100MB'
-    }
+    },
+    lark: {}
   },
   setRules: {
     title: {

ui/src/locales/lang/zh-Hant/views/application.ts

@@ -59,8 +59,8 @@ export default {
         references: ' (引用知識庫)',
         placeholder: '請輸入提示詞',
         requiredMessage: '請輸入提示詞',
-        tooltip:'透過調整提示詞內容，可以引導大模型對話方向，該提示詞會被固定在上下文的開頭。',
-        
+        tooltip: '透過調整提示詞內容，可以引導大模型對話方向，該提示詞會被固定在上下文的開頭。',
+
         noReferencesTooltip:
           '透過調整提示詞內容，可以引導大模型對話方向，該提示詞會被固定在上下文的開頭。可以使用變數：{question} 是用戶提出問題的佔位符。',
         referencesTooltip:
@@ -104,9 +104,9 @@ export default {
       },
       reasoningContent: {
         label: '輸出思考',
-        tooltip:'請根據模型返回的思考標簽設置，標簽中間的內容將會認定爲思考過程',
+        tooltip: '請根據模型返回的思考標簽設置，標簽中間的內容將會認定爲思考過程',
         start: '開始',
-        end: '結束',
+        end: '結束'
       }
     },
     buttons: {
@@ -196,12 +196,13 @@ export default {
       appIdPlaceholder: '請輸入App ID',
       appSecretPlaceholder: '請輸入App Secret',
       verificationTokenPlaceholder: '請輸入Verification Token',
-      urlInfo: '-事件與回呼-事件配置-配置訂閱方式的 "請求位址" 中'
+      urlInfo: '-事件與回呼-事件配置-配置訂閱方式的 "請求位址" 中',
+      folderTokenPlaceholder: '請輸入Folder Token'
     },
     slackSetting: {
       title: 'Slack 應用配置',
       signingSecretPlaceholder: '請輸入 Signing Secret',
-      botUserTokenPlaceholder: '請輸入 Bot User Token',
+      botUserTokenPlaceholder: '請輸入 Bot User Token'
     },
     copyUrl: '複製連結填入到'
   },