v4.6 -1 (#459)

packages/global/core/chat/api.d.ts

@@ -0,0 +1,34 @@
+import { ModuleItemType } from '../module/type';
+import { AdminFbkType, ChatItemType, moduleDispatchResType } from './type';
+
+export type UpdateHistoryProps = {
+  chatId: string;
+  customTitle?: string;
+  top?: boolean;
+};
+
+export type AdminUpdateFeedbackParams = AdminFbkType & {
+  chatItemId: string;
+};
+
+export type InitChatResponse = {
+  chatId: string;
+  appId: string;
+  app: {
+    userGuideModule?: ModuleItemType;
+    chatModels?: string[];
+    name: string;
+    avatar: string;
+    intro: string;
+    canUse?: boolean;
+  };
+  title: string;
+  variables: Record<string, any>;
+  history: ChatItemType[];
+};
+
+export type ChatHistoryItemResType = moduleDispatchResType & {
+  moduleType: `${FlowNodeTypeEnum}`;
+  moduleName: string;
+  moduleLogo?: string;
+};

packages/global/core/chat/constants.ts

@@ -0,0 +1,56 @@
+export enum ChatRoleEnum {
+  System = 'System',
+  Human = 'Human',
+  AI = 'AI',
+  Function = 'Function',
+  Tool = 'Tool'
+}
+
+export enum TaskResponseKeyEnum {
+  'answerText' = 'answerText', //  answer module text key
+  'responseData' = 'responseData',
+  'history' = 'history'
+}
+
+export const ChatRoleMap = {
+  [ChatRoleEnum.System]: {
+    name: '系统提示词'
+  },
+  [ChatRoleEnum.Human]: {
+    name: '用户'
+  },
+  [ChatRoleEnum.AI]: {
+    name: 'AI'
+  },
+  [ChatRoleEnum.Function]: {
+    name: 'Function'
+  },
+  [ChatRoleEnum.Tool]: {
+    name: 'Tool'
+  }
+};
+
+export enum ChatSourceEnum {
+  test = 'test',
+  online = 'online',
+  share = 'share',
+  api = 'api'
+}
+
+export const ChatSourceMap = {
+  [ChatSourceEnum.test]: {
+    name: 'chat.logs.test'
+  },
+  [ChatSourceEnum.online]: {
+    name: 'chat.logs.online'
+  },
+  [ChatSourceEnum.share]: {
+    name: 'chat.logs.share'
+  },
+  [ChatSourceEnum.api]: {
+    name: 'chat.logs.api'
+  }
+};
+
+export const HUMAN_ICON = `/icon/human.svg`;
+export const LOGO_ICON = `/icon/logo.svg`;

packages/global/core/chat/type.d.ts

@@ -0,0 +1,111 @@
+import { ClassifyQuestionAgentItemType } from '../module/type';
+import { SearchDataResponseItemType } from '../dataset/type';
+import { ChatRoleEnum, ChatSourceEnum, TaskResponseKeyEnum } from './constants';
+import { FlowNodeTypeEnum } from '../module/node/constant';
+import { AppSchema } from 'core/app/type';
+
+export type ChatSchema = {
+  _id: string;
+  chatId: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  appId: string;
+  updateTime: Date;
+  title: string;
+  customTitle: string;
+  top: boolean;
+  variables: Record<string, any>;
+  source: `${ChatSourceEnum}`;
+  shareId?: string;
+  isInit: boolean;
+  content: ChatItemType[];
+};
+
+export type ChatWithAppSchema = Omit<ChatSchema, 'appId'> & {
+  appId: AppSchema;
+};
+
+export type ChatItemSchema = {
+  dataId: string;
+  chatId: string;
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  appId: string;
+  time: Date;
+  obj: `${ChatRoleEnum}`;
+  value: string;
+  userFeedback?: string;
+  adminFeedback?: AdminFbkType;
+  [TaskResponseKeyEnum.responseData]?: ChatHistoryItemResType[];
+  tts?: Buffer;
+};
+
+export type AdminFbkType = {
+  dataId: string;
+  datasetId: string;
+  collectionId: string;
+  q: string;
+  a?: string;
+};
+
+export type ChatItemType = {
+  dataId?: string;
+  obj: ChatItemSchema['obj'];
+  value: any;
+  userFeedback?: string;
+  adminFeedback?: ChatItemSchema['feedback'];
+  [TaskResponseKeyEnum.responseData]?: ChatItemSchema[TaskResponseKeyEnum.responseData];
+};
+
+export type ChatSiteItemType = {
+  status: 'loading' | 'running' | 'finish';
+  moduleName?: string;
+  ttsBuffer?: Buffer;
+} & ChatItemType;
+
+export type HistoryItemType = {
+  chatId: string;
+  updateTime: Date;
+  customTitle?: string;
+  title: string;
+};
+export type ChatHistoryItemType = HistoryItemType & {
+  appId: string;
+  top: boolean;
+};
+
+// response data
+export type moduleDispatchResType = {
+  price: number;
+  runningTime?: number;
+  tokens?: number;
+  model?: string;
+
+  // chat
+  question?: string;
+  temperature?: number;
+  maxToken?: number;
+  quoteList?: SearchDataResponseItemType[];
+  historyPreview?: ChatItemType[]; // completion context array. history will slice
+
+  // dataset search
+  similarity?: number;
+  limit?: number;
+
+  // cq
+  cqList?: ClassifyQuestionAgentItemType[];
+  cqResult?: string;
+
+  // content extract
+  extractDescription?: string;
+  extractResult?: Record<string, any>;
+
+  // http
+  body?: Record<string, any>;
+  httpResult?: Record<string, any>;
+
+  // plugin output
+  pluginOutput?: Record<string, any>;
+};