@metad/contracts 3.6.7 → 3.8.0

package/src/ai/knowledge-doc-page.model.d.ts

@@ -0,0 +1,15 @@
+import { Document } from '@langchain/core/documents';
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IKnowledgeDocument } from './knowledge-doc.model';
+import { DocumentMetadata, IKnowledgebase } from './knowledgebase.model';
+/**
+ * Segmented page of a knowledge document
+ */
+export interface IKnowledgeDocumentPage<Metadata extends DocumentMetadata = DocumentMetadata> extends Document, IBasePerTenantAndOrganizationEntityModel {
+    documentId?: string;
+    document?: IKnowledgeDocument;
+    knowledgebaseId?: string;
+    knowledgebase?: IKnowledgebase;
+    metadata: Metadata;
+    pageContent: string;
+}

package/src/ai/knowledge-doc.model.d.ts

@@ -0,0 +1,222 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IIntegration } from '../integration.model';
+import { IStorageFile } from '../storage-file.model';
+import { IKnowledgeDocumentPage } from './knowledge-doc-page.model';
+import { IKnowledgebaseTask } from './knowledgebase-task.model';
+import { IKnowledgebase, KBMetadataFieldDef } from './knowledgebase.model';
+import { TRagWebOptions } from './rag-web';
+import { IKnowledgeDocumentChunk } from './knowledge-doc-chunk.model';
+import { DocumentSourceProviderCategoryEnum } from './knowledge-pipeline';
+import { TCopilotModel } from './copilot-model.model';
+import { I18nObject } from '../types';
+export type DocumentParserConfig = {
+    pages?: number[][];
+    replaceWhitespace?: boolean;
+    removeSensitive?: boolean;
+    textSplitterType?: string;
+    textSplitter?: {
+        [key: string]: unknown;
+    };
+    transformerType?: string;
+    transformerIntegration?: string;
+    transformer?: {
+        [key: string]: unknown;
+    };
+    imageUnderstandingType?: string;
+    imageUnderstandingIntegration?: string;
+    imageUnderstanding?: {
+        [key: string]: unknown;
+    };
+    imageUnderstandingModel?: TCopilotModel;
+};
+export type DocumentTextParserConfig = DocumentParserConfig & {
+    delimiter?: string;
+    chunkSize?: number | null;
+    chunkOverlap?: number | null;
+};
+export type DocumentSheetParserConfig = DocumentParserConfig & {
+    fields?: string[];
+    indexedFields?: string[];
+};
+/**
+ * Import Type:
+ * - file: local file
+ * - web: web document
+ * ...
+ */
+export declare enum DocumentTypeEnum {
+    /**
+     * Folder, parent of other documents
+     */
+    FOLDER = "folder",
+    /**
+     * Local files
+     * @deprecated use DocumentSourceProviderCategoryEnum local file type instead
+     */
+    FILE = "file"
+}
+export declare const KDocumentSourceType: {
+    FOLDER: DocumentTypeEnum.FOLDER;
+    FILE: DocumentTypeEnum.FILE;
+    LocalFile: DocumentSourceProviderCategoryEnum.LocalFile;
+    FileSystem: DocumentSourceProviderCategoryEnum.FileSystem;
+    OnlineDocument: DocumentSourceProviderCategoryEnum.OnlineDocument;
+    WebCrawl: DocumentSourceProviderCategoryEnum.WebCrawl;
+    Database: DocumentSourceProviderCategoryEnum.Database;
+};
+/**
+ * Document type category, determine how to process the document.
+ */
+export declare enum KBDocumentCategoryEnum {
+    Text = "text",
+    Image = "image",
+    Audio = "audio",
+    Video = "video",
+    Sheet = "sheet",
+    Other = "other"
+}
+export declare enum KBDocumentStatusEnum {
+    WAITING = "waiting",
+    VALIDATE = "validate",
+    RUNNING = "running",
+    TRANSFORMED = "transformed",
+    SPLITTED = "splitted",
+    UNDERSTOOD = "understood",
+    EMBEDDING = "embedding",
+    CANCEL = "cancel",
+    FINISH = "finish",
+    ERROR = "error"
+}
+export type TDocumentWebOptions = TRagWebOptions & {};
+export type TDocSourceConfig = {
+    key?: string;
+};
+export type TKnowledgeDocument = {
+    disabled?: boolean;
+    knowledgebaseId?: string;
+    /**
+     * @deprecated use fileUrl instead
+     */
+    storageFileId?: string;
+    /**
+     * @deprecated use fileUrl instead
+     */
+    storageFile?: IStorageFile;
+    /**
+     * thumbnail base64 string
+     */
+    thumbnail?: string;
+    /**
+     * default parser ID
+     * @deprecated unused
+     */
+    parserId: string;
+    parserConfig: DocumentTextParserConfig;
+    /**
+     * where dose this document come from
+     */
+    sourceType?: DocumentSourceProviderCategoryEnum | DocumentTypeEnum;
+    sourceConfig?: TDocSourceConfig;
+    /**
+     * document type category
+     */
+    category?: KBDocumentCategoryEnum | null;
+    /**
+     * Local file extension or Web doc provider
+     */
+    type: string;
+    /**
+     * file name or web url
+     */
+    name: string;
+    /**
+     * where does it store
+     */
+    filePath: string;
+    fileUrl?: string;
+    /**
+     * Folder path in server for this document file.
+     * Init it in creating document entity.
+     */
+    folder?: string;
+    size?: string;
+    mimeType?: string;
+    tokenNum?: number | null;
+    chunkNum?: number | null;
+    progress?: number | null;
+    /**
+     * process message
+     */
+    processMsg?: string | null;
+    processBeginAt?: Date | null;
+    processDuation?: number | null;
+    /**
+     * is it validate (0: wasted，1: validate)
+     */
+    status?: KBDocumentStatusEnum;
+    /**
+     * The background job id
+     */
+    jobId?: string;
+    options?: TDocumentWebOptions;
+    integrationId?: string;
+    integration?: IIntegration;
+    /**
+       * @deprecated use chunks instead
+       */
+    pages?: IKnowledgeDocumentPage[];
+    chunks?: IKnowledgeDocumentChunk[];
+    tasks?: IKnowledgebaseTask[];
+};
+/**
+ * Document, include file, web pages, folder, virtual, etc.
+ */
+export interface IKnowledgeDocument<T extends KnowledgeDocumentMetadata = KnowledgeDocumentMetadata> extends TKnowledgeDocument, IBasePerTenantAndOrganizationEntityModel {
+    parent?: IKnowledgeDocument | null;
+    children?: IKnowledgeDocument[];
+    knowledgebase?: IKnowledgebase;
+    draft?: TKnowledgeDocument;
+    metadata?: T;
+}
+/**
+ * System built-in standard document Metadata structure
+ */
+export interface StandardDocumentMetadata {
+    originalFileName?: string;
+    originalFileSize?: string | null;
+    uploadTime?: string;
+    lastUpdatedTime?: string;
+    source?: string;
+    segmentRule?: string;
+    segmentLength?: number;
+    averageSegmentLength?: string;
+    segmentCount?: number;
+    recallRate?: string;
+    embedTime?: string;
+    embedCost?: string | null;
+    tokens?: number;
+}
+export interface KnowledgeDocumentMetadata extends StandardDocumentMetadata {
+    [key: string]: any;
+}
+export interface IKnowledgeDocumentCreateInput extends IKnowledgeDocument, IBasePerTenantAndOrganizationEntityModel {
+}
+export interface IKnowledgeDocumentUpdateInput extends Partial<IKnowledgeDocumentCreateInput> {
+    id?: string;
+}
+export interface IKnowledgeDocumentFindInput extends IBasePerTenantAndOrganizationEntityModel, IKnowledgeDocument {
+}
+export declare function isDocumentSheet(type: string): boolean;
+export declare function isImageType(type: string): boolean;
+export declare function isVideoType(type: string): boolean;
+export declare function isAudioType(type: string): boolean;
+export declare function classificateDocumentCategory(entity: Partial<IKnowledgeDocument>): KBDocumentCategoryEnum;
+/**
+ * System standard Metadata field definition constants
+ * It can be used for rendering, validation, sorting, displaying descriptions, etc.
+ */
+export declare const STANDARD_METADATA_FIELDS: {
+    group: I18nObject;
+    fields: KBMetadataFieldDef[];
+}[];
+export type StandardMetadataFieldKey = typeof STANDARD_METADATA_FIELDS[number]['fields'][number]['key'];

package/src/ai/knowledge-pipeline.d.ts

@@ -0,0 +1,107 @@
+import { I18nObject, IconDefinition } from '../types';
+import { ICopilotModel } from './copilot-model.model';
+import { KnowledgeStructureEnum } from './knowledgebase.model';
+import { IWorkflowNode, WorkflowNodeTypeEnum } from './xpert-workflow.model';
+import { TXpertParameter } from './xpert.model';
+export interface IDocumentNodeProvider {
+    name: string;
+    label: I18nObject;
+    icon?: IconDefinition;
+    description?: I18nObject;
+    helpUrl?: string;
+    configSchema: any;
+}
+/**
+ * Category of document source provider
+ */
+export declare enum DocumentSourceProviderCategoryEnum {
+    /**
+     * Local files uploaded directly to the system
+     */
+    LocalFile = "local-file",
+    /**
+     * Remote file systems, e.g. S3, FTP, etc.
+     */
+    FileSystem = "file-system",
+    /**
+     * Online documents, e.g. public URLs, Google Docs, etc.
+     */
+    OnlineDocument = "online-document",
+    /**
+     * Web crawling from public websites
+     */
+    WebCrawl = "web-crawl",
+    /**
+     * Database connections, e.g. MySQL, PostgreSQL, etc.
+     * @deprecated Planning
+     */
+    Database = "database"
+}
+export interface IDocumentSourceProvider extends IDocumentNodeProvider {
+    category: DocumentSourceProviderCategoryEnum;
+}
+export interface IDocumentProcessorProvider extends IDocumentNodeProvider {
+}
+export interface IDocumentChunkerProvider extends IDocumentNodeProvider {
+}
+export interface IDocumentUnderstandingProvider extends IDocumentNodeProvider {
+}
+/**
+ * Knowledge Pipeline Source Node
+ */
+export interface IWFNSource<T = any> extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.SOURCE;
+    provider: string;
+    parameters?: TXpertParameter[];
+    config: T;
+    integrationId?: string;
+}
+export interface IWFNProcessor extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.PROCESSOR;
+    provider: string;
+    config: any;
+    input: string;
+    integrationId?: string;
+}
+export interface IWFNChunker extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.CHUNKER;
+    provider: string;
+    config: any;
+    input: string;
+}
+export interface IWFNUnderstanding extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.UNDERSTANDING;
+    provider: string;
+    config: any;
+    input: string;
+    visionModel?: ICopilotModel;
+}
+export interface IWFNKnowledgeBase extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.KNOWLEDGE_BASE;
+    /**
+     * @deprecated
+     */
+    structure?: KnowledgeStructureEnum;
+    /**
+     * Documents input variables
+     */
+    inputs?: string[];
+    /**
+     * Embedding model
+     */
+    copilotModel?: ICopilotModel;
+    /**
+     * (optional) Rerank model
+     */
+    rerankModel?: ICopilotModel;
+    /**
+     * (optional) Vision model
+     */
+    visionModel?: ICopilotModel;
+    documents?: string[];
+}
+export declare function genPipelineSourceKey(): string;
+export declare function genPipelineProcessorKey(): string;
+export declare function genPipelineChunkerKey(): string;
+export declare function genPipelineUnderstandingKey(): string;
+export declare function genPipelineKnowledgeBaseKey(): string;

package/src/ai/knowledge-retrieval-log.model.d.ts

@@ -0,0 +1,10 @@
+import { IBasePerTenantAndOrganizationEntityModel } from "../base-entity.model";
+import { IKnowledgebase } from "./knowledgebase.model";
+export interface IKnowledgeRetrievalLog extends IBasePerTenantAndOrganizationEntityModel {
+    query: string;
+    source: string;
+    hitCount: number;
+    requestId: string;
+    knowledgebaseId?: string;
+    knowledgebase?: IKnowledgebase;
+}

package/src/ai/knowledgebase-task.model.d.ts

@@ -0,0 +1,39 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IChatConversation } from './chat.model';
+import { IKnowledgeDocument } from './knowledge-doc.model';
+import { IKnowledgebase } from './knowledgebase.model';
+import { IXpertAgentExecution } from './xpert-agent-execution.model';
+/**
+ * Task executions of a knowledgebase
+ */
+export interface IKnowledgebaseTask extends IBasePerTenantAndOrganizationEntityModel {
+    knowledgebaseId?: string;
+    knowledgebase?: IKnowledgebase;
+    conversationId?: string;
+    conversation?: IChatConversation;
+    executionId?: string;
+    execution?: IXpertAgentExecution;
+    taskType: string;
+    status?: 'pending' | 'running' | 'success' | 'failed' | 'cancelled';
+    steps: TaskStep[];
+    error?: string;
+    /**
+     * Temporary content: Documents not actually processed in the task yet
+     */
+    context?: {
+        documents?: Partial<IKnowledgeDocument>[];
+    };
+    /**
+     * Many to Many of documents in task
+     */
+    documents?: IKnowledgeDocument[];
+}
+export interface TaskStep {
+    name: string;
+    status: 'pending' | 'running' | 'success' | 'failed';
+    progress: number;
+    log?: string;
+    error_message?: string;
+    started_at?: Date;
+    finished_at?: Date;
+}

package/src/ai/knowledgebase.model.d.ts

@@ -0,0 +1,174 @@
+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 { IDocChunkMetadata } from './knowledge-doc-chunk.model';
+/**
+ * Non-internal types should remain the same as IntegrationEnum.
+ */
+export declare enum KnowledgeProviderEnum {
+    Internal = "internal"
+}
+export declare enum KnowledgebaseTypeEnum {
+    Standard = "standard",
+    External = "external"
+}
+export declare 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;
+    rerankModel?: ICopilotModel;
+    rerankModelId?: string;
+    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 declare 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;
+    label?: I18nObject;
+    type: MetadataFieldType;
+    enumValues?: string[];
+    description?: string;
+};
+/**
+ * Channel name for knowledgebase pipeline
+ */
+export declare const KnowledgebaseChannel: string;
+/**
+ * Task ID of a knowledgebase run
+ */
+export declare const KnowledgeTask = "task_id";
+/**
+ * Specify the data source to run
+ */
+export declare const KNOWLEDGE_SOURCES_NAME = "sources";
+export declare const KNOWLEDGE_DOCUMENTS_NAME = "documents";
+export declare const KNOWLEDGE_FOLDER_ID_NAME = "folder_id";
+export declare const KNOWLEDGE_STAGE_NAME = "stage";

package/src/ai/middleware.model.d.ts

@@ -0,0 +1,23 @@
+import { IWorkflowNode, WorkflowNodeTypeEnum } from "./xpert-workflow.model";
+import { I18nObject, IconDefinition } from "../types";
+import { TXpertGraph, TXpertTeamNode } from "./xpert.model";
+import { JsonSchemaObjectType } from "./types";
+export interface IWFNMiddleware extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.MIDDLEWARE;
+    provider: string;
+    options?: Record<string, any>;
+    tools?: Record<string, TMiddlewareToolConfig | boolean>;
+}
+export type TMiddlewareToolConfig = {
+    enabled?: boolean;
+};
+export declare function isMiddlewareToolEnabled(config?: TMiddlewareToolConfig | boolean): boolean;
+export declare function genXpertMiddlewareKey(): string;
+export type TAgentMiddlewareMeta = {
+    name: string;
+    label: I18nObject;
+    icon?: IconDefinition;
+    description?: I18nObject;
+    configSchema?: JsonSchemaObjectType;
+};
+export declare function getAgentMiddlewareNodes(graph: TXpertGraph, agentKey: string): TXpertTeamNode[];

package/src/ai/rag-web.d.ts

@@ -0,0 +1,26 @@
+import { IntegrationEnum } from "../integration.model";
+import { TParameter, TSelectOption } from "../types";
+import { IKnowledgeDocumentPage } from "./knowledge-doc-page.model";
+export declare 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 declare const KDocumentWebTypeOptions: TSelectOption<KDocumentWebTypeEnum>[];

package/src/ai/rag.d.ts

@@ -0,0 +1,24 @@
+export declare 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.d.ts

@@ -0,0 +1,13 @@
+export declare 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/sandbox.d.ts

@@ -0,0 +1,6 @@
+import { I18nObject, IconDefinition } from "../types";
+export type TSandboxProviderMeta = {
+    name: I18nObject;
+    description?: I18nObject;
+    icon: IconDefinition;
+};