@metad/contracts 3.6.0 → 3.6.2

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

@@ -1,11 +1,13 @@
-import { DocumentInterface } from '@langchain/core/documents';
 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 { DocumentMetadata, IKnowledgebase } from './knowledgebase.model';
+import { IKnowledgebase } 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';
 export type DocumentParserConfig = {
     pages?: number[][];
     replaceWhitespace?: boolean;
@@ -15,13 +17,16 @@ export type DocumentParserConfig = {
         [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;
@@ -36,29 +41,28 @@ export type DocumentSheetParserConfig = DocumentParserConfig & {
  * Import Type:
  * - file: local file
  * - web: web document
- * - feishu
- * - wechat
- * - notion
  * ...
  */
-export declare enum KDocumentSourceType {
+export declare enum DocumentTypeEnum {
     /**
-     * Local files
-     */
-    FILE = "file",
-    /**
-     * Remote files (FTP, SFTP, etc.)
-     */
-    REMOTE_FILE = "remote-file",
-    /**
-     * Web documents
+     * Folder, parent of other documents
      */
-    WEB = "web",
+    FOLDER = "folder",
     /**
-     * Folder, parent of other documents
+     * Local files
+     * @deprecated use DocumentSourceProviderCategoryEnum local file type instead
      */
-    FOLDER = "folder"
+    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.
  */
@@ -74,6 +78,10 @@ export declare enum KBDocumentStatusEnum {
     WAITING = "waiting",
     VALIDATE = "validate",
     RUNNING = "running",
+    TRANSFORMED = "transformed",
+    SPLITTED = "splitted",
+    UNDERSTOOD = "understood",
+    EMBEDDING = "embedding",
     CANCEL = "cancel",
     FINISH = "finish",
     ERROR = "error"
@@ -85,7 +93,6 @@ export type TDocSourceConfig = {
 export type TKnowledgeDocument = {
     disabled?: boolean;
     knowledgebaseId?: string;
-    knowledgebase?: IKnowledgebase;
     /**
      * @deprecated use fileUrl instead
      */
@@ -100,13 +107,14 @@ export type TKnowledgeDocument = {
     thumbnail?: string;
     /**
      * default parser ID
+     * @deprecated unused
      */
     parserId: string;
     parserConfig: DocumentTextParserConfig;
     /**
      * where dose this document come from
      */
-    sourceType?: KDocumentSourceType | null;
+    sourceType?: DocumentSourceProviderCategoryEnum | DocumentTypeEnum;
     sourceConfig?: TDocSourceConfig;
     /**
      * document type category
@@ -125,7 +133,13 @@ export type TKnowledgeDocument = {
      */
     filePath: string;
     fileUrl?: string;
-    size: 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;
@@ -146,7 +160,11 @@ export type TKnowledgeDocument = {
     options?: TDocumentWebOptions;
     integrationId?: string;
     integration?: IIntegration;
+    /**
+       * @deprecated use chunks instead
+       */
     pages?: IKnowledgeDocumentPage[];
+    chunks?: IKnowledgeDocumentChunk[];
     tasks?: IKnowledgebaseTask[];
 };
 /**
@@ -155,18 +173,11 @@ export type TKnowledgeDocument = {
 export interface IKnowledgeDocument<T = Metadata> extends TKnowledgeDocument, IBasePerTenantAndOrganizationEntityModel {
     parent?: IKnowledgeDocument | null;
     children?: IKnowledgeDocument[];
-    chunks?: DocumentInterface[];
+    knowledgebase?: IKnowledgebase;
+    draft?: TKnowledgeDocument;
     metadata?: T;
 }
-export interface IDocumentChunk<Metadata = DocumentMetadata> {
-    id: string;
-    pageContent: string;
-    metadata: Metadata & {
-        knowledgeId?: string;
-    };
-    collection_id: string;
-}
-export type Metadata = Record<string, any>;
+export type Metadata = any;
 export interface IKnowledgeDocumentCreateInput extends IKnowledgeDocument, IBasePerTenantAndOrganizationEntityModel {
 }
 export interface IKnowledgeDocumentUpdateInput extends Partial<IKnowledgeDocumentCreateInput> {
@@ -175,3 +186,7 @@ export interface IKnowledgeDocumentUpdateInput extends Partial<IKnowledgeDocumen
 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;

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

@@ -49,11 +49,11 @@ export interface IDocumentUnderstandingProvider extends IDocumentNodeProvider {
 /**
  * Knowledge Pipeline Source Node
  */
-export interface IWFNSource extends IWorkflowNode {
+export interface IWFNSource<T = any> extends IWorkflowNode {
     type: WorkflowNodeTypeEnum.SOURCE;
     provider: string;
     parameters?: TXpertParameter[];
-    config: any;
+    config: T;
     integrationId?: string;
 }
 export interface IWFNProcessor extends IWorkflowNode {
@@ -78,6 +78,9 @@ export interface IWFNUnderstanding extends IWorkflowNode {
 }
 export interface IWFNKnowledgeBase extends IWorkflowNode {
     type: WorkflowNodeTypeEnum.KNOWLEDGE_BASE;
+    /**
+     * @deprecated
+     */
     structure?: KnowledgeStructureEnum;
     /**
      * Documents input variables
@@ -91,6 +94,10 @@ export interface IWFNKnowledgeBase extends IWorkflowNode {
      * (optional) Rerank model
      */
     rerankModel?: ICopilotModel;
+    /**
+     * (optional) Vision model
+     */
+    visionModel?: ICopilotModel;
     documents?: string[];
 }
 export declare function genPipelineSourceKey(): string;

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

@@ -2,6 +2,7 @@ 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
  */
@@ -10,6 +11,8 @@ export interface IKnowledgebaseTask extends IBasePerTenantAndOrganizationEntityM
     knowledgebase?: IKnowledgebase;
     conversationId?: string;
     conversation?: IChatConversation;
+    executionId?: string;
+    execution?: IXpertAgentExecution;
     taskType: string;
     status?: 'pending' | 'running' | 'success' | 'failed' | 'cancelled';
     steps: TaskStep[];

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

@@ -4,6 +4,7 @@ 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.
  */
@@ -80,6 +81,7 @@ export type TKnowledgebase = {
     parserConfig?: KnowledgebaseParserConfig;
     /**
      * Index structure determines how the knowledge base organizes and indexes your document content.
+     * @deprecated
      */
     structure?: KnowledgeStructureEnum;
     /**
@@ -139,7 +141,7 @@ export type TKBRecallParams = {
      */
     weight?: number;
 };
-export type DocumentMetadata = {
+export type DocumentMetadata = IDocChunkMetadata & {
     score?: number;
     relevanceScore?: number;
 } & Record<string, any>;
@@ -154,7 +156,7 @@ export declare const KnowledgeTask = "task_id";
 /**
  * Specify the data source to run
  */
-export declare const KnowledgeSources = "sources";
-export declare const KnowledgeDocuments = "documents";
-export declare const KnowledgeFolderId = "folder_id";
+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/xpert-workflow.model.d.ts

@@ -355,6 +355,7 @@ export interface IWFNTask extends IWorkflowNode {
     descriptionPrefix?: string;
     descriptionSuffix?: string;
 }
+export declare function genXpertTriggerKey(): string;
 export declare function genListOperatorKey(): string;
 export declare function genVariableAggregatorKey(): string;
 export declare function isAgentKey(key: string): boolean;

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

@@ -61,13 +61,34 @@ export type TXpertFeatures = {
     };
 };
 export type TXpert = {
+    /**
+     * Unique slug identifier, generated from name
+     */
     slug: string;
+    /**
+     * Expert name
+     */
     name: string;
+    /**
+     * Expert type
+     */
     type: XpertTypeEnum;
     title?: string;
+    /**
+     * @deprecated use title
+     */
     titleCN?: string;
+    /**
+     * Expert description
+     */
     description?: string;
+    /**
+     * Is active
+     */
     active?: boolean;
+    /**
+     * Avatar Object
+     */
     avatar?: TAvatar;
     /**
      * Conversation starters
@@ -103,15 +124,20 @@ export type TXpert = {
      */
     releaseNotes?: string;
     /**
-     * Draft on current version
      * Draft on current version
      */
     draft?: TXpertTeamDraft;
+    /**
+     * Published graph
+     */
     graph?: TXpertGraph;
     api?: TChatApi;
     app?: TChatApp;
     userId?: string;
     user?: IUser;
+    /**
+     * Primary agent for this expert
+     */
     agent?: IXpertAgent;
     copilotModel?: ICopilotModel;
     copilotModelId?: string;
@@ -460,7 +486,13 @@ export type TChatRequest = {
 };
 export type TChatOptions = {
     conversationId?: string;
+    /**
+     * @deprecated
+     */
     knowledgebases?: string[];
+    /**
+     * @deprecated
+     */
     toolsets?: string[];
     /**
      * The language used by the current browser page

package/src/analytics/data-source.d.ts

@@ -48,7 +48,7 @@ export interface IColumnDef {
     /**
      * Types in javascript
      */
-    type: 'number' | 'string' | 'boolean';
+    type: 'number' | 'string' | 'boolean' | 'object' | 'timestamp';
     /**
      * Original data type in database
      */

package/src/integration.model.d.ts

@@ -11,7 +11,7 @@ export interface IIntegration<T = any> extends IBasePerTenantAndOrganizationEnti
      */
     avatar?: TAvatar;
     slug: string;
-    provider: IntegrationEnum;
+    provider: string | IntegrationEnum;
     /**
      * Integration features: ['knowledge', 'agent', ...]
      */
@@ -81,6 +81,10 @@ export type TIntegrationProvider = {
     schema?: TParameterSchema;
     features?: IntegrationFeatureEnum[];
     helpUrl?: string;
-    webhookUrl?: (integration: IIntegration, baseUrl: string) => string;
+    /**
+     * Webhook URL generator, for example:
+     * `{{apiBaseUrl}}/api/integration/webhook/{{integrationId}}`
+     */
+    webhookUrl?: string;
     pro?: boolean;
 };

package/src/password-reset.model.d.ts

@@ -1,10 +1,10 @@
-import { IBaseEntityModel } from './base-entity.model';
-export interface IPasswordReset extends IBaseEntityModel {
+import { IBasePerTenantEntityModel } from './base-entity.model';
+export interface IPasswordReset extends IBasePerTenantEntityModel {
     email: string;
     token: string;
     expired?: boolean;
 }
-export interface IPasswordResetFindInput extends IBaseEntityModel {
+export interface IPasswordResetFindInput extends IBasePerTenantEntityModel {
     email?: string;
     token?: string;
 }

package/src/plugin.d.ts

@@ -4,7 +4,7 @@ export interface PluginMeta {
     name: PluginName;
     version: string;
     icon?: IconDefinition;
-    category: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration';
+    category: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration' | 'datasource';
     displayName: string;
     description: string;
     keywords?: string[];

package/src/types.d.ts

@@ -116,6 +116,7 @@ export interface ISize {
 export type _TFile = {
     filePath: string;
     fileUrl?: string;
+    mimeType?: string;
     /**
      * @deprecated use fileUrl instead
      */

package/src/user.model.d.ts

@@ -40,6 +40,9 @@ export interface IEmailVerification extends IBasePerTenantEntityModel {
     user?: IUser;
     validUntil: Date;
 }
+export interface IUserEmailInput {
+    email: string;
+}
 export interface IUserFindInput {
     thirdPartyId?: string;
     firstName?: string;