@memori.ai/memori-api-client 0.1.1 → 0.2.1

package/README.md

@@ -20,7 +20,7 @@ npm install @memori.ai/memori-api-client
 
 Every method has JSDoc annotations with usage and description and typings information.
 
-See an example [here](https://github.com/memori-ai/examples/blob/main/ts-sdk/index.ts).
+See examples for [Node (TypeScript)](https://github.com/memori-ai/examples/blob/main/ts-sdk/index.ts) and [React](https://github.com/memori-ai/examples/blob/main/react-ts-with-api-client/src/App.tsx).
 
 ```ts
 import memoriApiClient from '@memori.ai/memori-api-client';
@@ -52,8 +52,25 @@ memori.constants.allowedMediaTypes; // list of allowed media types in asset uplo
 memori.constants.anonTag; // tag for anonymous users
 ```
 
+### Asset
+
+There is a helper method parsing media urls from the DB, handling different cases
+
+```ts
+const memori = memoriApiClient('https://backend.memori.ai');
+
+memori.asset.getResourceUrl({
+  type: 'avatar',
+  resourceURI: '768b9654-e781-4c3c-81fa-ae1529d1bfbe.png',
+  mediaType: 'image/png',
+  sessionId: 'be2e4a44-890b-483b-a26a-f6e122f36e2b',
+});
+```
+
 ### TTS
 
+> Experimental
+
 Bundled with this client there is a TTS utility that can be used to synthesize text to speech.
 
 ```ts
@@ -79,6 +96,8 @@ speech.stopSpeaking();
 
 ### STT
 
+> Experimental
+
 There is also a speech recognition utility.
 
 ```ts
@@ -94,21 +113,6 @@ speech.isRecognizing();
 speech.stopRecognizing();
 ```
 
-### Asset
-
-There is a helper method parsing media urls from the DB, handling different cases
-
-```ts
-const memori = memoriApiClient('https://backend.memori.ai');
-
-memori.asset.getResourceUrl({
-  type: 'avatar',
-  resourceURI: '768b9654-e781-4c3c-81fa-ae1529d1bfbe.png',
-  mediaType: 'image/png',
-  sessionId: 'be2e4a44-890b-483b-a26a-f6e122f36e2b',
-});
-```
-
 ## Development
 
 To run TSDX, use:

package/dist/backend/memori.d.ts

@@ -71,7 +71,9 @@ declare const _default: (apiUrl: string) => {
      * @param memori - The Memori object
      * @returns The created Memori object
      */
-    updateMemori: (authToken: string, memori: Memori) => Promise<ResponseSpec & {
+    updateMemori: (authToken: string, memori: Partial<Memori> & {
+        memoriID: string;
+    }) => Promise<ResponseSpec & {
         memori: Memori;
     }>;
     /**

package/dist/backend.d.ts

@@ -103,7 +103,9 @@ declare const backendAPI: (apiUrl: string) => {
     createMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
         memori: import("./types").Memori;
     }>;
-    updateMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
+    updateMemori: (authToken: string, memori: Partial<import("./types").Memori> & {
+        memoriID: string;
+    }) => Promise<import("./types").ResponseSpec & {
         memori: import("./types").Memori;
     }>;
     deleteMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec>;
@@ -165,7 +167,9 @@ declare const backendAPI: (apiUrl: string) => {
         createMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
             memori: import("./types").Memori;
         }>;
-        updateMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
+        updateMemori: (authToken: string, memori: Partial<import("./types").Memori> & {
+            memoriID: string;
+        }) => Promise<import("./types").ResponseSpec & {
             memori: import("./types").Memori;
         }>;
         deleteMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec>;

package/dist/engine/contextVars.d.ts

@@ -0,0 +1,32 @@
+import { ResponseSpec } from '../types';
+declare const _default: (apiUrl: string) => {
+    /**
+     * Gets a list of currently known context variables.
+     * @param {string} sessionId The session ID
+     */
+    getContextVars: (sessionId: string) => Promise<ResponseSpec & {
+        [variable: string]: string[];
+    }>;
+    /**
+     * Gets a list of currently known context variable names.
+     * @param {string} sessionId The session ID
+     */
+    getContextVarNames: (sessionId: string) => Promise<ResponseSpec & {
+        contextVarNames: string[];
+    }>;
+    /**
+     * /memori/v2/ContextVarValues/{strSessionID}/{contextVarName}
+     * @param {string} sessionId The session ID
+     * @param {string} contextVarName The name of the context variable
+     */
+    getContextVarValues: (sessionId: string, contextVarName: string) => Promise<ResponseSpec & {
+        contextVarName: string;
+        contextVarValues: string[];
+    }>;
+};
+/****************************
+ *                          *
+ *       ContextVars        *
+ *                          *
+ ****************************/
+export default _default;

package/dist/engine.d.ts

@@ -1,4 +1,26 @@
 declare const _default: (apiUrl: string) => {
+    getContextVars: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+        [variable: string]: string[];
+    }>;
+    getContextVarNames: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+        contextVarNames: string[];
+    }>;
+    getContextVarValues: (sessionId: string, contextVarName: string) => Promise<import("./types").ResponseSpec & {
+        contextVarName: string;
+        contextVarValues: string[];
+    }>;
+    contextVars: {
+        getContextVars: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+            [variable: string]: string[];
+        }>;
+        getContextVarNames: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+            contextVarNames: string[];
+        }>;
+        getContextVarValues: (sessionId: string, contextVarName: string) => Promise<import("./types").ResponseSpec & {
+            contextVarName: string;
+            contextVarValues: string[];
+        }>;
+    };
     getUnansweredQuestions: (sessionId: string) => Promise<import("./types").ResponseSpec & {
         unansweredQuestions: import("./types").UnansweredQuestion[];
     }>;

package/dist/index.d.ts

@@ -12,6 +12,28 @@ declare const api: (hostname?: string | undefined) => {
     asset: {
         getResourceUrl: ({ type, resourceURI, sessionID, baseURL, }: import("./helpers/asset").ResourceURLParams) => string;
     };
+    getContextVars: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+        [variable: string]: string[];
+    }>;
+    getContextVarNames: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+        contextVarNames: string[];
+    }>;
+    getContextVarValues: (sessionId: string, contextVarName: string) => Promise<import("./types").ResponseSpec & {
+        contextVarName: string;
+        contextVarValues: string[];
+    }>;
+    contextVars: {
+        getContextVars: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+            [variable: string]: string[];
+        }>;
+        getContextVarNames: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+            contextVarNames: string[];
+        }>;
+        getContextVarValues: (sessionId: string, contextVarName: string) => Promise<import("./types").ResponseSpec & {
+            contextVarName: string;
+            contextVarValues: string[];
+        }>;
+    };
     getUnansweredQuestions: (sessionId: string) => Promise<import("./types").ResponseSpec & {
         unansweredQuestions: import("./types").UnansweredQuestion[];
     }>;
@@ -391,7 +413,9 @@ declare const api: (hostname?: string | undefined) => {
         createMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
             memori: import("./types").Memori;
         }>;
-        updateMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
+        updateMemori: (authToken: string, memori: Partial<import("./types").Memori> & {
+            memoriID: string;
+        }) => Promise<import("./types").ResponseSpec & {
             memori: import("./types").Memori;
         }>;
         deleteMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec>;
@@ -453,7 +477,9 @@ declare const api: (hostname?: string | undefined) => {
             createMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
                 memori: import("./types").Memori;
             }>;
-            updateMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
+            updateMemori: (authToken: string, memori: Partial<import("./types").Memori> & {
+                memoriID: string;
+            }) => Promise<import("./types").ResponseSpec & {
                 memori: import("./types").Memori;
             }>;
             deleteMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec>;

package/dist/memori-api-client.cjs.development.js

@@ -3132,6 +3132,107 @@ var unansweredQuestions = (function (apiUrl) {
   };
 });
 
+/****************************
+ *                          *
+ *       ContextVars        *
+ *                          *
+ ****************************/
+
+var contextVars = (function (apiUrl) {
+  return {
+    /**
+     * Gets a list of currently known context variables.
+     * @param {string} sessionId The session ID
+     */
+    getContextVars: function () {
+      var _getContextVars = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(sessionId) {
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                return _context.abrupt("return", apiFetcher("/ContextVars/" + sessionId, {
+                  method: 'GET',
+                  apiUrl: apiUrl
+                }));
+
+              case 1:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      }));
+
+      function getContextVars(_x) {
+        return _getContextVars.apply(this, arguments);
+      }
+
+      return getContextVars;
+    }(),
+
+    /**
+     * Gets a list of currently known context variable names.
+     * @param {string} sessionId The session ID
+     */
+    getContextVarNames: function () {
+      var _getContextVarNames = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(sessionId) {
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                return _context2.abrupt("return", apiFetcher("/ContextVarNames/" + sessionId, {
+                  method: 'GET',
+                  apiUrl: apiUrl
+                }));
+
+              case 1:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2);
+      }));
+
+      function getContextVarNames(_x2) {
+        return _getContextVarNames.apply(this, arguments);
+      }
+
+      return getContextVarNames;
+    }(),
+
+    /**
+     * /memori/v2/ContextVarValues/{strSessionID}/{contextVarName}
+     * @param {string} sessionId The session ID
+     * @param {string} contextVarName The name of the context variable
+     */
+    getContextVarValues: function () {
+      var _getContextVarValues = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(sessionId, contextVarName) {
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                return _context3.abrupt("return", apiFetcher("/ContextVarValues/" + sessionId + "/" + contextVarName, {
+                  method: 'GET',
+                  apiUrl: apiUrl
+                }));
+
+              case 1:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3);
+      }));
+
+      function getContextVarValues(_x3, _x4) {
+        return _getContextVarValues.apply(this, arguments);
+      }
+
+      return getContextVarValues;
+    }()
+  };
+});
+
 var engine = (function (apiUrl) {
   return _extends({
     correlationPairs: correlationPairs(apiUrl)
@@ -3161,7 +3262,9 @@ var engine = (function (apiUrl) {
     stats: stats(apiUrl)
   }, stats(apiUrl), {
     unansweredQuestions: unansweredQuestions(apiUrl)
-  }, unansweredQuestions(apiUrl));
+  }, unansweredQuestions(apiUrl), {
+    contextVars: contextVars(apiUrl)
+  }, contextVars(apiUrl));
 });
 
 var allowedMediaTypes = ['image/jpeg', 'image/png', 'image/jpg', 'image/gif', 'text/plain', 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/pdf', 'video/mp4', 'video/avi', 'audio/mpeg3', 'audio/wav', 'audio/mpeg', 'video/mpeg', 'model/gltf-binary'];
@@ -3246,6 +3349,10 @@ var getCultureCodeByLanguage = function getCultureCodeByLanguage(lang) {
 
   return voice;
 };
+/**
+ * EXPERIMENTAL
+ */
+
 
 var speech = function speech(AZURE_COGNITIVE_SERVICES_TTS_KEY, DEBUG) {
   if (DEBUG === void 0) {
@@ -3253,7 +3360,6 @@ var speech = function speech(AZURE_COGNITIVE_SERVICES_TTS_KEY, DEBUG) {
   }
 
   return function (lang, voiceType) {
-    speechSdk.Recognizer.enableTelemetry(false);
     var speechConfig = speechSdk.SpeechConfig.fromSubscription(AZURE_COGNITIVE_SERVICES_TTS_KEY, 'eastus');
     var speechSynthesizer;
     var audioDestination;