@metad/contracts 3.6.2 → 3.7.0

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

@@ -11,10 +11,10 @@ import { IXpertToolset } from './xpert-toolset.model';
 import { IBasePerWorkspaceEntityModel } from './xpert-workspace.model';
 import { IIntegration } from '../integration.model';
 import { TChatFrom, TSensitiveOperation } from './chat.model';
-import { IWorkflowNode, TVariableAssigner, VariableOperationEnum } from './xpert-workflow.model';
+import { IWorkflowNode, TVariableAssigner, TWFCase, VariableOperationEnum } from './xpert-workflow.model';
 import { IEnvironment } from './environment.model';
 import { IStorageFile } from '../storage-file.model';
-import { STATE_VARIABLE_HUMAN, TInterruptCommand } from '../agent';
+import { STATE_VARIABLE_HUMAN, TInterruptCommand } from '../agent/graph';
 export type ToolCall = LToolCall;
 export declare enum XpertTypeEnum {
     /**
@@ -237,9 +237,13 @@ export type TXpertAgentConfig = {
      */
     mute?: string[][];
     /**
-     * Recall params
+     * Recall knowledge params
      */
     recalls?: Record<string, TKBRecallParams>;
+    /**
+     * Retrieval params for every knowledgebase
+     */
+    retrievals?: Record<string, TKBRetrievalSettings>;
     /**
      * Summarize the title of the conversation
      */
@@ -329,7 +333,9 @@ export declare enum XpertParameterTypeEnum {
     NUMBER = "number",
     OBJECT = "object",
     SELECT = "select",
+    FILE = "file",
     ARRAY_STRING = "array[string]",
+    ARRAY_NUMBER = "array[number]",
     ARRAY = "array[object]",
     ARRAY_FILE = "array[file]",
     ARRAY_DOCUMENT = "array[document]",
@@ -527,3 +533,19 @@ export type TChatOptions = {
      */
     tools?: (StructuredToolInterface | RunnableToolLike)[];
 };
+/**
+ * Knowledgebase retrieval settings
+ */
+export type TKBRetrievalSettings = {
+    metadata: {
+        filtering_mode: "disabled" | "automatic" | "manual";
+        /**
+         * Conditions (filter) when mode is manual
+         */
+        filtering_conditions: TWFCase;
+        /**
+         * Parameter fields (tool call) when mode is automatic
+         */
+        fields: Record<string, object>;
+    };
+};

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

@@ -3,8 +3,6 @@ import { IXpertAgent } from './xpert-agent.model';
 import { IXpert, TXpertTeamNode } from './xpert.model';
 export declare function omitXpertRelations(xpert: Partial<IXpert>): {
     environmentId?: string;
-    environment?: import("./environment.model").IEnvironment;
-    knowledgebase?: import("./knowledgebase.model").IKnowledgebase;
     workspaceId?: string;
     workspace?: import("./xpert-workspace.model").IXpertWorkspace;
     publishAt?: Date;
@@ -44,7 +42,6 @@ export declare function omitXpertRelations(xpert: Partial<IXpert>): {
     user?: import("..").IUser;
     copilotModel?: import("./copilot-model.model").ICopilotModel;
     copilotModelId?: string;
-    integrations?: import("..").IIntegration<any>[];
     tags?: import("..").ITag[];
 };
 export declare function figureOutXpert(xpert: IXpert, isDraft: boolean): Partial<IXpert>;

package/src/analytics/gateway.d.ts

@@ -3,6 +3,7 @@ export type TGatewayQueryEvent = {
     id: string;
     organizationId: string;
     dataSourceId: string;
+    tenantId?: string;
     modelId?: string;
     isDraft: boolean;
     body: {

package/src/analytics/indicator.d.ts

@@ -47,6 +47,10 @@ export type TIndicator = {
     };
     businessAreaId?: string;
 };
+/**
+ * Fields included in the draft of Indicator, please keep it in sync with TIndicator type
+ */
+export declare const IndicatorDraftFields: Array<keyof IIndicator>;
 export type TIndicatorDraft = TIndicator & {
     checklist?: ChecklistItem[];
     version?: number;
@@ -54,12 +58,6 @@ export type TIndicatorDraft = TIndicator & {
 };
 export interface IIndicator extends IBasePerProjectEntityModel, TIndicator {
     draft?: TIndicatorDraft;
-    /**
-     * Is active: Activate / Deactivate
-     *
-     * @deprecated use status instead
-     */
-    isActive?: boolean;
     /**
      * Visibilty in public or secret or private
      */
@@ -72,6 +70,7 @@ export interface IIndicator extends IBasePerProjectEntityModel, TIndicator {
     status?: IndicatorStatusEnum;
     embeddingStatus?: EmbeddingStatusEnum;
     error?: string;
+    publishedAt?: Date;
     businessArea?: IBusinessArea;
     permissionApprovals?: IPermissionApproval[];
     tags?: ITag[];

package/src/analytics/semantic-model-entity.d.ts

@@ -20,6 +20,7 @@ export type SemanticModelEntityJob = {
     error?: string;
     createdAt?: Date;
     endAt?: Date;
+    tokens?: number;
 };
 export interface ISemanticModelEntity extends IBasePerTenantAndOrganizationEntityModel {
     name?: string;

package/src/analytics/semantic-model-member.d.ts

@@ -19,6 +19,9 @@ export interface ISemanticModelMember extends IBasePerTenantAndOrganizationEntit
     memberType: number;
     levelNumber: number;
     parentUniqueName: string;
+    metadata?: {
+        tokens: number;
+    };
     vector?: boolean;
 }
 export declare function embeddingCubeCollectionName(modelKey: string, cube: string, isDraft?: boolean): string;

package/src/analytics/semantic-model.d.ts

@@ -160,6 +160,14 @@ export declare enum SemanticModelStatusEnum {
      */
     Archived = "archived"
 }
+export interface ISemanticModelCache extends IBasePerTenantAndOrganizationEntityModel {
+    key: string;
+    language?: string;
+    modelId?: string;
+    model?: ISemanticModel;
+    query?: string;
+    data?: string;
+}
 /**
  * @deprecated Equivalent to `VirtualCube` in the ocap framework
  */

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' | 'datasource';
+    category: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration' | 'datasource' | 'database' | 'middleware';
     displayName: string;
     description: string;
     keywords?: string[];

package/src/types.d.ts

@@ -1,5 +1,6 @@
-import ShortUniqueId from 'short-unique-id';
-export declare const uuid: ShortUniqueId;
+import type * as z3 from "zod/v3";
+import type * as z4 from "zod/v4/core";
+export declare const uuid: (uuidLength?: number) => string;
 /**
  * @description
  * An entity ID. Represents a unique identifier as a string.
@@ -239,3 +240,6 @@ export interface IconDefinition {
      */
     style?: Record<string, string>;
 }
+export type ZodObjectV3 = z3.ZodObject<any, any, any, any>;
+export type ZodObjectV4 = z4.$ZodObject;
+export type InteropZodObject = ZodObjectV3 | ZodObjectV4;