@metad/contracts 3.6.7 → 3.7.0

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/skill.model.d.ts

@@ -0,0 +1,181 @@
+import { IBasePerTenantAndOrganizationEntityModel } from "../base-entity.model";
+import { I18nObject, IconDefinition } from "../types";
+import { JsonSchemaObjectType } from "./types";
+import { IWorkflowNode, WorkflowNodeTypeEnum } from "./xpert-workflow.model";
+import { IBasePerWorkspaceEntityModel } from "./xpert-workspace.model";
+export type SkillId = string;
+export interface SkillMetadata {
+    name: string;
+    displayName?: I18nObject;
+    version: string;
+    summary?: I18nObject;
+    description?: I18nObject;
+    tags?: string[];
+    author?: {
+        name: string;
+        email?: string;
+        org?: string;
+    };
+    license?: string;
+    visibility: 'private' | 'team' | 'tenant' | 'public';
+    categories?: string[];
+    runtime?: {
+        entry?: string;
+        language?: 'js' | 'py' | 'bash';
+        permissions?: string[];
+        tools?: string[];
+    };
+    mcp?: {
+        servers?: string[];
+    };
+}
+export interface SkillResourcesIndex {
+    files: Array<{
+        path: string;
+        kind: 'script' | 'template' | 'doc' | 'asset';
+        hash: string;
+        size: number;
+    }>;
+    chunks?: Array<{
+        id: string;
+        path: string;
+        summary: string;
+        tokens: number;
+    }>;
+}
+export interface TSkillPackage {
+    metadata: SkillMetadata;
+    instructions: {
+        system?: string;
+        developer?: string;
+        examples?: Array<{
+            user: string;
+            assistant: string;
+        }>;
+        guidelines?: string[];
+    };
+    resources?: SkillResourcesIndex;
+    abac?: {
+        owners: string[];
+        readers: string[];
+        writers: string[];
+        policies?: any;
+    };
+    signatures?: string[];
+    provenance?: any;
+}
+/**
+ * 表示一个仓库（如 anthropics/skills）
+ */
+export interface ISkillRepository<O = Record<string, any>, C = Record<string, any>> extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    provider: string;
+    /**
+     * Provider credentials such as GitHub tokens
+     */
+    credentials?: C;
+    /**
+     * Options configured using the strategy's configSchema
+     */
+    options?: O;
+    lastSyncAt?: string;
+    deletedAt?: Date;
+}
+/**
+ * 仓库同步扫描得到的技能索引（每个技能目录一条）
+ */
+export interface ISkillRepositoryIndex extends IBasePerTenantAndOrganizationEntityModel {
+    repositoryId: string;
+    repository?: ISkillRepository;
+    skillPath: string;
+    skillId: string;
+    name?: string;
+    description?: string;
+    license?: string;
+    tags?: string[];
+    version?: string;
+    resources?: any[];
+    deletedAt?: Date;
+}
+/**
+ * 安装后的技能包主记录（skill.yaml）
+ */
+export interface ISkillPackage extends IBasePerWorkspaceEntityModel, TSkillPackage {
+    skillIndexId?: SkillId;
+    skillIndex?: ISkillRepositoryIndex;
+    name?: any;
+    visibility: 'private' | 'team' | 'tenant';
+    packagePath?: string;
+}
+/**
+ * 技能的版本（1个 Skill 多版本共存）
+ */
+export interface ISkillVersion extends IBasePerWorkspaceEntityModel {
+    packageId: string;
+    version: string;
+    metadata: any;
+    instructions: any;
+    installedAt?: string;
+}
+/**
+ * 技能资源文件（scripts/templates/assets）记录
+ */
+export interface ISkillResource extends IBasePerWorkspaceEntityModel {
+    versionId: string;
+    path: string;
+    type: 'script' | 'template' | 'asset' | 'doc';
+    hash?: string;
+    size?: number;
+    meta?: any;
+}
+/**
+ * 租户/组织/团队/用户安装行为记录
+ */
+export interface ISkillInstallation extends IBasePerTenantAndOrganizationEntityModel {
+    versionId: string;
+    installedBy: string;
+    visibility: 'private' | 'team' | 'tenant';
+    targetScope?: string;
+    status: 'pending' | 'installed' | 'failed';
+}
+/**
+ * 技能安装过程中详细日志
+ */
+export interface ISkillInstallLog extends IBasePerTenantAndOrganizationEntityModel {
+    installationId: string;
+    level: 'info' | 'warn' | 'error';
+    message: string;
+    timestamp: string;
+}
+/**
+ * 技能运行期审计日志
+ */
+export interface ISkillAuditLog extends IBasePerTenantAndOrganizationEntityModel {
+    skillId: string;
+    versionId: string;
+    sessionId: string;
+    eventType: string;
+    metadata: any;
+}
+export type TSkillSourceMeta = {
+    /**
+     * Provider name, e.g. github / git / zip / marketplace
+     */
+    name: string;
+    label: I18nObject;
+    icon?: IconDefinition;
+    description?: I18nObject;
+    /**
+     * Optional configuration schema for frontend forms
+     */
+    configSchema?: JsonSchemaObjectType;
+    /**
+     * Credential schema for source authentication
+     */
+    credentialSchema?: JsonSchemaObjectType;
+};
+export interface IWFNSkill extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.SKILL;
+    skills?: string[];
+}
+export declare function genXpertSkillKey(): string;

package/src/ai/types.d.ts

@@ -0,0 +1,71 @@
+import { JsonSchema7TypeUnion } from "zod-to-json-schema";
+import { I18nObject, 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 declare 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 declare enum EmbeddingStatusEnum {
+    PROCESSING = "processing",
+    SUCCESS = "success",
+    FAILED = "failed",
+    REQUIRED = "required"
+}
+export declare const Attachment_Type_Options: TSelectOption<string, TXpertAttachmentType>[];
+type JsonSchema7Meta = {
+    title?: I18nObject;
+    default?: any;
+    description?: I18nObject;
+    markdownDescription?: I18nObject;
+    /**
+     * UI schema extensions
+     */
+    'x-ui'?: {
+        /**
+         * UI component variant, or custom component name
+         */
+        component?: 'textarea' | 'select' | 'radio' | 'checkbox' | 'switch' | 'password' | string;
+        /**
+         * UI component display span (for grid layouts)
+         */
+        span?: number;
+        /**
+         * Additional inputs for the Custom UI component
+         */
+        inputs?: Record<string, unknown>;
+    };
+};
+export type JsonSchemaObjectType = {
+    type: "object";
+    properties: Record<string, JsonSchema7Type>;
+    additionalProperties?: boolean | JsonSchema7Type;
+    required?: string[];
+};
+type JsonSchema7Type = (JsonSchema7TypeUnion | JsonSchemaObjectType) & JsonSchema7Meta;
+export {};

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

@@ -0,0 +1,96 @@
+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;
+    threadId?: string;
+    checkpointNs?: string;
+    checkpointId?: string;
+    channelName?: string;
+    parent_thread_id?: string;
+    /**
+     * Include workflow node key
+     */
+    agentKey?: string;
+    predecessor?: string;
+    xpert?: IXpert;
+    xpertId?: string;
+    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;
+    totalPrice?: number;
+    currency?: string;
+    inputTokens?: number;
+    inputUnitPrice?: number;
+    inputPriceUnit?: number;
+    outputTokens?: number;
+    outputUnitPrice?: number;
+    outputPriceUnit?: number;
+    /**
+     * Latest operation when interrupted
+     */
+    operation?: TSensitiveOperation;
+    messages?: StoredMessage[];
+    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[];
+    runningExecution?: IXpertAgentExecution;
+}
+/**
+ * Corresponds to the status of Run in [Agent Protocol](https://github.com/langchain-ai/agent-protocol).
+ */
+export declare 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;
+};

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

@@ -0,0 +1,204 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { ICopilotModel, TCopilotModel } from './copilot-model.model';
+import { IKnowledgebase, TKBRecallParams } from './knowledgebase.model';
+import { I18nObject, TAvatar } from '../types';
+import { IXpertToolset } from './xpert-toolset.model';
+import { IXpert, TXpertParameter } from './xpert.model';
+import { TVariableAssigner } from './xpert-workflow.model';
+import { TErrorHandling } from './types';
+import { TInterruptCommand } from '../agent';
+export type TXpertAgent = {
+    key: string;
+    name?: string;
+    title?: string;
+    description?: string;
+    avatar?: TAvatar;
+    /**
+     * System prompt
+     */
+    prompt?: string;
+    /**
+     * Prompt templates (ai or human)
+     */
+    promptTemplates?: TAgentPromptTemplate[];
+    /**
+     * Input parameters for agent
+     */
+    parameters?: TXpertParameter[];
+    /**
+     * Output variables of agent
+     */
+    outputVariables?: TAgentOutputVariable[];
+    /**
+     * More configuration
+     */
+    options?: TXpertAgentOptions;
+    /**
+     * This is the xpert's primary agent
+     */
+    xpert?: IXpert;
+    xpertId?: string;
+    /**
+     * Copilot model of this agent
+     */
+    copilotModel?: ICopilotModel;
+    copilotModelId?: string;
+    /**
+     * This is one of the xpert team's agent
+     */
+    team?: IXpert;
+    teamId?: string;
+    /**
+     * My leader in xpert team
+     */
+    leader?: IXpertAgent;
+    leaderKey?: string;
+    /**
+     * I am the leader of followers in xpert's team
+     */
+    followers?: IXpertAgent[];
+    /**
+     * External xpert teams
+     */
+    collaborators?: IXpert[];
+    collaboratorNames?: string[];
+    /**
+     * I used toolsets
+     */
+    toolsets?: IXpertToolset[];
+    toolsetIds?: string[];
+    /**
+     * I used knowledgebases
+     */
+    knowledgebases?: IKnowledgebase[];
+    knowledgebaseIds?: string[];
+};
+/**
+ * Expert agent, ai agent for the xperts.
+ */
+export interface IXpertAgent extends IBasePerTenantAndOrganizationEntityModel, TXpertAgent {
+}
+export type TXpertAgentOptions = {
+    /**
+     * Hide this agent node in the graph
+     */
+    hidden?: boolean;
+    /**
+     * Disable message history for agent conversation
+     */
+    disableMessageHistory?: boolean;
+    /**
+     * The variable of message history to use
+     */
+    historyVariable?: string;
+    /**
+     * Write output variables to memory (state)
+     */
+    memories?: TVariableAssigner[];
+    /**
+     * Whether to enable parallel tool calls, default: true
+     */
+    parallelToolCalls?: boolean;
+    /**
+     * Retry on failure
+     */
+    retry?: {
+        enabled?: boolean;
+        stopAfterAttempt?: number;
+    };
+    /**
+     * Fallback model
+     */
+    fallback?: {
+        enabled?: boolean;
+        copilotModel?: TCopilotModel;
+    };
+    /**
+     * Error handling
+     */
+    errorHandling?: TErrorHandling;
+    /**
+     * Recall params for kbs
+     */
+    recall?: TKBRecallParams;
+    /**
+     * Available tools
+     */
+    availableTools?: Record<string, string[]>;
+    /**
+     * Options for tools of agent
+     */
+    tools?: Record<string, {
+        timeout?: number;
+    }>;
+    /**
+     * How to achieve structured output (`StructuredOutputMethodOptions['method']`)
+     * - *functionCalling*
+     * - *jsonMode*
+     * - *jsonSchema*
+     *
+     */
+    structuredOutputMethod?: "functionCalling" | "jsonMode" | "jsonSchema" | string;
+    /**
+     * Vision config of agent
+     */
+    vision?: {
+        enabled?: boolean;
+        /**
+         * Variable name that store the list of files to be understood
+         */
+        variable?: string;
+        /**
+         * Image resolution for vision tasks
+         */
+        resolution?: 'high' | 'low';
+    };
+    /**
+     * Config of middlewares for agent
+     */
+    middlewares?: {
+        order: string[];
+    };
+};
+export type TAgentPromptTemplate = {
+    id: string;
+    role: 'ai' | 'human';
+    text: string;
+};
+export type TAgentOutputVariable = TXpertParameter & {
+    /**
+       * value write to state's variable
+       */
+    variableSelector: string;
+    /**
+     * How to write value to variable
+     */
+    operation: 'append' | 'extends' | 'overwrite' | 'clear';
+};
+/**
+ * @deprecated use TChatRequest
+ */
+export type TChatAgentParams = {
+    input: {
+        input?: string;
+        [key: string]: unknown;
+    };
+    agentKey: string;
+    xpertId: string;
+    executionId?: string;
+    environmentId?: string;
+    /**
+     */
+    command?: TInterruptCommand;
+    /**
+     * Reject the sensitive tool calls
+     */
+    reject?: boolean;
+};
+export declare function agentLabel(agent: Partial<IXpertAgent>): string;
+export declare function agentUniqueName(agent: IXpertAgent): string;
+export declare function convertToUrlPath(title: string): string;
+export declare const VariableOperations: {
+    value: TAgentOutputVariable['operation'];
+    label: I18nObject;
+}[];

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

@@ -0,0 +1,86 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IIntegration } from '../integration.model';
+import { IStorageFile, TFile } from '../storage-file.model';
+import { TAvatar } from '../types';
+import { IUser } from '../user.model';
+import { ICopilotModel } from './copilot-model.model';
+import { IKnowledgebase } from './knowledgebase.model';
+import { IXpertToolset } from './xpert-toolset.model';
+import { IXpertWorkspace } from './xpert-workspace.model';
+import { IXpert, TXpertTeamDraft } from './xpert.model';
+export type TXpertProjectSettings = {
+    instruction: string;
+    mode?: '' | 'plan';
+};
+export type TXpertProjectStatus = 'active' | 'deprecated' | 'archived';
+export type TXpertProject = {
+    name: string;
+    avatar?: TAvatar;
+    description?: string;
+    status: TXpertProjectStatus;
+    settings?: TXpertProjectSettings;
+    copilotModel?: ICopilotModel;
+    copilotModelId?: string;
+    vcsId?: string;
+};
+/**
+ * Expert Project
+ */
+export interface IXpertProject extends TXpertProject, IBasePerTenantAndOrganizationEntityModel {
+    workspaceId?: string;
+    workspace?: IXpertWorkspace;
+    ownerId: string;
+    owner?: IUser;
+    xperts?: IXpert[];
+    toolsets?: IXpertToolset[];
+    knowledges?: IKnowledgebase[];
+    members?: IUser[];
+    /**
+     * @deprecated Use *file volume* instead
+     */
+    files?: IXpertProjectFile[];
+    attachments?: IStorageFile[];
+    vcs?: IXpertProjectVCS;
+}
+export interface IBasePerXpertProjectEntityModel extends IBasePerTenantAndOrganizationEntityModel {
+    projectId?: string;
+    project?: IXpertProject;
+}
+export interface IXpertProjectTask extends IBasePerXpertProjectEntityModel {
+    threadId?: string;
+    name: string;
+    type?: string;
+    status: 'pending' | 'in_progress' | 'completed' | 'failed';
+    steps: IXpertProjectTaskStep[];
+}
+export interface IXpertProjectTaskStep extends IBasePerXpertProjectEntityModel {
+    taskId: string;
+    stepIndex: number;
+    description: string;
+    notes: string;
+    status: 'pending' | 'running' | 'done' | 'failed';
+}
+export interface IXpertProjectTaskLog extends IBasePerXpertProjectEntityModel {
+    stepId: string;
+    logType: 'input' | 'output' | 'error';
+    content: string;
+}
+export interface IXpertProjectVCS extends IBasePerXpertProjectEntityModel {
+    integrationId?: string;
+    integration?: IIntegration;
+    auth?: {
+        token_type?: string;
+        access_token?: string;
+        state?: string;
+    };
+    installationId?: number | string;
+    repository?: string;
+}
+/**
+ * @deprecated Use `attachments`
+ */
+export interface IXpertProjectFile extends IBasePerXpertProjectEntityModel, Omit<TFile, 'createdAt'> {
+}
+export type TXpertProjectDSL = IXpertProject & {
+    xperts?: TXpertTeamDraft[];
+};