@memori.ai/memori-api-client 1.1.0 → 1.2.0

package/dist/types.d.ts

@@ -805,34 +805,26 @@ export declare type CustomWord = {
     lastChangeTimestamp: string;
     lastChangeSessionID: string;
 };
-export declare type ImportWarning = {
-    warningType: 'Existing Similar Memory' | 'Internal Error';
-    rowNumber?: number;
-    csvRow: string;
-    text?: string;
-    similarTexts?: {
-        text: string;
-        similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
-    }[];
-};
-export declare type ImportReponse = {
-    importID: string;
-    importedMemories?: number;
-    importWarnings?: ImportWarning[];
-};
-export declare type ImportCSVParams = {
-    includedRows?: number[];
+export interface ImportCSVParams {
     hasHeaders?: boolean;
     headerNames?: string[];
-    forceImport?: boolean;
     questionColumnName: string;
     answerColumnName: string;
     contextVarsToMatchColumnName?: string;
     contextVarsToSetColumnName?: string;
     csvSeparator?: string;
     questionTitleVariantsSeparator?: string;
-};
-export declare type ExportCSVParams = {
+}
+export interface ImportTxtParams {
+    newLinesPerParagraphs?: number;
+}
+export interface ImportParams {
+    includedRows?: number[];
+    forceImport?: boolean;
+    csvSpecs?: ImportCSVParams;
+    txtSpecs?: ImportTxtParams;
+}
+export interface ExportCSVParams {
     newLine: '\n' | '\r\n';
     hasHeaders?: boolean;
     questionColumnName: string;
@@ -841,4 +833,65 @@ export declare type ExportCSVParams = {
     contextVarsToSetColumnName?: string;
     csvSeparator?: string;
     questionTitleVariantsSeparator?: string;
-};
+}
+export interface ImportWarning {
+    warningType: 'Existing Similar Memory' | 'Internal Error';
+    rowNumber?: number;
+    row: string;
+    text?: string;
+    similarTexts?: {
+        text: string;
+        similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
+    }[];
+}
+export interface ImportReponse {
+    importID: string;
+    status: {
+        /**
+         * @type {string}
+         * minLength: 1
+         * Current status of the Import process (starting, running etc.).
+         * May be one of the following:
+         * - Starting: the Import process is preparing to start, but has not started yet. Will advance to Running automatically.
+         * - Running: the Import process has been started and is actively processing Memory objects.
+         * - Stopped: the Import process has been stopped manually, not all Memory objects may have been processed.
+         * - Completed: the Import process finished successfully, all the Memory objects have been processed.
+         * - Failed: the Import process terminated due to an unexpected error, not all Memory objects may have been processed.
+         */
+        status: 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
+        /**
+         * @type {string=}
+         * If the Status is Failed, reports the error that caused the Import process to fail. Null otherwise.
+         */
+        error?: string;
+        /**
+         * @type {number}
+         * Progress of the Import process as a fraction of 1.
+         */
+        progress: number;
+        /**
+         * @type {string=}
+         * Timestamp of start of the Import process. Null until the Import process is in Starting status.
+         */
+        begin?: string;
+        /**
+         * @type {string=}
+         * Timestamp of end of the Import process. Null until the Import process is in Starting or Running status.
+         */
+        end?: string;
+        /**
+         * @type {number=}
+         * Estimated time required to complete the Import process, in seconds.
+         */
+        eta?: number;
+        /**
+         * @type {number=}
+         * Number of Imported Memory objects so far.
+         */
+        importedMemories?: number;
+        /**
+         * List of Import Warning objects. May be empty.
+         */
+        importWarnings?: ImportWarning[];
+    };
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.0",
+  "version": "1.2.0",
   "name": "@memori.ai/memori-api-client",
   "description": "React library to integrate a Memori in your app or website",
   "license": "Apache-2.0",

package/src/engine/importExport.ts

@@ -1,8 +1,8 @@
 import {
   ResponseSpec,
   ImportReponse,
-  ImportCSVParams,
   ExportCSVParams,
+  ImportParams,
 } from '../types';
 import { apiFetcher } from '../apiFetcher';
 
@@ -16,19 +16,55 @@ export default (apiUrl: string) => ({
   /**
    * Imports memories from a CSV file.
    * @param {string} sessionId The session ID
-   * @param {string[]} csvRows Rows of the CSV file.
-   * @param {ImportCSVParams} params The specifications and content of the CSV file
+   * @param {string[]} rows Rows of the CSV file.
+   * @param {ImportParams} params The specifications and content of the CSV file
    */
-  importCSV: async (
+  importCSV: async (sessionId: string, rows: string[], params: ImportParams) =>
+    apiFetcher(`/ImportExport/ImportCSV/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: {
+        rows,
+        ...params,
+      },
+    }) as Promise<ResponseSpec & ImportReponse>,
+
+  /**
+   * Gets the status of an ongoing Import process.
+   * @param {string} importID The import process ID
+   */
+  importStatus: async (importID: string) =>
+    apiFetcher(`/ImportExport/ImportStatus/${importID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec & ImportReponse>,
+
+  /**
+   * Interrupts an ongoing Import process.
+   * @param {string} importID The import process ID
+   */
+  stopImport: async (importID: string) =>
+    apiFetcher(`/ImportExport/StopImport/${importID}`, {
+      method: 'POST',
+      apiUrl,
+    }) as Promise<ResponseSpec & ImportReponse>,
+
+  /**
+   * Imports memories from a TXT file.
+   * @param {string} sessionId The session ID
+   * @param {string[]} rows Rows of the TXT file.
+   * @param {ImportCSVParams} params The specifications and content of the TXT file
+   */
+  importTXT: async (
     sessionId: string,
-    csvRows: string[],
-    params: ImportCSVParams
+    rows: string[],
+    params: Omit<ImportParams, 'csvSpecs'>
   ) =>
-    apiFetcher(`/ImportExport/ImportCSV/${sessionId}`, {
+    apiFetcher(`/ImportExport/ImportTXT/${sessionId}`, {
       method: 'POST',
       apiUrl,
       body: {
-        csvRows,
+        rows,
         ...params,
       },
     }) as Promise<ResponseSpec & ImportReponse>,

package/src/types.ts

@@ -844,37 +844,28 @@ export type CustomWord = {
   lastChangeSessionID: string;
 };
 
-export type ImportWarning = {
-  warningType: 'Existing Similar Memory' | 'Internal Error';
-  rowNumber?: number;
-  csvRow: string;
-  text?: string;
-  similarTexts?: {
-    text: string;
-    similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
-  }[];
-};
-
-export type ImportReponse = {
-  importID: string;
-  importedMemories?: number;
-  importWarnings?: ImportWarning[];
-};
-
-export type ImportCSVParams = {
-  includedRows?: number[];
+export interface ImportCSVParams {
   hasHeaders?: boolean;
   headerNames?: string[];
-  forceImport?: boolean;
   questionColumnName: string;
   answerColumnName: string;
   contextVarsToMatchColumnName?: string;
   contextVarsToSetColumnName?: string;
   csvSeparator?: string;
   questionTitleVariantsSeparator?: string;
-};
+}
+
+export interface ImportTxtParams {
+  newLinesPerParagraphs?: number;
+}
 
-export type ExportCSVParams = {
+export interface ImportParams {
+  includedRows?: number[];
+  forceImport?: boolean;
+  csvSpecs?: ImportCSVParams;
+  txtSpecs?: ImportTxtParams;
+}
+export interface ExportCSVParams {
   newLine: '\n' | '\r\n';
   hasHeaders?: boolean;
   questionColumnName: string;
@@ -883,4 +874,68 @@ export type ExportCSVParams = {
   contextVarsToSetColumnName?: string;
   csvSeparator?: string;
   questionTitleVariantsSeparator?: string;
-};
+}
+
+export interface ImportWarning {
+  warningType: 'Existing Similar Memory' | 'Internal Error';
+  rowNumber?: number;
+  row: string;
+  text?: string;
+  similarTexts?: {
+    text: string;
+    similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
+  }[];
+}
+
+export interface ImportReponse {
+  importID: string;
+  status: {
+    /**
+     * @type {string}
+     * minLength: 1
+     * Current status of the Import process (starting, running etc.).
+     * May be one of the following:
+     * - Starting: the Import process is preparing to start, but has not started yet. Will advance to Running automatically.
+     * - Running: the Import process has been started and is actively processing Memory objects.
+     * - Stopped: the Import process has been stopped manually, not all Memory objects may have been processed.
+     * - Completed: the Import process finished successfully, all the Memory objects have been processed.
+     * - Failed: the Import process terminated due to an unexpected error, not all Memory objects may have been processed.
+     */
+    status: 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
+    /**
+     * @type {string=}
+     * If the Status is Failed, reports the error that caused the Import process to fail. Null otherwise.
+     */
+    error?: string;
+    /**
+     * @type {number}
+     * Progress of the Import process as a fraction of 1.
+     */
+    progress: number;
+    /**
+     * @type {string=}
+     * Timestamp of start of the Import process. Null until the Import process is in Starting status.
+     */
+    begin?: string;
+    /**
+     * @type {string=}
+     * Timestamp of end of the Import process. Null until the Import process is in Starting or Running status.
+     */
+    end?: string;
+    /**
+     * @type {number=}
+     * Estimated time required to complete the Import process, in seconds.
+     */
+    eta?: number;
+
+    /**
+     * @type {number=}
+     * Number of Imported Memory objects so far.
+     */
+    importedMemories?: number;
+    /**
+     * List of Import Warning objects. May be empty.
+     */
+    importWarnings?: ImportWarning[];
+  };
+}