@memori.ai/memori-api-client 3.0.1 → 4.0.0

package/src/backend/process.ts

@@ -0,0 +1,86 @@
+import { ResponseSpec, ProcessStatus } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Gets a list of processes started by the currently logged in User.
+   * @param {string} authToken - The login token.
+   * @param {string=} processType - Optional filter for Process type
+   */
+  getProcesses: async <T = ProcessStatus>(
+    authToken: string,
+    processType?: ProcessStatus['processType']
+  ) =>
+    apiFetcher(
+      `/Processes/${authToken}${processType ? `/${processType}` : ''}`,
+      {
+        apiUrl,
+        method: 'GET',
+      }
+    ) as Promise<
+      ResponseSpec & {
+        processes: T[];
+      }
+    >,
+
+  /**
+   * Gets a list of processes for the specified Memori.
+   * @param {string} authToken - The login token.
+   * @param {string} memoriID - The Memori ID
+   * @param {string=} processType - Optional filter for Process type
+   */
+  getMemoriProcesses: async <T = ProcessStatus>(
+    authToken: string,
+    memoriID: string,
+    processType?: ProcessStatus['processType']
+  ) =>
+    apiFetcher(
+      `/MemoriProcesses/${authToken}/${memoriID}${
+        processType ? `/${processType}` : ''
+      }`,
+      {
+        apiUrl,
+        method: 'GET',
+      }
+    ) as Promise<
+      ResponseSpec & {
+        processes: T[];
+      }
+    >,
+
+  /**
+   * Gets the status of an process.
+   * @param {string} authToken - The login token.
+   * @param {string} processID The process ID
+   */
+  getProcessStatus: async <T = ProcessStatus>(
+    authToken: string,
+    processID: string
+  ) =>
+    apiFetcher(`/ProcessStatus/${authToken}/${processID}`, {
+      apiUrl,
+      method: 'GET',
+    }) as Promise<
+      ResponseSpec & {
+        status: T;
+      }
+    >,
+
+  /**
+   * Interrupts an ongoing process.
+   * @param {string} authToken - The login token.
+   * @param {string} processID The process ID
+   */
+  stopProcess: async <T = ProcessStatus>(
+    authToken: string,
+    processID: string
+  ) =>
+    apiFetcher(`/StopProcess/${authToken}/${processID}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & {
+        status: T;
+      }
+    >,
+});

package/src/backend.ts

@@ -6,6 +6,8 @@ import invitation from './backend/invitation';
 import consumptionLogs from './backend/consumptionLogs';
 import notifications from './backend/notifications';
 import importExport from './backend/importExport';
+import process from './backend/process';
+import analysis from './backend/analysis';
 
 const backendAPI = (apiUrl: string) => ({
   asset: asset(apiUrl),
@@ -16,6 +18,8 @@ const backendAPI = (apiUrl: string) => ({
   consumptionLogs: consumptionLogs(apiUrl),
   notifications: notifications(apiUrl),
   importExport: importExport(apiUrl),
+  process: process(apiUrl),
+  analysis: analysis(apiUrl),
   ...asset(apiUrl),
   ...memori(apiUrl),
   ...user(apiUrl),
@@ -24,6 +28,8 @@ const backendAPI = (apiUrl: string) => ({
   ...consumptionLogs(apiUrl),
   ...notifications(apiUrl),
   ...importExport(apiUrl),
+  ...process(apiUrl),
+  ...analysis(apiUrl),
 });
 
 export default backendAPI;

package/src/types.ts

@@ -289,6 +289,7 @@ export type TenantBase = {
   name?: string;
   description?: string;
   logoURL?: string;
+  adminEmail?: string;
   /**
    * Additional Tenant names.
    * Usually host names, e.g. app.memorytwin.com.
@@ -1032,12 +1033,65 @@ export interface ImportWarning {
   }[];
 }
 
-export interface ImportResponse {
+export interface AnalysisParams {
+  query: string;
+}
+
+export interface AnalysisWarning {
+  /**
+   * @type {string}
+   * Type of warning.
+   * Currently supported types are:
+   * - Error: an error occurred while performing analysis
+   */
+  warningType: 'Error' | string;
+  /**
+   * @type {string=}
+   * When WarningType is Error reports the text of the error.
+   */
+  text?: string;
+}
+
+export interface AnalysisWarning {
+  /**
+   * @type {string}
+   * Type of warning.
+   * Currently supported types are:
+   * - Error: an error occurred while performing analysis
+   */
+  warningType: 'Error' | string;
+  /**
+   * @type {string=}
+   * When WarningType is Error reports the text of the error.
+   */
+  text?: string;
+}
+
+export interface ProcessStatus {
+  /**
+   * @type {string}
+   * Process ID.
+   */
+  processID: string;
   /**
    * @type {string}
-   * Import process ID.
+   * ID of the Memori object this process refers to.
    */
-  importID: string;
+  memoriID: string;
+  /**
+   * @type {string}
+   * Name of the user that started the process.
+   */
+  processUserName: string;
+  /**
+   * @type {string}
+   * Process type.
+   * Can be one of the following:
+   *
+   * - Import: for file import processes
+   * - Analysis: for Deep Thought user/query analysis processes
+   */
+  processType: 'Import' | 'Analysis';
   /**
    * @type {string}
    * minLength: 1
@@ -1066,28 +1120,11 @@ export interface ImportResponse {
    * Progress of the Import process as a fraction of 1.
    */
   progress: number;
-  /**
-   * @type {string}
-   * Import type.  Can be one of the following:
-   * -  CSV: for tabular documents
-   * -  TXT: for text documents
-   */
-  importType: 'CSV' | 'TXT';
-  /**
-   * @type {number}
-   * Size of the imported document in characters.
-   */
-  importSize: number;
-  /**
-   * @type {string?}
-   * Name of this import, if set when the Import process was requested.
-   */
-  importName?: string;
   /**
    * @type {string?}
    * Original parameters of the Import process request, as a JSON structure, excluding the document rows.
    */
-  importSpecsJSON?: string;
+  processSpecsJSON?: string;
   /**
    * @type {string=}
    * Timestamp of start of the Import process. Null until the Import process is in Starting status.
@@ -1103,7 +1140,28 @@ export interface ImportResponse {
    * Estimated time required to complete the Import process, in seconds.
    */
   eta?: number;
+  creationTimestamp?: string;
+  lastChangeTimestamp?: string;
+}
 
+export interface ImportStatus extends ProcessStatus {
+  /**
+   * @type {string}
+   * Import type.  Can be one of the following:
+   * -  CSV: for tabular documents
+   * -  TXT: for text documents
+   */
+  importType: 'CSV' | 'TXT';
+  /**
+   * @type {number}
+   * Size of the imported document in characters.
+   */
+  importSize: number;
+  /**
+   * @type {string?}
+   * Name of this import, if set when the Import process was requested.
+   */
+  importName?: string;
   /**
    * @type {number=}
    * Number of Imported Memory objects so far.
@@ -1119,6 +1177,72 @@ export interface ImportResponse {
   importWarnings?: ImportWarning[];
 }
 
+export interface AnalysisStatus extends ProcessStatus {
+  /**
+   * @type {string}
+   * Analysis type.  Can be one of the following:
+   * - UserQuery: for Deep Thought User/query Match analysis
+   */
+  analysisType: 'UserQuery';
+  /**
+   * @type {string}
+   * Query to be used in the analysis. Used when AnalysisType is UserQuery.
+   */
+  query?: string;
+  /**
+   * @type {number=}
+   * Number of Import Warning objects
+   */
+  analysisWarningsCount?: number;
+  /**
+   * @type {AnalysisWarning[]=}
+   * List of Import Warning objects. May be empty.
+   */
+  analysisWarnings?: AnalysisWarning[];
+}
+
+export interface UserQueryMatch {
+  /**
+   * @type {string}
+   * Match ID. Unique and assigned by the system.
+   */
+  userQueryMatchID: string;
+  /**
+   * @type {string}
+   * ID of the Analysis object this match refers to.
+   */
+  analysisID: string;
+  /**
+   * @type {string}
+   * ID of the Memori object this match refers to.
+   */
+  memoriID: string;
+  /**
+   * @type {string}
+   * ID of the corresponding User object on the Engine.
+   */
+  engineUserID: string;
+  /**
+   * @type {string}
+   * User name.
+   */
+  userName: string;
+  /**
+   * @type {string}
+   * User's Tenant name.
+   */
+  userTenantName: string;
+  /**
+   * @type {string}
+   * User's e-mail.
+   */
+  userEmail: string;
+  /**
+   * @type {number}
+   * Match level between the Analysis query and this User. Value is between 0 and 1, with 0.0 meaning no match and 1.0 meaning perfect match.
+   */
+  match: number;
+}
 export interface Badge {
   badgeID?: string;
   date?: string;