@metad/contracts 3.6.0 → 3.6.1

package/src/ai/chat-message.model.ts

@@ -0,0 +1,277 @@
+import { MessageContent, MessageContentImageUrl, MessageType } from '@langchain/core/messages';
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IChatConversation } from './chat.model'
+import { LongTermMemoryTypeEnum } from './xpert.model'
+import { XpertAgentExecutionStatusEnum } from './xpert-agent-execution.model';
+import { JSONValue } from '../core.model';
+import { IStorageFile } from '../storage-file.model';
+
+export type TSummaryJob = Record<LongTermMemoryTypeEnum, {
+    jobId: number | string;
+    status: string
+    progress?: number
+    memoryKey?: string
+  }>
+
+/**
+ * Message step type: determines the type of canvas
+ */
+// export enum ChatMessageStepType {
+//   ComputerUse = 'computer_use',
+//   File = 'file',
+//   Notice = 'notice'
+// }
+
+/**
+ * Category of step message: determines the display components of computer use
+ */
+export enum ChatMessageStepCategory {
+  /**
+   * List of items: urls, files, etc.
+   */
+  List = 'list',
+  /**
+   * Websearch results
+   */
+  WebSearch = 'web_search',
+  /**
+   * Files list
+   */
+  Files = 'files',
+  /**
+   * View a file
+   */
+  File = 'file',
+  /**
+   * Program Execution
+   */
+  Program = 'program',
+  /**
+   * Iframe
+   */
+  Iframe = 'iframe',
+
+  Memory = 'memory',
+
+  Tasks = 'tasks',
+
+  /**
+   * Knowledges (knowledge base retriever results)
+   */
+  Knowledges = 'knowledges'
+}
+
+/**
+ * Step message type, in canvas and ai message.
+ */
+export type TChatMessageStep<T = any> = TMessageComponent<TMessageComponentStep<T>>
+// {
+//   id?: string
+//   type?: ChatMessageStepType
+//   category?: ChatMessageStepCategory
+//   toolset?: string
+//   tool?: string
+//   title?: string
+//   message?: string
+//   created_date?: Date | string
+//   data?: T
+//   artifact?: any
+// }
+
+/**
+ * Chat message entity type
+ */
+export interface IChatMessage extends IBasePerTenantAndOrganizationEntityModel, Omit<Omit<CopilotBaseMessage, 'createdAt'>, 'id'> {
+  /**
+   * Files
+   */
+  attachments?: IStorageFile[]
+  /**
+   * Job of summary
+   */
+  summaryJob?: TSummaryJob
+
+  /**
+   * the third-party platform's message
+   */
+  thirdPartyMessage?: any
+
+  /**
+   * Step messages from tools or others
+   */
+  events?: TChatMessageStep[]
+
+  // Many to one
+  /**
+   * Chat conversation
+   */
+  conversation?: IChatConversation
+  conversationId?: string | null
+
+  executionId?: string
+}
+
+
+/**
+ * @deprecated
+ */
+export type DeprecatedMessageType = 'assistant' | 'user' | 'info' | 'component'
+export type CopilotMessageType = MessageType | DeprecatedMessageType
+
+export type ChatMessageStatusEnum = XpertAgentExecutionStatusEnum | 'thinking' | 'reasoning' | 'answering' | 'aborted'
+
+/**
+ * BaseMessage or AIMessage in Langchain.js
+ */
+export interface CopilotBaseMessage {
+  id: string
+  createdAt?: Date
+  role: CopilotMessageType
+  
+  /**
+   * Status of the message:
+   */
+  status?: ChatMessageStatusEnum
+
+  content?: string | TMessageContent
+
+  /**
+   * Reasoning step messages
+   */
+  reasoning?: TMessageContentReasoning[]
+
+  /**
+   * Error info when status is error
+   */
+  error?: string
+}
+
+export type CopilotChatMessage = CopilotBaseMessage & {
+
+  tool_call_id?: string
+  
+  /**
+   * If the message has a role of `function`, the `name` field is the name of the function.
+   * Otherwise, the name field should not be set.
+   */
+  name?: string
+
+  data?: JSONValue
+
+  messages?: Array<any> // StoredMessage
+
+  executionId?: string
+}
+
+/**
+ * @deprecated use data attr in message (subMessages)
+ */
+export interface CopilotMessageGroup extends CopilotBaseMessage {
+  messages?: CopilotChatMessage[]
+}
+
+/**
+ * Similar to {@link MessageContentText} | {@link MessageContentImageUrl}, which together form {@link MessageContentComplex}
+ */
+export type TMessageContentComponent<T extends object = object> = {
+  id: string
+  type: 'component'
+  data: TMessageComponent<T>
+  xpertName?: string
+  agentKey?: string;
+}
+
+/**
+ * Defines the data type of the sub-message of `component` type in the message `content` {@link MessageContentComplex}
+ */
+export type TMessageComponent<T extends object = object> = T & {
+  id?: string
+  category: 'Dashboard' | 'Computer' | 'Tool'
+  type?: string
+  created_date?: Date | string
+}
+
+export type TMessageContentText = {
+  id?: string
+  xpertName?: string
+  agentKey?: string
+  type: "text";
+  text: string;
+};
+export type TMessageContentMemory = {
+  id?: string
+  agentKey?: string
+  type: "memory";
+  data: any[];
+};
+export type TMessageContentReasoning = {
+  id?: string
+  xpertName?: string
+  agentKey?: string
+  type: "reasoning";
+  text: string;
+};
+/**
+ * Enhance {@link MessageContentComplex} in Langchain.js
+ */
+export type TMessageContentComplex = (TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentMemory | (Record<string, any> & {
+  type?: "text" | "image_url" | string;
+}) | (Record<string, any> & {
+  type?: never;
+})) & {
+  id?: string
+  xpertName?: string
+  agentKey?: string;
+  created_date?: Date | string
+}
+/**
+ * Enhance {@link MessageContent} in Langchain.js
+ */
+export type TMessageContent = string | TMessageContentComplex[];
+
+export type TMessageComponentIframe = {
+  type: 'iframe'
+  title: string
+  url?: string
+  data?: {
+    url?: string
+  }
+}
+
+export type TMessageComponentStep<T = JSONValue> = {
+  type: ChatMessageStepCategory
+  toolset: string
+  toolset_id: string
+  tool?: string
+  title: string
+  message: string
+  status: 'success' | 'fail' | 'running'
+  created_date: Date | string
+  end_date: Date | string
+  error?: string
+  data?: T
+  input?: any
+  output?: string
+  artifact?: any
+}
+
+/**
+ * Data type for chat event message
+ */
+export type TChatEventMessage = {
+  type?: string
+  title?: string
+  message?: string
+  status?: 'success' | 'fail' | 'running'
+  created_date?: Date | string
+  end_date?: Date | string
+  error?: string
+}
+
+// Type guards
+/**
+ * @deprecated use content in message
+ */
+export function isMessageGroup(message: CopilotBaseMessage): message is CopilotMessageGroup {
+  return 'messages' in message;
+}

package/src/ai/chat.model.ts

@@ -0,0 +1,207 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IXpertAgentExecution } from './xpert-agent-execution.model'
+import { IXpert } from './xpert.model'
+import { I18nObject } from '../types'
+import { CopilotChatMessage, CopilotMessageGroup, IChatMessage } from './chat-message.model'
+import { IXpertAgent } from './xpert-agent.model'
+import { IXpertProject } from './xpert-project.model'
+import { IStorageFile } from '../storage-file.model'
+import { IXpertTask } from './xpert-task.model'
+import { TInterruptMessage, TToolCall } from '../agent'
+
+
+export type TChatConversationOptions = {
+  parameters?: {
+    input?: string
+    [key: string]: unknown
+  }
+  knowledgebases?: string[]
+  toolsets?: string[]
+  features?: Array<'timeline' | 'sandbox' | 'files'>
+  workspacePath?: string
+  workspaceUrl?: string
+}
+
+export type TChatConversationStatus = "idle" | "busy" | "interrupted" | "error"
+export type TToolCallType = 'agent' | 'tool'
+export type TChatFrom = 'platform' | 'webapp' | 'debugger' | 'knowledge' | 'job' | 'api' | 'feishu' | 'lark' | 'dingtalk' | 'wecom'
+
+/**
+ * Operation for interrupt
+ */
+export type TSensitiveOperation = {
+  messageId?: string
+  tasks?: {
+    name: string;
+    interrupts: {
+      value?: TInterruptMessage;
+      when?: "during";
+      resumable?: boolean;
+      ns?: string[];
+    }[];
+    type?: TToolCallType;
+    info?: {
+      name: string
+      title?: string
+      description: string
+    }
+    parameters?: {
+      name: string;
+      title: I18nObject | string
+      type: string;
+      description: I18nObject | string
+      placeholder?: I18nObject | string
+    }[],
+    call?: TToolCall
+    agent?: IXpertAgent
+  }[]
+}
+
+/**
+ * Chat conversation for xpert ai agent.
+ * 
+ * Corresponds to the thread in the [Agent Protocol](https://github.com/langchain-ai/agent-protocol).
+ */
+export interface IChatConversation extends IBasePerTenantAndOrganizationEntityModel {
+  /**
+   * Thread id for agent execution
+   */
+  threadId: string
+  /**
+   * A short title summarizing the session
+   */
+  title?: string
+  /**
+   * Current status of conversation
+   */
+  status?: TChatConversationStatus
+  /**
+   * Options
+   */
+  options?: TChatConversationOptions
+  /**
+   * Error message when status is error
+   */
+  error?: string
+  /**
+   * ChatMessages in conversation
+   */
+  messages?: IChatMessage[] | null
+  /**
+   * The last operation when interrupted
+   */
+  operation?: TSensitiveOperation
+  /**
+   * Conversation source / user type
+   */
+  from: TChatFrom
+  /**
+   * End anonymous user
+   */
+  fromEndUserId?: string
+
+  // Many to one
+  /**
+   * Chat with Xpert
+   */
+  xpert?: IXpert
+  xpertId?: string | null
+
+  project?: IXpertProject
+  projectId?: string | null
+
+  task?: IXpertTask
+  taskId?: string | null
+
+  // One to Many
+  executions?: IXpertAgentExecution[]
+  /**
+   * Files
+   */
+  attachments?: IStorageFile[]
+}
+
+export type TChatConversationLog = IChatConversation & {
+  messageCount: number
+}
+
+// Types
+export type ChatMessage = {
+  conversationId: string;
+  id: string;
+  content: string
+}
+
+export type ChatUserMessage = ChatMessage & {
+  language: string
+}
+
+/**
+ * @deprecated use ChatMessageEventTypeEnum
+ */
+export enum ChatGatewayEvent {
+  ACK = 'ack', // acknowledgment for received message
+  ConversationCreated = 'conversation_created',
+  Message = 'message',
+  MessageStream = 'message_stream',
+  StepStart = 'step_start',
+  StepEnd = 'step_end',
+  ToolStart = 'tool_start',
+  ToolEnd = 'tool_end',
+  ChainStart = 'chain_start',
+  ChainEnd = 'chain_end',
+  CancelChain = 'cancel_chain',
+  ChainAborted = 'chain_aborted',
+  Error = 'error',
+  Agent = 'agent'
+}
+
+
+/**
+ * @deprecated use ChatMessageEventTypeEnum
+ */
+export type ChatGatewayMessage = {
+  organizationId?: string;
+  xpert?: {
+    id: string
+		knowledgebases?: string[]
+    toolsets: string[] | null
+  }
+} & ({
+  event: ChatGatewayEvent.CancelChain
+  data: {
+    conversationId: string // Conversation ID
+  }
+} | {
+  event: ChatGatewayEvent.ChainAborted
+  data: {
+    conversationId: string // Conversation ID
+    id?: string // Message id
+  }
+} | {
+  event: ChatGatewayEvent.ConversationCreated
+  data: IChatConversation
+} | {
+  event: ChatGatewayEvent.MessageStream
+  data: ChatUserMessage
+} | {
+  event: ChatGatewayEvent.ToolStart | ChatGatewayEvent.ToolEnd
+  data: CopilotMessageGroup | CopilotMessageGroup[]
+} | {
+  event: ChatGatewayEvent.ChainStart | ChatGatewayEvent.ChainEnd
+  data: {
+    id: string
+  }
+} | {
+  event: ChatGatewayEvent.StepStart | ChatGatewayEvent.StepEnd
+  data: CopilotChatMessage
+} | {
+  event: ChatGatewayEvent.Message | ChatGatewayEvent.Error
+  data: CopilotChatMessage
+} | {
+  event: ChatGatewayEvent.Agent
+  data: {
+    id: string
+    message: CopilotChatMessage
+  }
+})

package/src/ai/copilot-checkpoint.model.ts

@@ -0,0 +1,25 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+
+/**
+ * Checkpoints for copilot, for langgraph framework
+ */
+export interface ICopilotCheckpoint extends IBasePerTenantAndOrganizationEntityModel {
+  thread_id: string
+  checkpoint_ns: string
+  checkpoint_id: string
+  parent_id?: string
+  type?: string
+  checkpoint: Uint8Array
+  metadata: Uint8Array
+}
+
+export interface ICopilotCheckpointWrites extends IBasePerTenantAndOrganizationEntityModel {
+  thread_id: string
+  checkpoint_ns: string
+  checkpoint_id: string
+  task_id?: string
+  idx?: number
+  channel?: string
+  type?: string
+  value: Uint8Array
+}

package/src/ai/copilot-example.model.ts

@@ -0,0 +1,23 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { AiProvider } from './ai.model'
+import { IXpert } from './xpert.model'
+
+/**
+ * Examples for copilot, which is used to few shot user question
+ */
+export interface ICopilotKnowledge extends IBasePerTenantAndOrganizationEntityModel {
+  provider?: AiProvider | string
+  /**
+   * The name of xpert (copilot type)
+   */
+  role?: string
+  command?: string
+  input?: string
+  output?: string
+
+  // Has vector
+  vector?: boolean
+
+  xpert?: IXpert
+  xpertId?: string
+}

package/src/ai/copilot-model.model.ts

@@ -0,0 +1,31 @@
+import { AiModelTypeEnum } from '../agent'
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { ICopilot } from './copilot.model'
+
+export interface ICopilotModel extends TCopilotModel, IBasePerTenantAndOrganizationEntityModel {}
+
+export type TCopilotModel = {
+  /**
+   * Use a separate copilot
+   */
+  copilot?: ICopilot
+  copilotId?: string
+
+  /**
+   * Referenced copilot model if not using a separate copilot
+   */
+  referencedModel?: ICopilotModel
+  referencedId?: string
+
+  modelType?: AiModelTypeEnum
+  model?: string
+
+  /**
+   * Details config for ai model
+   */
+  options?: TCopilotModelOptions
+}
+
+export type TCopilotModelOptions = {
+  [key: string]: any
+}

package/src/ai/copilot-organization.model.ts

@@ -0,0 +1,21 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model'
+import { IOrganization } from '../organization.model'
+import { AiProvider } from './ai.model'
+import { ICopilot, TCopilotTokenUsage } from './copilot.model'
+
+/**
+ * Organization token usage of global copilot
+ */
+export interface ICopilotOrganization extends IBasePerTenantEntityModel, TCopilotTokenUsage {
+  organizationId?: string
+  organization?: IOrganization
+  copilotId?: string
+  copilot?: ICopilot
+  // Associated AI Model provider
+  provider?: AiProvider | string
+  model?: string
+
+  // Total tokens used historically
+  tokenTotalUsed?: number
+  priceTotalUsed?: number
+}

package/src/ai/copilot-provider.model.ts

@@ -0,0 +1,46 @@
+import { AiModelTypeEnum } from '../agent'
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IAiProviderEntity } from './ai-model.model'
+import { ICopilot } from './copilot.model'
+
+export interface ICopilotProvider extends IBasePerTenantAndOrganizationEntityModel {
+  providerName?: string
+  providerType?: string
+  credentials?: Record<string, any>
+  // encryptedConfig?: Record<string, any>
+  isValid?: boolean
+  lastUsed?: Date
+  quotaType?: string
+  quotaLimit?: number
+  quotaUsed?: number
+
+  /**
+   */
+  options?: any
+
+  copilot?: ICopilot
+  copilotId?: string
+
+  models?: ICopilotProviderModel[]
+
+  // Temporary properties
+  provider?: IAiProviderEntity
+}
+
+
+export interface ICopilotProviderModel extends IBasePerTenantAndOrganizationEntityModel {
+  providerName?: string
+  modelName?: string
+  modelType?: AiModelTypeEnum
+  // encryptedConfig?: Record<string, any>
+  modelProperties?: Record<string, any>
+  isValid?: boolean
+
+  // Many to one
+  provider?: ICopilotProvider
+  providerId?: string
+
+  // Temporary properties
+}
+
+export type TCopilotProviderPublicDto = Omit<ICopilotProvider, 'credentials'>

package/src/ai/copilot-role.model.ts

@@ -0,0 +1,48 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IXpertToolset } from './xpert-toolset.model'
+import { IKnowledgebase } from './knowledgebase.model'
+
+/**
+ * @deprecated use Xpert
+ * 
+ * Copilot role, business role for the copilot
+ */
+export interface ICopilotRole extends IBasePerTenantAndOrganizationEntityModel {
+  name: string
+  title?: string
+  titleCN?: string
+  description?: string
+  /**
+   * 系统提示语
+   */
+  prompt?: string
+  /**
+   * 对话开场白
+   */
+  starters?: string[]
+  active?: boolean
+  avatar?: string
+
+  toolsets?: IXpertToolset[]
+  /**
+   * More configuration
+   */
+  options?: TCopilotRoleOptions
+
+  // Many to many relationship
+  knowledgebases?: IKnowledgebase[]
+}
+
+/**
+ * @deprecated use XpertRole
+ */
+export type TCopilotRoleOptions = {
+  context?: Record<string, any>
+  toolsets: {
+    [id: string]: {
+      [tool: string]: {
+        defaultArgs: Record<string, any>
+      }
+    }
+  }
+}

package/src/ai/copilot-store.model.ts

@@ -0,0 +1,34 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+
+export interface ICopilotStore extends TCopilotStore, IBasePerTenantAndOrganizationEntityModel {}
+
+export interface ICopilotStoreVector extends TCopilotStoreVector, IBasePerTenantAndOrganizationEntityModel {
+}
+
+export type TCopilotStore = {
+  prefix: string
+  key?: string
+  value: any
+}
+
+export type TCopilotStoreVector = {
+  prefix: string
+  key: string
+  field_name: any
+  embedding: number[]
+}
+
+export const MEMORY_QA_PROMPT = `Summarize the experience of the above conversation and output a short question and answer.`
+export const MEMORY_PROFILE_PROMPT = `Extract new user profile information from the above conversation in one short sentence. If no new information is available, return nothing.`
+
+export type TMemory = {
+  memoryId?: string
+}
+export type TMemoryUserProfile = TMemory & {
+  profile: string
+  context?: string
+}
+export type TMemoryQA = TMemory & {
+  question: string
+  answer: string
+}