feat: add getType endpoint to tool API for retrieving tool types and translations

Author: ctrlz526

modules/tool/api/getType.ts

@@ -0,0 +1,12 @@
+import { s } from '@/router/init';
+import { contract } from '@/contract';
+import { getToolType } from '@tool/controller';
+
+export const getTypeHandler = s.route(contract.tool.getType, async () => {
+  const type = getToolType();
+
+  return {
+    status: 200,
+    body: type
+  };
+});

modules/tool/contract.ts

@@ -1,7 +1,7 @@
 import z from 'zod';
 import { c } from '@/contract/init';
 import { ToolListItemSchema, type ToolListItemType } from './type/api';
-import { SystemVarSchema } from './type/tool';
+import { ToolTypeEnum } from './type/tool';
 
 export const toolContract = c.router(
   {
@@ -23,6 +23,23 @@ export const toolContract = c.router(
       responses: {
         200: ToolListItemSchema
       }
+    },
+    getType: {
+      path: '/getType',
+      method: 'GET',
+      description: 'Get tool type',
+      responses: {
+        200: z.array(
+          z.object({
+            type: z.nativeEnum(ToolTypeEnum),
+            name: z.object({
+              en: z.string(),
+              'zh-CN': z.string(),
+              'zh-Hant': z.string()
+            })
+          })
+        )
+      }
     }
   },
   {

modules/tool/controller.ts

@@ -1,6 +1,18 @@
 import type { ToolType } from './type';
 import { tools } from './constants';
+import type { ToolTypeEnum } from './type/tool';
+import { ToolTypeTranslations } from './type/tool';
 
 export function getTool(toolId: string): ToolType | undefined {
   return tools.find((tool) => tool.toolId === toolId);
 }
+
+export function getToolType(): Array<{
+  type: ToolTypeEnum;
+  name: { en: string; 'zh-CN': string; 'zh-Hant': string };
+}> {
+  return Object.entries(ToolTypeTranslations).map(([type, name]) => ({
+    type: type as ToolTypeEnum,
+    name
+  }));
+}

modules/tool/router.ts

@@ -1,9 +1,11 @@
 import { s } from '@/router/init';
 import { getToolHandler } from './api/getTool';
 import { getToolsHandler } from './api/list';
+import { getTypeHandler } from './api/getType';
 import { contract } from '@/contract';
 
 export const toolRouter = s.router(contract.tool, {
   getTool: getToolHandler,
-  list: getToolsHandler
+  list: getToolsHandler,
+  getType: getTypeHandler
 });

modules/tool/type/tool.ts

@@ -91,6 +91,78 @@ export enum ToolTypeEnum {
   other = 'other'
 }
 
+export type ToolClassifyType = {
+  [key in ToolTypeEnum]: {
+    en: string;
+    'zh-CN': string;
+    'zh-Hant': string;
+  };
+};
+
+/* Tool config is passed to FastGPT */
+export const ToolTypeTranslations = {
+  [ToolTypeEnum.tools]: {
+    en: 'tools',
+    'zh-CN': '工具',
+    'zh-Hant': '工具'
+  },
+  [ToolTypeEnum.search]: {
+    en: 'search',
+    'zh-CN': '搜索',
+    'zh-Hant': '搜尋'
+  },
+  [ToolTypeEnum.multimodal]: {
+    en: 'multimodal',
+    'zh-CN': '多模态',
+    'zh-Hant': '多模態'
+  },
+  [ToolTypeEnum.communication]: {
+    en: 'communication',
+    'zh-CN': '通信',
+    'zh-Hant': '通信'
+  },
+  [ToolTypeEnum.finance]: {
+    en: 'finance',
+    'zh-CN': '金融',
+    'zh-Hant': '金融'
+  },
+  [ToolTypeEnum.design]: {
+    en: 'design',
+    'zh-CN': '设计',
+    'zh-Hant': '設計'
+  },
+  [ToolTypeEnum.productivity]: {
+    en: 'productivity',
+    'zh-CN': '生产力',
+    'zh-Hant': '生產力'
+  },
+  [ToolTypeEnum.news]: {
+    en: 'news',
+    'zh-CN': '新闻',
+    'zh-Hant': '新聞'
+  },
+  [ToolTypeEnum.entertainment]: {
+    en: 'entertainment',
+    'zh-CN': '娱乐',
+    'zh-Hant': '娛樂'
+  },
+  [ToolTypeEnum.social]: {
+    en: 'social',
+    'zh-CN': '社交',
+    'zh-Hant': '社交'
+  },
+  [ToolTypeEnum.scientific]: {
+    en: 'scientific',
+    'zh-CN': '科学',
+    'zh-Hant': '科學'
+  },
+  [ToolTypeEnum.other]: {
+    en: 'other',
+    'zh-CN': '其他',
+    'zh-Hant': '其他'
+  }
+} as const;
+
 export const VersionListItemSchema = z.object({
   value: z.string(),
   description: z.string().optional(),

sdk/client.ts

@@ -1,11 +1,9 @@
 import createClient from '@/contract/client';
 import type { SystemVarType } from '@tool/type/tool';
 import type { StreamMessageType } from '@tool/type/tool';
-
 export default createClient;
 
 export type { SystemVarType, StreamMessageType as StreamMessage };
-
 export { RunToolWithStream } from './runToolStream';
 export { StreamDataAnswerTypeEnum } from '@tool/type/tool';
 export { ModelProviders, aiproxyIdMap } from '@model/constants';