@metad/contracts 3.6.2 → 3.6.7

package/src/agent/utils.ts

@@ -0,0 +1,122 @@
+import { isRouterKey } from '../ai'
+import { TXpertGraph } from '../ai/xpert.model'
+import { DeepPartial } from '../types'
+
+/**
+ * Channels of all upstream and downstream nodes relative to the starting point startKey.
+ *
+ * @param graph
+ * @param startKey
+ */
+export function allChannels(graph: TXpertGraph, startKey: string) {
+  graph = getCurrentGraph(graph, startKey)
+  return graph.nodes.filter((node) => !(node.type === 'workflow' && isRouterKey(node.key))).map((node) => node.key)
+}
+
+export function findStartNodes(graph: DeepPartial<TXpertGraph>, key: string): string[] {
+  const toMap = new Map<string, string[]>()
+  // Consider only horizontal processes
+  const connections = graph.connections.filter((_) => _.type === 'edge')
+  // Construct toMap: record all upstream nodes of each node
+  for (const conn of connections) {
+    if (!toMap.has(conn.to)) toMap.set(conn.to, [])
+    const [fromKey] = conn.from.split('/')
+    if (conn.type === 'edge') {
+      toMap.get(conn.to).push(fromKey)
+    }
+  }
+
+  const result = new Set<string>()
+
+  const checked = []
+  // Recursively search upstream until you reach the starting point
+  function dfsUp(nodeKey: string) {
+    checked.push(nodeKey)
+    const parents = toMap.get(nodeKey)
+
+    // There is no upstream, this is the starting point
+    if (!parents || parents.length === 0) {
+      result.add(nodeKey)
+      return
+    }
+
+    for (const parent of parents) {
+      // There is a cycle
+      if (checked.includes(parent)) {
+        return
+      }
+      dfsUp(parent)
+    }
+  }
+
+  dfsUp(key)
+
+  return Array.from(result)
+}
+
+/**
+ * Keep the content in the same graph as the key node (including the node, its connected nodes, and the 'edge' type connections between them)
+ * 
+ * @param graph 
+ * @param key 
+ * @returns 
+ */
+export function getCurrentGraph(graph: TXpertGraph, key: string): TXpertGraph {
+  const validConnections = graph.connections.filter(conn => conn.type === 'edge')
+
+  // Extract the primary key (remove the / suffix)
+  const normalize = (k: string) => k.split('/')[0]
+
+  // Adjacency list: bidirectional (because you want to traverse the current graph)
+  const adjacency = new Map<string, Set<string>>()
+
+  for (const conn of validConnections) {
+    const from = normalize(conn.from)
+    const to = normalize(conn.to)
+
+    if (!adjacency.has(from)) adjacency.set(from, new Set())
+    if (!adjacency.has(to)) adjacency.set(to, new Set())
+
+    adjacency.get(from).add(to)
+    adjacency.get(to).add(from)
+  }
+
+  const visited = new Set<string>()
+  const queue: string[] = key ? [normalize(key)] : []
+
+  // BFS/DFS collects all nodes in the same graph
+  while (queue.length > 0) {
+    const current = queue.pop()
+    if (visited.has(current)) continue
+    visited.add(current)
+
+    const neighbors = adjacency.get(current) || new Set()
+    for (const neighbor of neighbors) {
+      if (!visited.has(neighbor)) {
+        queue.push(neighbor)
+      }
+    }
+  }
+
+  const nodeSet = new Set(graph.nodes.map(n => n.key))
+  const keptNodes = graph.nodes.filter(n => visited.has(normalize(n.key)))
+  const keptNodeKeys = new Set(keptNodes.map(n => n.key))
+
+  const keptConnections = validConnections.filter(conn => {
+    const from = normalize(conn.from)
+    const to = normalize(conn.to)
+    return visited.has(from) && visited.has(to)
+  })
+
+  return {
+    nodes: keptNodes,
+    connections: keptConnections
+  }
+}
+
+export function shortTitle(input: string) {
+  if (input) {
+    return input.length <= 50 ? input : input.slice(0, 50) + '...'
+  }
+  return null
+}

package/src/agent/variables.ts

@@ -0,0 +1,66 @@
+import { TWorkflowVarGroup } from "../ai/xpert-workflow.model"
+import { TXpertParameter, XpertParameterTypeEnum } from "../ai/xpert.model"
+
+/**
+ * 
+ * Returns the variable schema for a given variable name.
+ * The variable name can be in the format of 'groupName.variableName' or just 'variableName'.
+ * 
+ * @param variables 
+ * @param variable 
+ * @returns 
+ */
+export function getVariableSchema(variables: TWorkflowVarGroup[], variable: string) {
+    const [groupName, ...rest] = variable?.split('.') ?? []
+
+    const group = variables?.find((_) => (rest.length ? _.group?.name === groupName : !_.group?.name))
+
+    return {
+        group,
+        variable: group?.variables.find((_) => _.name === (rest.join('.') || groupName))
+    }
+}
+
+export const FILE_VARIABLES: TXpertParameter[] = [
+    {
+        name: 'filePath',
+        type: XpertParameterTypeEnum.STRING,
+        description: {
+            en_US: 'The path to the file',
+            zh_Hans: '文件的路径'
+        },
+
+    },
+    {
+        name: 'fileName',
+        type: XpertParameterTypeEnum.STRING,
+        description: {
+            en_US: 'The name of the file',
+            zh_Hans: '文件的名称'
+        },
+    },
+    {
+        name: 'fileUrl',
+        type: XpertParameterTypeEnum.STRING,
+        description: {
+            en_US: 'The URL of the file',
+            zh_Hans: '文件的URL地址'
+        },
+    },
+    {
+        name: 'fileSize',
+        type: XpertParameterTypeEnum.NUMBER,
+        description: {
+            en_US: 'The size of the file in bytes',
+            zh_Hans: '文件的大小，单位为字节'
+        },
+    },
+    {
+        name: 'mimeType',
+        type: XpertParameterTypeEnum.STRING,
+        description: {
+            en_US: 'The MIME type of the file',
+            zh_Hans: '文件的MIME类型'
+        },
+    }
+]

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

@@ -0,0 +1,232 @@
+import { AiModelTypeEnum } from '../agent/'
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { I18nObject } from '../types'
+import { ICopilot } from './copilot.model'
+
+
+export interface IAiModel extends IBasePerTenantAndOrganizationEntityModel {
+  /**
+   * Model name
+   */
+  name: string
+
+  /**
+   * Model display name
+   */
+  label: string
+
+  /**
+   * Model type
+   */
+  modelType: string
+
+  /**
+   * Model features
+   */
+  features: string[]
+
+  /**
+   * Model properties
+   */
+  modelProperties: Record<string, any>
+
+  /**
+   * Parameter rules
+   */
+  parameterRules: Record<string, any>[]
+
+  /**
+   * Pricing information
+   */
+  pricing: {
+    input: string
+    output: string
+    unit: string
+    currency: string
+  }
+
+  /**
+   * Deprecated
+   */
+  deprecated: boolean
+}
+
+export enum ProviderType {
+  CUSTOM = 'custom',
+  SYSTEM = 'system'
+}
+
+export interface ICopilotWithProvider extends ICopilot {
+  providerWithModels: Partial<IAiProviderEntity>
+}
+
+export interface IAiProviderEntity {
+  provider: string;
+  label: I18nObject;
+  description: I18nObject;
+  icon_small: I18nObject;
+  icon_large: I18nObject;
+  background: string;
+  help: ProviderHelpInfo;
+  supported_model_types: AiModelTypeEnum[];
+  configurate_methods: ConfigurateMethod[];
+  model_credential_schema: ModelCredentialSchema;
+  provider_credential_schema: ProviderCredentialSchema;
+  models: ProviderModel[]
+  /**
+   * Not yet implemented, your contribution is needed
+   */
+  not_implemented?: boolean
+}
+
+export interface ProviderHelpInfo {
+  title: I18nObject;
+  url: I18nObject;
+}
+
+export interface ProviderModel {
+  model: string;
+  label: I18nObject;
+  model_type: AiModelTypeEnum;
+  features?: ModelFeature[];
+  fetch_from: FetchFrom;
+  model_properties: Partial<Record<ModelPropertyKey, any>>;
+  deprecated?: boolean;
+  modelConfig?: any;
+}
+
+export interface ProviderCredentialSchema {
+  credential_form_schemas: CredentialFormSchema[];
+}
+
+/**
+ * @todo Use JSON Schema to implement
+ */
+export enum CredentialFormTypeEnum {
+  TEXT_INPUT = "text-input",
+  SECRET_INPUT = "secret-input",
+  SELECT = "select",
+  RADIO = "radio",
+  // SWITCH = "switch", // use ParameterType.BOOLEAN
+}
+
+export interface CredentialFormSchema {
+  variable: string;
+  label: I18nObject;
+  type: CredentialFormTypeEnum | ParameterType
+  required: boolean;
+  default?: number | string | boolean
+  options?: {
+    label: I18nObject
+    value: number | string | boolean
+    show_on?: FormShowOnObject[]
+  }[]
+  placeholder: I18nObject;
+
+  max_length?: number
+  show_on?: FormShowOnObject[]
+}
+
+export interface FormShowOnObject {
+  variable: string
+  value: string
+}
+
+export enum FetchFrom {
+  PREDEFINED_MODEL = "predefined-model",
+  CUSTOMIZABLE_MODEL = "customizable-model"
+}
+
+export enum ModelFeature {
+  TOOL_CALL = "tool-call",
+  MULTI_TOOL_CALL = "multi-tool-call",
+  AGENT_THOUGHT = "agent-thought",
+  VISION = "vision",
+  STREAM_TOOL_CALL = "stream-tool-call",
+  VIDEO = "video",
+  STRUCTURED_OUTPUT = "structured-output"
+}
+
+export enum ModelPropertyKey {
+  MODE = "mode",
+  CONTEXT_SIZE = "context_size",
+  MAX_CHUNKS = "max_chunks",
+  FILE_UPLOAD_LIMIT = "file_upload_limit",
+  SUPPORTED_FILE_EXTENSIONS = "supported_file_extensions",
+  MAX_CHARACTERS_PER_CHUNK = "max_characters_per_chunk",
+  DEFAULT_VOICE = "default_voice",
+  VOICES = "voices",
+  WORD_LIMIT = "word_limit",
+  AUDIO_TYPE = "audio_type",
+  MAX_WORKERS = "max_workers"
+}
+
+export enum ConfigurateMethod {
+  PREDEFINED_MODEL = 'predefined-model',
+  CUSTOMIZABLE_MODEL = 'customizable-model'
+}
+
+/**
+ * @todo Use JSON Schema to implement
+ */
+export enum ParameterType {
+  FLOAT = "float",
+  INT = "int",
+  STRING = "string",
+  BOOLEAN = "boolean",
+  TEXT = "text"
+}
+
+/**
+ * @todo Use JSON Schema to implement
+ */
+export interface ParameterRule {
+  name?: string;
+  useTemplate?: string;
+  label: I18nObject;
+  type: ParameterType;
+  help?: I18nObject;
+  required?: boolean;
+  default?: any;
+  min?: number;
+  max?: number;
+  precision?: number;
+  options?: string[];
+}
+
+export interface PriceConfig {
+  input: number;
+  output?: number;
+  unit: number;
+  currency: string;
+}
+
+export interface AIModelEntity extends ProviderModel {
+  parameter_rules?: ParameterRule[]
+  pricing?: PriceConfig
+}
+
+export interface FieldModelSchema {
+  label: I18nObject
+  placeholder?: I18nObject
+}
+    
+
+export interface ModelCredentialSchema {
+  model: FieldModelSchema
+  credential_form_schemas: CredentialFormSchema[]
+}
+
+export const AI_MODEL_TYPE_VARIABLE = "__model_type"
+
+export enum PriceType {
+  INPUT = "input",
+  OUTPUT = "output"
+}
+
+export interface PriceInfo {
+  unitPrice: number;
+  unit: number;
+  totalAmount: number;
+  currency: string;
+}

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

@@ -0,0 +1,53 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+
+export interface IAiProvider extends IBasePerTenantAndOrganizationEntityModel {
+  /**
+   * 供应商标识,如 'openai'
+   */
+  name: string
+
+  /**
+   * 供应商展示名称
+   */
+  label: string
+
+  /**
+   * 供应商描述
+   */
+  description: string
+
+  /**
+   * 供应商小图标
+   */
+  iconSmall: string
+
+  /**
+   * 供应商大图标
+   */
+  iconLarge: string
+
+  /**
+   * 背景颜色
+   */
+  background: string
+
+  /**
+   * 帮助信息标题
+   */
+  helpTitle: string
+
+  /**
+   * 帮助信息URL
+   */
+  helpUrl: string
+
+  /**
+   * 支持的模型类型
+   */
+  supportedModelTypes: string[]
+
+  /**
+   * 配置方式
+   */
+  configurateMethods: string[]
+}

package/src/ai/ai.model.ts

@@ -0,0 +1,87 @@
+/**
+ * Business roles for AI copilot (commands or contexts)
+ */
+export enum AiBusinessRole {
+    FinanceBP = 'finance_bp',
+    SupplyChainExpert = 'supply_chain_expert',
+}
+
+/**
+ * Providers for LLMs
+ * 
+ * - https://js.langchain.com/docs/integrations/chat/
+ */
+export enum AiProvider {
+  /**
+   * - https://js.langchain.com/docs/integrations/chat/openai/
+   */
+  OpenAI = 'openai',
+  /**
+   * - https://js.langchain.com/docs/integrations/chat/openai/
+   */
+  Azure = 'azure',
+  // DashScope = 'dashscope',
+  /**
+   * - https://ollama.com/
+   * - https://js.langchain.com/docs/integrations/chat/ollama/
+   */
+  Ollama = 'ollama',
+  /**
+   * - https://www.deepseek.com/zh
+   * - https://js.langchain.com/docs/integrations/chat/openai/
+   */
+  DeepSeek = 'deepseek',
+  /**
+   * - https://docs.anthropic.com/en/home
+   * - https://js.langchain.com/docs/integrations/chat/anthropic/
+   */
+  Anthropic = 'anthropic',
+  /**
+   * - https://www.aliyun.com/product/bailian
+   * - https://js.langchain.com/docs/integrations/chat/alibaba_tongyi/
+   */
+  AlibabaTongyi = 'alibaba_tongyi',
+  /**
+   * - https://open.bigmodel.cn/
+   * - https://js.langchain.com/docs/integrations/chat/openai/
+   */
+  Zhipu = 'zhipu',
+  /**
+   * - https://qianfan.cloud.baidu.com/
+   * - https://js.langchain.com/docs/integrations/chat/baidu_qianfan/
+   */
+  BaiduQianfan = 'baidu_qianfan',
+  /**
+   * - https://www.together.ai/
+   * - https://js.langchain.com/docs/integrations/chat/togetherai/
+   */
+  Together = 'together',
+  /**
+   * - https://platform.moonshot.cn/console
+   * - https://js.langchain.com/docs/integrations/chat/openai/
+   */
+  Moonshot = 'moonshot',
+  /**
+   * - https://groq.com/
+   * - https://js.langchain.com/docs/integrations/chat/openai/
+   */
+  Groq = 'groq',
+  /**
+   * - https://mistral.ai/
+   * 
+   */
+  Mistral = 'mistral',
+  /**
+   * - https://cohere.com/
+   */
+  Cohere = 'cohere',
+  
+}
+
+export enum AiProtocol {
+  OpenAI = 'openai',
+  Others = 'others'
+}
+
+export const OpenAIEmbeddingsProviders = [AiProvider.OpenAI, AiProvider.Azure, AiProvider.DeepSeek]
+export const OllamaEmbeddingsProviders = [AiProvider.Ollama]

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

@@ -0,0 +1,31 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
+import { IChatMessage } from './chat-message.model'
+import { IChatConversation } from './chat.model'
+
+export enum ChatMessageFeedbackRatingEnum {
+  LIKE = 'like',
+  DISLIKE = 'dislike'
+}
+
+
+/**
+ * 
+ */
+export interface IChatMessageFeedback extends IBasePerTenantAndOrganizationEntityModel {
+
+  rating: ChatMessageFeedbackRatingEnum
+
+  content?: string
+
+  // Many to one
+  /**
+   * Chat conversation
+   */
+  conversation?: IChatConversation
+  conversationId?: string | null
+  /**
+   * Chat conversation message
+   */
+  message?: IChatMessage
+  messageId?: string | null
+}