@metad/contracts 3.6.7 → 3.8.0

package/src/ai/knowledgebase.model.ts

@@ -1,205 +0,0 @@
-import { ICopilotModel } from './copilot-model.model'
-import { I18nObject, TAvatar } from '../types'
-import { IBasePerWorkspaceEntityModel } from './xpert-workspace.model'
-import { IKnowledgeDocument } from './knowledge-doc.model'
-import { IXpert } from './xpert.model'
-import { IIntegration } from '../integration.model'
-import { channelName } from '../agent/graph'
-import { IDocChunkMetadata } from './knowledge-doc-chunk.model'
-
-/**
- * Non-internal types should remain the same as IntegrationEnum.
- */
-export enum KnowledgeProviderEnum {
-  Internal = 'internal',
-}
-
-export enum KnowledgebaseTypeEnum {
-  Standard = 'standard',
-  External = 'external'
-}
-
-export enum KnowledgeStructureEnum {
-  General = 'general',
-  ParentChild = 'parent-child',
-  QA = 'qa'
-}
-
-export type KnowledgebaseParserConfig = {
-  pages?: number[][]
-  embeddingBatchSize?: number
-  chunkSize: number | null
-  chunkOverlap: number | null
-  delimiter: string | null
-}
-
-/**
- * Type of rag knowledgebase
- */
-export type TKnowledgebase = {
-  /**
-   * KB name
-   */
-  name: string
-
-  /**
-   * Type of KB
-   */
-  type: KnowledgebaseTypeEnum
-
-  /**
-   * English | Chinese
-   */
-  language?: 'Chinese' | 'English' | null
-  /**
-   * Avatar object
-   */
-  avatar?: TAvatar
-  /**
-   * KB description
-   */
-  description?: string
-  /**
-   * Public in tenant or in organization or private
-   * @default private
-   */
-  permission?: KnowledgebasePermission
-
-  /**
-   * Copilot model for knowledgebase
-   */
-  copilotModel?: ICopilotModel
-  copilotModelId?: string
-
-  // Rerank model for re-ranking retrieved chunks
-  rerankModel?: ICopilotModel
-  rerankModelId?: string
-
-  // Vision model for image understanding
-  visionModel?: ICopilotModel
-  visionModelId?: string
-
-  documentNum?: number | null
-  tokenNum?: number | null
-  chunkNum?: number | null
-  /**
-   *@deprecated use `recall`
-   */
-  similarityThreshold?: number
-  vectorSimilarityWeight?: number
-  /**
-   * @deprecated
-   * default parser ID
-   */
-  parserId?: string
-
-  parserConfig?: KnowledgebaseParserConfig
-
-  /**
-   * Index structure determines how the knowledge base organizes and indexes your document content.
-   * @deprecated
-   */
-  structure?: KnowledgeStructureEnum
-
-  /**
-   * Recall params for kb chunks
-   */
-  recall?: TKBRecallParams
-
-  status?: string
-  
-  /**
-   * Metadata custom field definition array
-   */
-	metadataSchema?: KBMetadataFieldDef[]
-
-  /**
-   * API service enabled
-   */
-  apiEnabled?: boolean
-
-  documents?: IKnowledgeDocument[]
-
-  integrationId?: string
-  extKnowledgebaseId?: string
-  pipelineId?: string
-}
-
-/**
- * Knowledgebase Entity
- */
-export interface IKnowledgebase extends TKnowledgebase, IBasePerWorkspaceEntityModel {
-  xperts?: IXpert[]
-  integration?: IIntegration
-  pipeline?: IXpert
-}
-
-/**
- * Knowledgebase permission levels
- */
-export enum KnowledgebasePermission {
-  /**
-   * Only visible to you
-   * @default
-   */
-  Private = 'private',
-  /**
-   * Visible to all members in the organization
-   */
-  Organization = 'organization',
-  /**
-   * Visible to all members in the tenant
-   */
-  Public = 'public'
-}
-
-/**
- * Recall parameters
- */
-export type TKBRecallParams = {
-  /**
-   * Top K of result chunks
-   */
-  topK?: number
-  /**
-   * At least the similarity threshold
-   */
-  score?: number
-
-  /**
-   * Weight in EnsembleRetriever
-   */
-  weight?: number
-}
-
-export type DocumentMetadata = IDocChunkMetadata & {
-    score?: number; 
-    relevanceScore?: number
-} & Record<string, any>;
-
-export type MetadataFieldType =
-  | 'string' | 'number' | 'boolean' | 'enum' | 'datetime' | 'string[]' | 'number[]' | 'object';
-
-export type KBMetadataFieldDef = {
-  key: string;                // Unique key, e.g. "department"
-  label?: I18nObject;             // Display label
-  type: MetadataFieldType;
-  enumValues?: string[];
-  description?: string;
-}
-
-/**
- * Channel name for knowledgebase pipeline
- */
-export const KnowledgebaseChannel = channelName('knowledgebase')
-/**
- * Task ID of a knowledgebase run
- */
-export const KnowledgeTask = 'task_id'
-/**
- * Specify the data source to run
- */
-export const KNOWLEDGE_SOURCES_NAME = 'sources'
-export const KNOWLEDGE_DOCUMENTS_NAME = 'documents'
-export const KNOWLEDGE_FOLDER_ID_NAME = 'folder_id'
-export const KNOWLEDGE_STAGE_NAME = 'stage'

package/src/ai/rag-web.ts

@@ -1,54 +0,0 @@
-import { IntegrationEnum } from "../integration.model";
-import { TParameter, TSelectOption } from "../types";
-import { IKnowledgeDocumentPage } from "./knowledge-doc-page.model";
-
-export enum KDocumentWebTypeEnum {
-  Playwright = 'playwright',
-  FireCrawl = 'firecrawl',
-  Notion = 'notion'
-}
-
-export type TRagWebOptions = {
-  url: string
-  params?: Record<string, unknown>
-}
-
-export type TKDocumentWebSchema = {
-  type: KDocumentWebTypeEnum,
-	helpUrl: string,
-  options: TParameter[]
-  /**
-   * Need to provide integration of provider
-   */
-  integrationProvider?: IntegrationEnum
-}
-
-export type TRagWebResult = {
-  docs: IKnowledgeDocumentPage[]
-  duration: number
-}
-
-export const KDocumentWebTypeOptions: TSelectOption<KDocumentWebTypeEnum>[] = [
-  {
-    value: KDocumentWebTypeEnum.Playwright,
-    label: {
-      en_US: 'Playwright'
-    },
-    icon: `<svg width="100%" height="100%" viewBox="0 0 400 400" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M136.444 221.556C123.558 225.213 115.104 231.625 109.535 238.032C114.869 233.364 122.014 229.08 131.652 226.348C141.51 223.554 149.92 223.574 156.869 224.915V219.481C150.941 218.939 144.145 219.371 136.444 221.556ZM108.946 175.876L61.0895 188.484C61.0895 188.484 61.9617 189.716 63.5767 191.36L104.153 180.668C104.153 180.668 103.578 188.077 98.5847 194.705C108.03 187.559 108.946 175.876 108.946 175.876ZM149.005 288.347C81.6582 306.486 46.0272 228.438 35.2396 187.928C30.2556 169.229 28.0799 155.067 27.5 145.928C27.4377 144.979 27.4665 144.179 27.5336 143.446C24.04 143.657 22.3674 145.473 22.7077 150.721C23.2876 159.855 25.4633 174.016 30.4473 192.721C41.2301 233.225 76.8659 311.273 144.213 293.134C158.872 289.185 169.885 281.992 178.152 272.81C170.532 279.692 160.995 285.112 149.005 288.347ZM161.661 128.11V132.903H188.077C187.535 131.206 186.989 129.677 186.447 128.11H161.661Z" fill="#2D4552"/>
-<path d="M193.981 167.584C205.861 170.958 212.144 179.287 215.465 186.658L228.711 190.42C228.711 190.42 226.904 164.623 203.57 157.995C181.741 151.793 168.308 170.124 166.674 172.496C173.024 167.972 182.297 164.268 193.981 167.584ZM299.422 186.777C277.573 180.547 264.145 198.916 262.535 201.255C268.89 196.736 278.158 193.031 289.837 196.362C301.698 199.741 307.976 208.06 311.307 215.436L324.572 219.212C324.572 219.212 322.736 193.41 299.422 186.777ZM286.262 254.795L176.072 223.99C176.072 223.99 177.265 230.038 181.842 237.869L274.617 263.805C282.255 259.386 286.262 254.795 286.262 254.795ZM209.867 321.102C122.618 297.71 133.166 186.543 147.284 133.865C153.097 112.156 159.073 96.0203 164.029 85.204C161.072 84.5953 158.623 86.1529 156.203 91.0746C150.941 101.747 144.212 119.124 137.7 143.45C123.586 196.127 113.038 307.29 200.283 330.682C241.406 341.699 273.442 324.955 297.323 298.659C274.655 319.19 245.714 330.701 209.867 321.102Z" fill="#2D4552"/>
-<path d="M161.661 262.296V239.863L99.3324 257.537C99.3324 257.537 103.938 230.777 136.444 221.556C146.302 218.762 154.713 218.781 161.661 220.123V128.11H192.869C189.471 117.61 186.184 109.526 183.423 103.909C178.856 94.612 174.174 100.775 163.545 109.665C156.059 115.919 137.139 129.261 108.668 136.933C80.1966 144.61 57.179 142.574 47.5752 140.911C33.9601 138.562 26.8387 135.572 27.5049 145.928C28.0847 155.062 30.2605 169.224 35.2445 187.928C46.0272 228.433 81.663 306.481 149.01 288.342C166.602 283.602 179.019 274.233 187.626 262.291H161.661V262.296ZM61.0848 188.484L108.946 175.876C108.946 175.876 107.551 194.288 89.6087 199.018C71.6614 203.743 61.0848 188.484 61.0848 188.484Z" fill="#E2574C"/>
-<path d="M341.786 129.174C329.345 131.355 299.498 134.072 262.612 124.185C225.716 114.304 201.236 97.0224 191.537 88.8994C177.788 77.3834 171.74 69.3802 165.788 81.4857C160.526 92.163 153.797 109.54 147.284 133.866C133.171 186.543 122.623 297.706 209.867 321.098C297.093 344.47 343.53 242.92 357.644 190.238C364.157 165.917 367.013 147.5 367.799 135.625C368.695 122.173 359.455 126.078 341.786 129.174ZM166.497 172.756C166.497 172.756 180.246 151.372 203.565 158C226.899 164.628 228.706 190.425 228.706 190.425L166.497 172.756ZM223.42 268.713C182.403 256.698 176.077 223.99 176.077 223.99L286.262 254.796C286.262 254.791 264.021 280.578 223.42 268.713ZM262.377 201.495C262.377 201.495 276.107 180.126 299.422 186.773C322.736 193.411 324.572 219.208 324.572 219.208L262.377 201.495Z" fill="#2EAD33"/>
-<path d="M139.88 246.04L99.3324 257.532C99.3324 257.532 103.737 232.44 133.607 222.496L110.647 136.33L108.663 136.933C80.1918 144.611 57.1742 142.574 47.5704 140.911C33.9554 138.563 26.834 135.572 27.5001 145.929C28.08 155.063 30.2557 169.224 35.2397 187.929C46.0225 228.433 81.6583 306.481 149.005 288.342L150.989 287.719L139.88 246.04ZM61.0848 188.485L108.946 175.876C108.946 175.876 107.551 194.288 89.6087 199.018C71.6615 203.743 61.0848 188.485 61.0848 188.485Z" fill="#D65348"/>
-<path d="M225.27 269.163L223.415 268.712C182.398 256.698 176.072 223.99 176.072 223.99L232.89 239.872L262.971 124.281L262.607 124.185C225.711 114.304 201.232 97.0224 191.532 88.8994C177.783 77.3834 171.735 69.3802 165.783 81.4857C160.526 92.163 153.797 109.54 147.284 133.866C133.171 186.543 122.623 297.706 209.867 321.097L211.655 321.5L225.27 269.163ZM166.497 172.756C166.497 172.756 180.246 151.372 203.565 158C226.899 164.628 228.706 190.425 228.706 190.425L166.497 172.756Z" fill="#1D8D22"/>
-<path d="M141.946 245.451L131.072 248.537C133.641 263.019 138.169 276.917 145.276 289.195C146.513 288.922 147.74 288.687 149 288.342C152.302 287.451 155.364 286.348 158.312 285.145C150.371 273.361 145.118 259.789 141.946 245.451ZM137.7 143.451C132.112 164.307 127.113 194.326 128.489 224.436C130.952 223.367 133.554 222.371 136.444 221.551L138.457 221.101C136.003 188.939 141.308 156.165 147.284 133.866C148.799 128.225 150.318 122.978 151.832 118.085C149.393 119.637 146.767 121.228 143.776 122.867C141.759 129.093 139.722 135.898 137.7 143.451Z" fill="#C04B41"/>
-</svg>`
-  },
-  {
-    value: KDocumentWebTypeEnum.FireCrawl,
-    label: {
-      en_US: 'FireCrawl'
-    },
-    icon: `🔥`,
-  }
-]

package/src/ai/rag.ts

@@ -1,24 +0,0 @@
-export enum VectorTypeEnum {
-  ANALYTICDB = 'analyticdb',
-  CHROMA = 'chroma',
-  MILVUS = 'milvus',
-  MYSCALE = 'myscale',
-  PGVECTOR = 'pgvector',
-  PGVECTO_RS = 'pgvecto-rs',
-  QDRANT = 'qdrant',
-  RELYT = 'relyt',
-  TIDB_VECTOR = 'tidb_vector',
-  WEAVIATE = 'weaviate',
-  OPENSEARCH = 'opensearch',
-  TENCENT = 'tencent',
-  ORACLE = 'oracle',
-  ELASTICSEARCH = 'elasticsearch',
-  ELASTICSEARCH_JA = 'elasticsearch-ja',
-  LINDORM = 'lindorm',
-  COUCHBASE = 'couchbase',
-  BAIDU = 'baidu',
-  VIKINGDB = 'vikingdb',
-  UPSTASH = 'upstash',
-  TIDB_ON_QDRANT = 'tidb_on_qdrant',
-  OCEANBASE = 'oceanbase'
-}

package/src/ai/role-permissions.ts

@@ -1,13 +0,0 @@
-export enum AIPermissionsEnum {
-  /**
-   * Create or edit Knowledgebase in organization.
-   */
-  KNOWLEDGEBASE_EDIT = 'KNOWLEDGEBASE_EDIT',
-  COPILOT_VIEW = 'COPILOT_VIEW',
-  COPILOT_EDIT = 'COPILOT_EDIT',
-  /**
-   * Create or edit Xperts in organization.
-   */
-  XPERT_EDIT = 'XPERT_EDIT',
-  CHAT_VIEW = 'CHAT_VIEW',
-}

package/src/ai/types.ts

@@ -1,83 +0,0 @@
-import { TSelectOption } from "../types";
-import { TXpertAttachmentType, XpertParameterTypeEnum } from "./xpert.model"
-
-export type TErrorHandling = {
-  type?: null | 'defaultValue' | 'failBranch'
-  defaultValue?: {content?: string; } & Record<string, any>
-  failBranch?: string
-}
-
-export enum ApiAuthType {
-  /**
-   * Enum class for api provider auth type.
-   */
-  NONE = "none",
-  API_KEY = "api_key",
-  BASIC = 'basic'
-}
-
-/**
- * Reference variable (parameter)
- */
-export type TXpertRefParameter = {
-  type?: XpertParameterTypeEnum
-  name: string
-  optional?: boolean
-  /**
-   * Referencing other variable
-   */
-  variable?: string
-}
-
-/**
- * Embedding status of an entity, such as an bi indicator or kb document.
- */
-export enum EmbeddingStatusEnum {
-  PROCESSING = 'processing',
-  SUCCESS = 'success',
-  FAILED = 'failed',
-  REQUIRED = 'required',
-}
-
-export const Attachment_Type_Options: TSelectOption<string, TXpertAttachmentType>[] = [
-    {
-      key: 'document',
-      value: 'TXT, MD, MDX, MARKDOWN, PDF, HTML, XLSX, XLS, DOC, DOCX, CSV, EML, MSG, PPTX, PPT, XML, EPUB',
-      label: {
-        zh_Hans: '文档',
-        en_US: 'Document',
-      },
-    },
-    {
-      key: 'image',
-      value: 'JPG, JPEG, PNG, GIF, WEBP, SVG',
-      label: {
-        zh_Hans: '图片',
-        en_US: 'Image',
-      },
-    },
-    {
-      key: 'audio',
-      value: 'MP3, M4A, WAV, AMR, MPGA',
-      label: {
-        zh_Hans: '音频',
-        en_US: 'Audio',
-      },
-    },
-    {
-      key: 'video',
-      value: 'MP4, MOV, MPEG, WEBM',
-      label: {
-        zh_Hans: '视频',
-        en_US: 'Video',
-      },
-    },
-    {
-      key: 'others',
-      value: '',
-      label: {
-        zh_Hans: '其他文件类型',
-        en_US: 'Other file types',
-      },
-    }
-  ]

package/src/ai/xpert-agent-execution.model.ts

@@ -1,115 +0,0 @@
-import { StoredMessage } from '@langchain/core/messages'
-import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model'
-import { IXpert, TXpertTeamNodeType } from './xpert.model'
-import { IXpertAgent } from './xpert-agent.model'
-import { TSensitiveOperation } from './chat.model'
-import { WorkflowNodeTypeEnum } from './xpert-workflow.model'
-
-export type TXpertExecution = {
-  category?: TXpertTeamNodeType
-  type?: WorkflowNodeTypeEnum | string
-  title?: string
-  inputs?: any
-  outputs?: any
-  status?: XpertAgentExecutionStatusEnum
-  error?: string
-  elapsedTime?: number
-
-  // State of graph
-  threadId?: string
-  checkpointNs?: string
-  checkpointId?: string
-  channelName?: string
-  parent_thread_id?: string
-
-  // Many to one
-  /**
-   * Include workflow node key
-   */
-  agentKey?: string
-  predecessor?: string
-  xpert?: IXpert
-  xpertId?: string
-  // Parent AgentExecution
-  parentId?: string
-}
-
-/**
- * Corresponds to the run in the [Agent Protocol](https://github.com/langchain-ai/agent-protocol).
- */
-export type TXpertAgentExecution = TXpertExecution & {
-  /**
-   * Total token usage of chat model
-   */
-  tokens?: number
-  /**
-   * Token usage of embedding
-   */
-  embedTokens?: number
-  metadata?: TAgentExecutionMetadata
-
-  /**
-   * Latency of response from provider (s)
-   */
-  responseLatency?: number
-  // Token usage
-  totalPrice?: number
-  currency?: string
-  inputTokens?: number
-  inputUnitPrice?: number
-  inputPriceUnit?: number
-  outputTokens?: number
-  outputUnitPrice?: number
-  outputPriceUnit?: number
-  
-  /**
-   * Latest operation when interrupted
-   */
-  operation?: TSensitiveOperation
-
-  // Stored messages or from checkpoints
-  messages?: StoredMessage[]
-
-  // Temporary properties
-  agent?: IXpertAgent
-  totalTokens?: number
-  /**
-   * Summary of conversation
-   */
-  summary?: string
-}
-
-/**
- * Execution of agent or workflow nodes.
- * 
- * Corresponds to the run in the [Agent Protocol](https://github.com/langchain-ai/agent-protocol).
- */
-export interface IXpertAgentExecution extends IBasePerTenantAndOrganizationEntityModel, TXpertAgentExecution {
-  subExecutions?: IXpertAgentExecution[]
-
-  // Temporary properties
-  runningExecution?: IXpertAgentExecution
-}
-
-/**
- * Corresponds to the status of Run in [Agent Protocol](https://github.com/langchain-ai/agent-protocol).
- */
-export enum XpertAgentExecutionStatusEnum {
-  RUNNING = 'running',
-  SUCCESS = 'success',
-  ERROR = 'error',
-  PENDING = 'pending',
-  TIMEOUT = 'timeout',
-  INTERRUPTED = 'interrupted'
-}
-
-export type TAgentExecutionMetadata = {
-  /**
-   * AI model provider
-   */
-  provider: string
-  /**
-   * AI Model
-   */
-  model: string
-}