@metad/contracts 3.6.7 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metad/contracts",
-  "version": "3.6.7",
+  "version": "3.7.0",
   "license": "AGPL-3.0",
   "repository": {
     "type": "git",

package/src/agent/{ai-model.ts → ai-model.d.ts}

@@ -1,4 +1,4 @@
-export enum AiModelTypeEnum {
+export declare enum AiModelTypeEnum {
     LLM = "llm",
     TEXT_EMBEDDING = "text-embedding",
     RERANK = "rerank",
@@ -6,4 +6,4 @@ export enum AiModelTypeEnum {
     MODERATION = "moderation",
     TTS = "tts",
     TEXT2IMG = "text2img"
-}
+}

package/src/agent/graph.d.ts

@@ -0,0 +1,151 @@
+import { BaseMessage } from '@langchain/core/messages';
+import { RunnableConfig } from '@langchain/core/runnables';
+import { Subscriber } from 'rxjs';
+import { TWorkflowVarGroup } from '../ai/xpert-workflow.model';
+import { TMessageContentComplex } from '../ai/chat-message.model';
+import { I18nObject } from '../types';
+import { TXpertGraph, TXpertTeamNode } from '../ai/xpert.model';
+/**
+ * @deprecated can use getCurrentTaskInput instead?
+ */
+export declare const CONTEXT_VARIABLE_CURRENTSTATE = "currentState";
+export declare const STATE_VARIABLE_SYS = "sys";
+export declare const STATE_VARIABLE_HUMAN = "human";
+export declare const GRAPH_NODE_SUMMARIZE_CONVERSATION = "summarize_conversation";
+export declare const GRAPH_NODE_TITLE_CONVERSATION = "title_conversation";
+export declare const STATE_VARIABLE_FILES = "files";
+export declare const STATE_VARIABLE_INPUT = "input";
+export declare const STATE_SYS_VOLUME = "volume";
+export declare const STATE_SYS_WORKSPACE_PATH = "workspace_path";
+export declare const STATE_SYS_WORKSPACE_URL = "workspace_url";
+export declare const STATE_VARIABLE_TITLE_CHANNEL: string;
+export type TMessageChannel = {
+    system: string;
+    messages: BaseMessage[];
+    summary?: string;
+    error?: string | null;
+};
+export type TAgentRunnableConfigurable = {
+    /**
+     * Thread id
+     */
+    thread_id: string;
+    checkpoint_ns: string;
+    checkpoint_id: string;
+    tool_call_id?: string;
+    tenantId: string;
+    organizationId: string;
+    language: string;
+    userId: string;
+    /**
+     * Xpert project id
+     */
+    projectId?: string;
+    xpertId?: string;
+    agentKey: string;
+    xpertName?: string;
+    toolName?: string;
+    subscriber: Subscriber<any>;
+    /**
+     * Execution id of agent workflow node
+     */
+    executionId: string;
+    signal?: AbortSignal;
+};
+export type TToolCall = {
+    id?: string;
+    name: string;
+    type?: 'tool_call';
+    args: Record<string, any>;
+};
+/**
+ *
+ * Example:
+ *
+ * ```typescript
+ *  const result = interrupt<TInterruptMessage<{ name: string }>, { projectId: string }>({
+ *		category: 'BI',
+ *		type: 'switch_project',
+ *		title: {
+ *			en_US: 'Switch project',
+ *			zh_Hans: '切换项目'
+ *		},
+ *		message: {
+ *			en_US: 'Please select a project or create a new one',
+ *			zh_Hans: '请选择或创建一个新的项目'
+ *		},
+ *		data: { name: '' }
+ *	})
+ * ```
+ */
+export type TInterruptMessage<T = unknown> = {
+    /**
+     * Major categories of interrupt components
+     */
+    category: 'BI';
+    /**
+     * The specific type of interactive component
+     */
+    type: string;
+    /**
+     * Title of the interrupt component
+     */
+    title: string | I18nObject;
+    /**
+     * Message content of the interrupt component
+     */
+    message: string | I18nObject;
+    /**
+     * Additional data
+     */
+    data?: T;
+};
+export type TInterruptCommand = {
+    resume?: any;
+    update?: any;
+    toolCalls?: TToolCall[];
+    agentKey?: string;
+};
+export declare function channelName(name: string): string;
+export declare function messageContentText(content: string | TMessageContentComplex): any;
+export declare function getWorkspaceFromRunnable(configurable: TAgentRunnableConfigurable): {
+    type?: 'project' | 'conversation';
+    id?: string;
+};
+export declare function getToolCallFromConfig(config: any): TToolCall;
+export declare function getToolCallIdFromConfig(config: any): string;
+/**
+ * Compute long-term memory namespace:
+ * 1. When a user talks to a digital expert individually, use `ExpertId` + `UserId` to store memory
+ * 2. When talking to a digital expert in a project, all users and digital experts share `ProjectId` to store memory
+ *
+ * @param config
+ * @returns
+ */
+export declare function getStoreNamespace(config: RunnableConfig): string[];
+export declare function configurableStoreNamespace(configurable: Partial<TAgentRunnableConfigurable>): string[];
+/**
+ * Set value into variable of state.
+ *
+ * @param state
+ * @param varName
+ * @param value
+ * @returns
+ */
+export declare function setStateVariable(state: Record<string, any>, varName: string, value: any): Record<string, any>;
+/**
+ * Get agent variable group from graph.
+ *
+ * @param key
+ * @param graph
+ * @returns
+ */
+export declare function getAgentVarGroup(key: string, graph: TXpertGraph): TWorkflowVarGroup;
+/**
+ * Get swarm partners of agent in team
+ *
+ * @param graph
+ * @param agentKey
+ */
+export declare function getSwarmPartners(graph: TXpertGraph, agentKey: string, partners: string[], leaderKey?: string): string[];
+export declare function getWorkflowTriggers(graph: TXpertGraph, from: string): TXpertTeamNode[];

package/src/agent/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ai-model';
+export * from './token';
+export * from './graph';
+export * from './utils';
+export * from './variables';

package/src/agent/token.d.ts

@@ -0,0 +1,21 @@
+export type TTokenUsage = {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+};
+export interface IModelUsage {
+    totalTokens: number;
+    totalPrice: number;
+    currency: string;
+    latency: number;
+}
+export interface ILLMUsage extends IModelUsage {
+    promptTokens: number;
+    promptUnitPrice: number;
+    promptPriceUnit: number;
+    promptPrice: number;
+    completionTokens: number;
+    completionUnitPrice: number;
+    completionPriceUnit: number;
+    completionPrice: number;
+}

package/src/agent/utils.d.ts

@@ -0,0 +1,19 @@
+import { TXpertGraph } from '../ai/xpert.model';
+import { DeepPartial } from '../types';
+/**
+ * Channels of all upstream and downstream nodes relative to the starting point startKey.
+ *
+ * @param graph
+ * @param startKey
+ */
+export declare function allChannels(graph: TXpertGraph, startKey: string): string[];
+export declare function findStartNodes(graph: DeepPartial<TXpertGraph>, key: string): string[];
+/**
+ * Keep the content in the same graph as the key node (including the node, its connected nodes, and the 'edge' type connections between them)
+ *
+ * @param graph
+ * @param key
+ * @returns
+ */
+export declare function getCurrentGraph(graph: TXpertGraph, key: string): TXpertGraph;
+export declare function shortTitle(input: string): string;

package/src/agent/variables.d.ts

@@ -0,0 +1,16 @@
+import { TWorkflowVarGroup } from "../ai/xpert-workflow.model";
+import { TXpertParameter } from "../ai/xpert.model";
+/**
+ *
+ * Returns the variable schema for a given variable name.
+ * The variable name can be in the format of 'groupName.variableName' or just 'variableName'.
+ *
+ * @param variables
+ * @param variable
+ * @returns
+ */
+export declare function getVariableSchema(variables: TWorkflowVarGroup[], variable: string): {
+    group: TWorkflowVarGroup;
+    variable: import("../ai/xpert.model").TStateVariable;
+};
+export declare const FILE_VARIABLES: TXpertParameter[];

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

@@ -0,0 +1,198 @@
+import { AiModelTypeEnum } from '../agent/';
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { I18nObject } from '../types';
+import { ICopilot } from './copilot.model';
+export interface IAiModel extends IBasePerTenantAndOrganizationEntityModel {
+    /**
+     * Model name
+     */
+    name: string;
+    /**
+     * Model display name
+     */
+    label: string;
+    /**
+     * Model type
+     */
+    modelType: string;
+    /**
+     * Model features
+     */
+    features: string[];
+    /**
+     * Model properties
+     */
+    modelProperties: Record<string, any>;
+    /**
+     * Parameter rules
+     */
+    parameterRules: Record<string, any>[];
+    /**
+     * Pricing information
+     */
+    pricing: {
+        input: string;
+        output: string;
+        unit: string;
+        currency: string;
+    };
+    /**
+     * Deprecated
+     */
+    deprecated: boolean;
+}
+export declare enum ProviderType {
+    CUSTOM = "custom",
+    SYSTEM = "system"
+}
+export interface ICopilotWithProvider extends ICopilot {
+    providerWithModels: Partial<IAiProviderEntity>;
+}
+export interface IAiProviderEntity {
+    provider: string;
+    label: I18nObject;
+    description: I18nObject;
+    icon_small: I18nObject;
+    icon_large: I18nObject;
+    background: string;
+    help: ProviderHelpInfo;
+    supported_model_types: AiModelTypeEnum[];
+    configurate_methods: ConfigurateMethod[];
+    model_credential_schema: ModelCredentialSchema;
+    provider_credential_schema: ProviderCredentialSchema;
+    models: ProviderModel[];
+    /**
+     * Not yet implemented, your contribution is needed
+     */
+    not_implemented?: boolean;
+}
+export interface ProviderHelpInfo {
+    title: I18nObject;
+    url: I18nObject;
+}
+export interface ProviderModel {
+    model: string;
+    label: I18nObject;
+    model_type: AiModelTypeEnum;
+    features?: ModelFeature[];
+    fetch_from: FetchFrom;
+    model_properties: Partial<Record<ModelPropertyKey, any>>;
+    deprecated?: boolean;
+    modelConfig?: any;
+}
+export interface ProviderCredentialSchema {
+    credential_form_schemas: CredentialFormSchema[];
+}
+/**
+ * @todo Use JSON Schema to implement
+ */
+export declare enum CredentialFormTypeEnum {
+    TEXT_INPUT = "text-input",
+    SECRET_INPUT = "secret-input",
+    SELECT = "select",
+    RADIO = "radio"
+}
+export interface CredentialFormSchema {
+    variable: string;
+    label: I18nObject;
+    type: CredentialFormTypeEnum | ParameterType;
+    required: boolean;
+    default?: number | string | boolean;
+    options?: {
+        label: I18nObject;
+        value: number | string | boolean;
+        show_on?: FormShowOnObject[];
+    }[];
+    placeholder: I18nObject;
+    max_length?: number;
+    show_on?: FormShowOnObject[];
+}
+export interface FormShowOnObject {
+    variable: string;
+    value: string;
+}
+export declare enum FetchFrom {
+    PREDEFINED_MODEL = "predefined-model",
+    CUSTOMIZABLE_MODEL = "customizable-model"
+}
+export declare enum ModelFeature {
+    TOOL_CALL = "tool-call",
+    MULTI_TOOL_CALL = "multi-tool-call",
+    AGENT_THOUGHT = "agent-thought",
+    VISION = "vision",
+    STREAM_TOOL_CALL = "stream-tool-call",
+    VIDEO = "video",
+    STRUCTURED_OUTPUT = "structured-output"
+}
+export declare enum ModelPropertyKey {
+    MODE = "mode",
+    CONTEXT_SIZE = "context_size",
+    MAX_CHUNKS = "max_chunks",
+    FILE_UPLOAD_LIMIT = "file_upload_limit",
+    SUPPORTED_FILE_EXTENSIONS = "supported_file_extensions",
+    MAX_CHARACTERS_PER_CHUNK = "max_characters_per_chunk",
+    DEFAULT_VOICE = "default_voice",
+    VOICES = "voices",
+    WORD_LIMIT = "word_limit",
+    AUDIO_TYPE = "audio_type",
+    MAX_WORKERS = "max_workers"
+}
+export declare enum ConfigurateMethod {
+    PREDEFINED_MODEL = "predefined-model",
+    CUSTOMIZABLE_MODEL = "customizable-model"
+}
+/**
+ * @todo Use JSON Schema to implement
+ */
+export declare enum ParameterType {
+    FLOAT = "float",
+    INT = "int",
+    STRING = "string",
+    BOOLEAN = "boolean",
+    TEXT = "text"
+}
+/**
+ * @todo Use JSON Schema to implement
+ */
+export interface ParameterRule {
+    name?: string;
+    useTemplate?: string;
+    label: I18nObject;
+    type: ParameterType;
+    help?: I18nObject;
+    required?: boolean;
+    default?: any;
+    min?: number;
+    max?: number;
+    precision?: number;
+    options?: string[];
+}
+export interface PriceConfig {
+    input: number;
+    output?: number;
+    unit: number;
+    currency: string;
+}
+export interface AIModelEntity extends ProviderModel {
+    parameter_rules?: ParameterRule[];
+    pricing?: PriceConfig;
+}
+export interface FieldModelSchema {
+    label: I18nObject;
+    placeholder?: I18nObject;
+}
+export interface ModelCredentialSchema {
+    model: FieldModelSchema;
+    credential_form_schemas: CredentialFormSchema[];
+}
+export declare const AI_MODEL_TYPE_VARIABLE = "__model_type";
+export declare enum PriceType {
+    INPUT = "input",
+    OUTPUT = "output"
+}
+export interface PriceInfo {
+    unitPrice: number;
+    unit: number;
+    totalAmount: number;
+    currency: string;
+}

package/src/ai/ai-provider.model.d.ts

@@ -0,0 +1,43 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+export interface IAiProvider extends IBasePerTenantAndOrganizationEntityModel {
+    /**
+     * 供应商标识,如 'openai'
+     */
+    name: string;
+    /**
+     * 供应商展示名称
+     */
+    label: string;
+    /**
+     * 供应商描述
+     */
+    description: string;
+    /**
+     * 供应商小图标
+     */
+    iconSmall: string;
+    /**
+     * 供应商大图标
+     */
+    iconLarge: string;
+    /**
+     * 背景颜色
+     */
+    background: string;
+    /**
+     * 帮助信息标题
+     */
+    helpTitle: string;
+    /**
+     * 帮助信息URL
+     */
+    helpUrl: string;
+    /**
+     * 支持的模型类型
+     */
+    supportedModelTypes: string[];
+    /**
+     * 配置方式
+     */
+    configurateMethods: string[];
+}

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

@@ -0,0 +1,82 @@
+/**
+ * Business roles for AI copilot (commands or contexts)
+ */
+export declare enum AiBusinessRole {
+    FinanceBP = "finance_bp",
+    SupplyChainExpert = "supply_chain_expert"
+}
+/**
+ * Providers for LLMs
+ *
+ * - https://js.langchain.com/docs/integrations/chat/
+ */
+export declare enum AiProvider {
+    /**
+     * - https://js.langchain.com/docs/integrations/chat/openai/
+     */
+    OpenAI = "openai",
+    /**
+     * - https://js.langchain.com/docs/integrations/chat/openai/
+     */
+    Azure = "azure",
+    /**
+     * - https://ollama.com/
+     * - https://js.langchain.com/docs/integrations/chat/ollama/
+     */
+    Ollama = "ollama",
+    /**
+     * - https://www.deepseek.com/zh
+     * - https://js.langchain.com/docs/integrations/chat/openai/
+     */
+    DeepSeek = "deepseek",
+    /**
+     * - https://docs.anthropic.com/en/home
+     * - https://js.langchain.com/docs/integrations/chat/anthropic/
+     */
+    Anthropic = "anthropic",
+    /**
+     * - https://www.aliyun.com/product/bailian
+     * - https://js.langchain.com/docs/integrations/chat/alibaba_tongyi/
+     */
+    AlibabaTongyi = "alibaba_tongyi",
+    /**
+     * - https://open.bigmodel.cn/
+     * - https://js.langchain.com/docs/integrations/chat/openai/
+     */
+    Zhipu = "zhipu",
+    /**
+     * - https://qianfan.cloud.baidu.com/
+     * - https://js.langchain.com/docs/integrations/chat/baidu_qianfan/
+     */
+    BaiduQianfan = "baidu_qianfan",
+    /**
+     * - https://www.together.ai/
+     * - https://js.langchain.com/docs/integrations/chat/togetherai/
+     */
+    Together = "together",
+    /**
+     * - https://platform.moonshot.cn/console
+     * - https://js.langchain.com/docs/integrations/chat/openai/
+     */
+    Moonshot = "moonshot",
+    /**
+     * - https://groq.com/
+     * - https://js.langchain.com/docs/integrations/chat/openai/
+     */
+    Groq = "groq",
+    /**
+     * - https://mistral.ai/
+     *
+     */
+    Mistral = "mistral",
+    /**
+     * - https://cohere.com/
+     */
+    Cohere = "cohere"
+}
+export declare enum AiProtocol {
+    OpenAI = "openai",
+    Others = "others"
+}
+export declare const OpenAIEmbeddingsProviders: AiProvider[];
+export declare const OllamaEmbeddingsProviders: AiProvider[];

package/src/ai/chat-message-feedback.model.d.ts

@@ -0,0 +1,24 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IChatMessage } from './chat-message.model';
+import { IChatConversation } from './chat.model';
+export declare enum ChatMessageFeedbackRatingEnum {
+    LIKE = "like",
+    DISLIKE = "dislike"
+}
+/**
+ *
+ */
+export interface IChatMessageFeedback extends IBasePerTenantAndOrganizationEntityModel {
+    rating: ChatMessageFeedbackRatingEnum;
+    content?: string;
+    /**
+     * Chat conversation
+     */
+    conversation?: IChatConversation;
+    conversationId?: string | null;
+    /**
+     * Chat conversation message
+     */
+    message?: IChatMessage;
+    messageId?: string | null;
+}