@memori.ai/memori-api-client 5.3.1 → 5.4.0

package/esm/index.d.ts

@@ -311,6 +311,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
     getIntentEventLogs: (sessionId: string, intentId: string, strDateFrom: string, strDateTo: string) => Promise<import("./types").ResponseSpec & {
         eventLogs: import("./types").EventLog[];
     }>;
+    getSessionEventLogs: (sessionID: string, eventLogSessionID: string) => Promise<import("./types").ResponseSpec & {
+        eventLogs: import("./types").EventLog[];
+    }>;
     stats: {
         getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
             textQualityIndex: number;
@@ -327,6 +330,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
         getIntentEventLogs: (sessionId: string, intentId: string, strDateFrom: string, strDateTo: string) => Promise<import("./types").ResponseSpec & {
             eventLogs: import("./types").EventLog[];
         }>;
+        getSessionEventLogs: (sessionID: string, eventLogSessionID: string) => Promise<import("./types").ResponseSpec & {
+            eventLogs: import("./types").EventLog[];
+        }>;
     };
     initSession: (params: import("./types").OpenSession) => Promise<import("./types").ResponseSpec & {
         sessionID: string;
@@ -444,6 +450,15 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
     checkWords: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
         undefinedWords: string[];
     }>;
+    suggestAnswer: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
+        answer: string;
+    }>;
+    suggestTags: (sessionId: string, question: string, answer: string, questionVariants?: string[] | undefined) => Promise<import("./types").ResponseSpec & {
+        tags: string[];
+    }>;
+    suggestQuestions: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
+        questions: string[];
+    }>;
     nlp: {
         getWordVector: (sessionId: string, word: string) => Promise<import("./types").ResponseSpec & {
             vector: number[];
@@ -463,6 +478,15 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
         checkWords: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
             undefinedWords: string[];
         }>;
+        suggestAnswer: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
+            answer: string;
+        }>;
+        suggestTags: (sessionId: string, question: string, answer: string, questionVariants?: string[] | undefined) => Promise<import("./types").ResponseSpec & {
+            tags: string[];
+        }>;
+        suggestQuestions: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
+            questions: string[];
+        }>;
     };
     getMemories: (sessionId: string, type?: "ALL" | "CONTENTS" | "DEFAULTS" | "DRAFTS" | "EXPERT_REFERENCES" | undefined) => Promise<import("./types").ResponseSpec & {
         memories: import("./types").Memory[];
@@ -685,6 +709,19 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
         deleteCorrelationPair: (sessionId: string, pairId: string) => Promise<import("./types").ResponseSpec>;
     };
     backend: {
+        healthCheck: () => Promise<import("./types").ResponseSpec>;
+        getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
+            tenant: import("./types").TenantBase;
+        }>;
+        getTenantList: (authToken: string) => Promise<import("./types").ResponseSpec & {
+            tenants: import("./types").TenantBase[];
+        }>;
+        createTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
+            tenant: import("./types").TenantBase;
+        }>;
+        patchTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
+            tenant: import("./types").TenantBase;
+        }>;
         postOutcome: (authToken: string, outcomeCode: string) => Promise<import("./types").ResponseSpec>;
         getUserBadges: (authToken: string) => Promise<import("./types").ResponseSpec & {
             badges: import("./types").Badge[];
@@ -700,12 +737,18 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
         }>;
         updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
             completionConfigID: string;
-        }) => Promise<import("./types").ResponseSpec>;
+        }) => Promise<import("./types").ResponseSpec & {
+            config: import("./types").CompletionConfig;
+            appliedMemoriIDs?: string[] | undefined;
+            appliedMemoriNames?: string[] | undefined;
+        }>;
         deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
         createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
             completionConfigID?: string | undefined;
         }) => Promise<import("./types").ResponseSpec & {
             config: import("./types").CompletionConfig;
+            appliedMemoriIDs?: string[] | undefined;
+            appliedMemoriNames?: string[] | undefined;
         }>;
         analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
             status: import("./types").AnalysisStatus;
@@ -832,9 +875,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
             flowID?: string | undefined;
         }>;
         recoverUsername: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
-        getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
-            tenant: import("./types").Tenant;
-        }>;
         resendVerificationCode: (user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec>;
         createUser: (authToken: string, user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec & {
             user: import("./types").User;
@@ -900,6 +940,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
             asset: import("./types").Asset;
         }>;
         getAsset: (fileName: string, sessionID: string) => Promise<any>;
+        getAssetList: (authToken: string) => Promise<import("./types").ResponseSpec & {
+            assets: import("./types").Asset[];
+        }>;
         updateAsset: (authToken: string, assetURL: string, asset: import("./types").Asset) => Promise<import("./types").ResponseSpec & {
             asset: import("./types").Asset;
         }>;
@@ -910,6 +953,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
                 asset: import("./types").Asset;
             }>;
             getAsset: (fileName: string, sessionID: string) => Promise<any>;
+            getAssetList: (authToken: string) => Promise<import("./types").ResponseSpec & {
+                assets: import("./types").Asset[];
+            }>;
             updateAsset: (authToken: string, assetURL: string, asset: import("./types").Asset) => Promise<import("./types").ResponseSpec & {
                 asset: import("./types").Asset;
             }>;
@@ -1011,9 +1057,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
                 flowID?: string | undefined;
             }>;
             recoverUsername: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
-            getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
-                tenant: import("./types").Tenant;
-            }>;
             resendVerificationCode: (user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec>;
             createUser: (authToken: string, user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec & {
                 user: import("./types").User;
@@ -1130,12 +1173,18 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
             }>;
             updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
                 completionConfigID: string;
-            }) => Promise<import("./types").ResponseSpec>;
+            }) => Promise<import("./types").ResponseSpec & {
+                config: import("./types").CompletionConfig;
+                appliedMemoriIDs?: string[] | undefined;
+                appliedMemoriNames?: string[] | undefined;
+            }>;
             deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
             createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
                 completionConfigID?: string | undefined;
             }) => Promise<import("./types").ResponseSpec & {
                 config: import("./types").CompletionConfig;
+                appliedMemoriIDs?: string[] | undefined;
+                appliedMemoriNames?: string[] | undefined;
             }>;
         };
         badge: {
@@ -1147,6 +1196,21 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
                 badge: import("./types").Badge;
             }>;
         };
+        tenant: {
+            healthCheck: () => Promise<import("./types").ResponseSpec>;
+            getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
+                tenant: import("./types").TenantBase;
+            }>;
+            getTenantList: (authToken: string) => Promise<import("./types").ResponseSpec & {
+                tenants: import("./types").TenantBase[];
+            }>;
+            createTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
+                tenant: import("./types").TenantBase;
+            }>;
+            patchTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
+                tenant: import("./types").TenantBase;
+            }>;
+        };
     };
 };
 export default api;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.3.1",
+  "version": "5.4.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/backend/asset.ts

@@ -66,6 +66,17 @@ export default (apiUrl: string) => ({
       method: 'GET',
     }),
 
+  /**
+   * Gets a list of Asset objects owned the currently logged in User.
+   * @param {string} authToken - The login token
+   * @returns The list of Asset objects.
+   */
+  getAssetList: (authToken: string) =>
+    apiFetcher(`/Assets/${authToken}`, {
+      apiUrl,
+      method: 'GET',
+    }) as Promise<ResponseSpec & { assets: Asset[] }>,
+
   /**
    * Updates an Asset object
    * @param {string} authToken - The login token

package/src/backend/completionConfig.ts

@@ -49,7 +49,13 @@ export default (apiUrl: string) => ({
       apiUrl,
       method: 'PATCH',
       body: config,
-    }) as Promise<ResponseSpec>,
+    }) as Promise<
+      ResponseSpec & {
+        config: CompletionConfig;
+        appliedMemoriIDs?: string[];
+        appliedMemoriNames?: string[];
+      }
+    >,
 
   /**
    * Deletes an existing Completion Config object.
@@ -73,5 +79,11 @@ export default (apiUrl: string) => ({
       apiUrl,
       method: 'POST',
       body: config,
-    }) as Promise<ResponseSpec & { config: CompletionConfig }>,
+    }) as Promise<
+      ResponseSpec & {
+        config: CompletionConfig;
+        appliedMemoriIDs?: string[];
+        appliedMemoriNames?: string[];
+      }
+    >,
 });

package/src/backend/tenant.test.ts

@@ -0,0 +1,17 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('backend/tenant api', () => {
+  it('works on tenant apis', async () => {
+    expect(
+      await client.backend.tenant.getTenantConfig('www.aisuru.com')
+    ).not.toBeNull();
+  });
+
+  it('works on tenant apis with shorthand version', async () => {
+    expect(
+      await client.backend.getTenantConfig('www.aisuru.com')
+    ).not.toBeNull();
+  });
+});

package/src/backend/tenant.ts

@@ -0,0 +1,74 @@
+import { ResponseSpec, TenantBase } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Health check for the backend
+   */
+  healthCheck: () =>
+    apiFetcher(`/HealthCheck`, {
+      apiUrl,
+      method: 'GET',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of a Tenant object.
+   * @param tenantName - The name of the tenant
+   */
+  getTenantConfig: (tenantName: string) =>
+    apiFetcher(`/Tenant/${tenantName}`, { apiUrl }) as Promise<
+      ResponseSpec & {
+        tenant: TenantBase;
+      }
+    >,
+
+  /**
+   * Gets the list of of all Tenant objects.
+   * @param authToken - The login token
+   */
+  getTenantList: (authToken: string) =>
+    apiFetcher(`/Tenants/${authToken}`, {
+      apiUrl,
+      method: 'GET',
+    }) as Promise<ResponseSpec & { tenants: TenantBase[] }>,
+
+  /**
+   * Duplicates a Tenant object.
+   * @param {string} authToken - The login token
+   * @param {string} name - The name of the Tenant to duplicate
+   * @param {TenantBase} tenant
+   * @returns The specifications of the new Tenant object
+   */
+  createTenant: (
+    authToken: string,
+    name: string,
+    tenant: Partial<TenantBase>
+  ) =>
+    apiFetcher(`/Tenant/${authToken}/${name}`, {
+      apiUrl,
+      method: 'POST',
+      body: tenant,
+    }) as Promise<
+      ResponseSpec & {
+        tenant: TenantBase;
+      }
+    >,
+
+  /**
+   * Updates the details of a Tenant object.
+   * @param {string} authToken  - The login token
+   * @param {string} name - The name of the Tenant to update
+   * @param {TenantBase} tenant
+   * @returns The new specifications of the Tenant object
+   */
+  patchTenant: (authToken: string, name: string, tenant: Partial<TenantBase>) =>
+    apiFetcher(`/Tenant/${authToken}/${name}`, {
+      apiUrl,
+      method: 'PATCH',
+      body: tenant,
+    }) as Promise<
+      ResponseSpec & {
+        tenant: TenantBase;
+      }
+    >,
+});

package/src/backend/user.ts

@@ -182,19 +182,6 @@ export default (apiUrl: string) => ({
       method: 'POST',
     }) as Promise<ResponseSpec>,
 
-  /**
-   * Gets the details of a Tenant object.
-   * @param tenantName - The name of the tenant
-   */
-  getTenantConfig: (tenantName: string) =>
-    apiFetcher(`/Tenant/${tenantName}`, {
-      apiUrl,
-    }) as Promise<
-      ResponseSpec & {
-        tenant: Tenant;
-      }
-    >,
-
   /**
    * Re-sends the verification code to confirm a pending User registration.
    * @param {User} user - The user object

package/src/backend.ts

@@ -10,6 +10,7 @@ import process from './backend/process';
 import analysis from './backend/analysis';
 import completionConfig from './backend/completionConfig';
 import badge from './backend/badge';
+import tenant from './backend/tenant';
 
 const backendAPI = (apiUrl: string) => ({
   asset: asset(apiUrl),
@@ -24,6 +25,7 @@ const backendAPI = (apiUrl: string) => ({
   analysis: analysis(apiUrl),
   completionConfig: completionConfig(apiUrl),
   badge: badge(apiUrl),
+  tenant: tenant(apiUrl),
   ...asset(apiUrl),
   ...memori(apiUrl),
   ...user(apiUrl),
@@ -36,6 +38,7 @@ const backendAPI = (apiUrl: string) => ({
   ...analysis(apiUrl),
   ...completionConfig(apiUrl),
   ...badge(apiUrl),
+  ...tenant(apiUrl),
 });
 
 export default backendAPI;

package/src/engine/nlp.ts

@@ -113,4 +113,70 @@ export default (apiUrl: string) => ({
         undefinedWords: string[];
       }
     >,
+
+  /**
+   * Tries to suggest the answer for a question, using as much content as possible from the session's associated Memori object.
+   * @param {string} sessionId The session ID
+   * @param {string} text Text of the sentence.
+   */
+  suggestAnswer: async (sessionId: string, text: string) =>
+    apiFetcher(`/SuggestAnswer/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: { text },
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Suggested answer. May be null if no answer could be suggested.
+         */
+        answer: string;
+      }
+    >,
+
+  /**
+   * Tries to suggest tags for a a question and its answer.
+   * Differently from ```SuggestAnswer```, no content from the session's associated Memori object is used.
+   * @param {string} sessionId The session ID
+   * @param {string} question Text of question.
+   * @param {string} answer Answer to the question (and its variants).
+   * @param {string[]=} questionVariants Optional list of question variants.
+   */
+  suggestTags: async (
+    sessionId: string,
+    question: string,
+    answer: string,
+    questionVariants?: string[]
+  ) =>
+    apiFetcher(`/SuggestTags/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: { question, answer, questionVariants },
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Suggested tags. May be null or empty if no tags could be suggested.
+         */
+        tags: string[];
+      }
+    >,
+
+  /**
+   * Tries to suggest questions for an answer.
+   * Differently from ```SuggestAnswer```, no content from the session's associated Memori object is used.
+   * @param {string} sessionId The session ID
+   * @param {string} text Text of the sentence.
+   */
+  suggestQuestions: async (sessionId: string, text: string) =>
+    apiFetcher(`/SuggestQuestions/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: { text },
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Suggested questions. May be null or empty if no questions could be suggested.
+         */
+        questions: string[];
+      }
+    >,
 });

package/src/engine/stats.ts

@@ -113,4 +113,19 @@ export default (apiUrl: string) => ({
         eventLogs: EventLog[];
       }
     >,
+
+  /**
+   * Gets the Event Log objects for the Memori of the current session recorded during a specific other session.
+   * @param {string} sessionID The session ID
+   * @param {string} eventLogSessionID The session ID for which Event Log objects are being searched
+   */
+  getSessionEventLogs: async (sessionID: string, eventLogSessionID: string) =>
+    apiFetcher(`/SessionEventLogs/${sessionID}/${eventLogSessionID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        eventLogs: EventLog[];
+      }
+    >,
 });