@memori.ai/memori-api-client 0.1.0

package/src/engine/dialog.ts

@@ -0,0 +1,158 @@
+import { DialogState, Medium, ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/******************
+ *                *
+ *     Dialog     *
+ *                *
+ ******************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Submits a Text Entered event to the session's Dialog State Machine.
+   * @param {object} params
+   * @param {string} params.sessionId The session ID
+   * @param {string} params.text The text entered by the user
+   */
+  postTextEnteredEvent: async ({
+    sessionId,
+    text,
+  }: {
+    sessionId: string;
+    text: string;
+  }) =>
+    apiFetcher(`/TextEnteredEvent/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: {
+        text,
+      },
+    }) as Promise<
+      ResponseSpec & {
+        currentState: DialogState;
+      }
+    >,
+
+  /**
+   * Submits a Place Changed event to the session's Dialog State Machine.
+   * @param {object} params
+   * @param {string} params.sessionId - The session ID
+   * @param {string} params.placeName - The name of the place
+   * @param {number} params.latitude - The latitude of the place
+   * @param {number} params.longitude - The longitude of the place
+   * @param {number} params.uncertaintyKm - The uncertainty of the place in kilometers
+   */
+  postPlaceChangedEvent: async ({
+    sessionId,
+    placeName,
+    latitude,
+    longitude,
+    uncertaintyKm,
+  }: {
+    sessionId: string;
+    placeName: string;
+    latitude: number;
+    longitude: number;
+    uncertaintyKm?: number;
+  }) =>
+    apiFetcher(`/PlaceChangedEvent/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: {
+        placeName,
+        latitude,
+        longitude,
+        uncertaintyKm,
+      },
+    }) as Promise<
+      ResponseSpec & {
+        currentState: DialogState;
+      }
+    >,
+
+  /**
+   * Submits a Date Changed event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   */
+  postDateChangedEvent: async (sessionId: string) =>
+    apiFetcher(`/DateChangedEvent/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Submits a Tag Changed event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   * @param {string} tag The tag to set
+   */
+  postTagChangedEvent: async (sessionId: string, tag: string) =>
+    apiFetcher(`/TagChangedEvent/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: { tag },
+    }) as Promise<
+      ResponseSpec & {
+        currentState: DialogState;
+      }
+    >,
+
+  /**
+   * Submits a Timeout event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   */
+  postTimeoutEvent: async (sessionId: string) =>
+    apiFetcher(`/TimeoutEvent/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        currentState: DialogState;
+      }
+    >,
+
+  /**
+   * Submits a Medium Selected event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   * @param {Medium} medium The medium to set
+   */
+  postMediumSelectedEvent: async (sessionId: string, medium: Medium) =>
+    apiFetcher(`/MediumSelectedEvent/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: { medium },
+    }) as Promise<
+      ResponseSpec & {
+        currentState: DialogState;
+      }
+    >,
+
+  /**
+   * Submits a Date Selected event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   */
+  postDateSelectedEvent: async ({ sessionId }: { sessionId: string }) =>
+    apiFetcher(`/DateSelectedEvent/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Submits a Place Selected event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   */
+  postPlaceSelectedEvent: async ({ sessionId }: { sessionId: string }) =>
+    apiFetcher(`/PlaceSelectedEvent/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Submits a Tag Selected event to the session's Dialog State Machine.
+   * @param {string} sessionId The session ID
+   */
+  postTagSelectedEvent: async ({ sessionId }: { sessionId: string }) =>
+    apiFetcher(`/TagSelectedEvent/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/importExport.ts

@@ -0,0 +1,43 @@
+import { ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export interface ImportExportBody {
+  csvRows: string[];
+  questionColumnName: string;
+  answerColumnName: string;
+  propertyColumnNames: string[];
+  includedRows: number[];
+  csvSeparator: string;
+  questionTitleVariantsSeparator: string;
+  hasHeaders: boolean;
+  forceImport: boolean;
+  headerNames: string[];
+}
+
+export interface ImportExportReponse {
+  importID: string;
+  importedMemories: number;
+  importWarnings?: {
+    warningType: string;
+  }[];
+}
+
+/************************
+ *                      *
+ *     ImportExport     *
+ *                      *
+ ************************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Imports memories from a CSV file.
+   * @param {string} sessionId The session ID
+   * @param {ImportExportBody} csvData The CSV content info to import
+   */
+  postImportExport: async (sessionId: string, csvData: ImportExportBody) =>
+    apiFetcher(`/ImportExport/ImportCSV/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: csvData,
+    }) as Promise<ResponseSpec & ImportExportReponse>,
+});

package/src/engine/intents.ts

@@ -0,0 +1,116 @@
+import { ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/*******************
+ *                 *
+ *     Intents     *
+ *                 *
+ *******************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Intent objects.
+   * @param {string} sessionId The session ID
+   */
+  getIntents: async (sessionId: string) =>
+    apiFetcher(`/Intents/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of an Intent object.
+   * @param {string} sessionId The session ID
+   * @param {string} intentId The Intent object ID
+   */
+  getIntent: async (sessionId: string, intentId: string) =>
+    apiFetcher(`/Intent/${sessionId}/${intentId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Updates an existing Intent object.
+   * @param {string} sessionId The session ID
+   * @param {string} intentId The Intent object ID
+   */
+  patchIntent: async (sessionId: string, intentId: string) =>
+    apiFetcher(`/Intent/${sessionId}/${intentId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Removes an existing Intent object.
+   * @param {string} sessionId The session ID
+   * @param {string} intentId The Intent object ID
+   */
+  deleteIntent: async (sessionId: string, intentId: string) =>
+    apiFetcher(`/Intent/${sessionId}/${intentId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Adds a new Intent object.
+   * @param {string} sessionId The session ID
+   */
+  postIntent: async (sessionId: string) =>
+    apiFetcher(`/Intent/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Lists all Intent Slot objects.
+   * @param {string} sessionId The session ID
+   */
+  getIntentSlots: async (sessionId: string) =>
+    apiFetcher(`/IntentSlots/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of an Intent Slot object.
+   * @param {string} sessionId The session ID
+   * @param {string} slotId The Intent Slot object ID
+   */
+  getIntentSlot: async (sessionId: string, slotId: string) =>
+    apiFetcher(`/IntentSlot/${sessionId}/${slotId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Updates an existing Intent Slot object.
+   * @param {string} sessionId The session ID
+   * @param {string} slotId The Intent Slot object ID
+   */
+  patchIntentSlot: async (sessionId: string, slotId: string) =>
+    apiFetcher(`/IntentSlot/${sessionId}/${slotId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Removes an existing Intent Slot object.
+   * @param {string} sessionId The session ID
+   * @param {string} slotId The Intent Slot object ID
+   */
+  deleteIntentSlot: async (sessionId: string, slotId: string) =>
+    apiFetcher(`/IntentSlot/${sessionId}/${slotId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Adds a new Intent Slot object.
+   * @param {string} sessionId The session ID
+   */
+  postIntentSlot: async (sessionId: string) =>
+    apiFetcher(`/IntentSlot/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/localizationKeys.ts

@@ -0,0 +1,94 @@
+import {
+  ResponseSpec,
+  LocalizationKey,
+  LocalizationKeyContent,
+} from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/****************************
+ *                          *
+ *     LocalizationKeys     *
+ *                          *
+ ****************************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Localizaiton Keys.
+   * @param {string} sessionId The session ID
+   */
+  getLocalizationKeys: async (sessionId: string) =>
+    apiFetcher(`/LocalizationKeys/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        localizationKeys: LocalizationKey[];
+      }
+    >,
+
+  /**
+   * Get an existing Localizaiton Key.
+   * @param {string} sessionId The session ID
+   * @param {string} key The key of the Localization Key
+   */
+  getLocalizationKey: async (sessionId: string, key: string) =>
+    apiFetcher(`/LocalizationKey/${sessionId}/${key}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        localizationKey: LocalizationKey;
+      }
+    >,
+
+  /**
+   * Removes an existing Localizaiton Key. This is only possible if the key is part of
+   *  a key set, where a key set is a set of keys of a common prefix and an index,
+   *  e.g.: <code>INPUT_QUIT_1</code>, <code>INPUT_QUIT_2</code> etc.
+   *  Any index can be specified, the key set will be reordered appropriately.
+   * @param {string} sessionId The session ID
+   * @param {string} key The key of the Localization Key
+   */
+  deleteLocalizationKey: async (sessionId: string, key: string) =>
+    apiFetcher(`/LocalizationKey/${sessionId}/${key}`, {
+      method: 'DELETE',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Add an new Localization Key. This is only possible if the key is part of
+   *  a key set, where a key set is a set of keys of a common prefix and an index,
+   *  e.g.: <code>INPUT_QUIT_1</code>, <code>INPUT_QUIT_2</code> etc.
+   *  Any index can be specified, the key set will be reordered appropriately.
+   * @param {string} sessionId The session ID
+   * @param {LocalizaitonKeyContent} localizationKey Localization Key
+   */
+  postLocalizationKey: async (
+    sessionId: string,
+    localizationKey: LocalizationKeyContent
+  ) =>
+    apiFetcher(`/LocalizationKey/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: localizationKey,
+    }) as Promise<
+      ResponseSpec & {
+        localizationKey: LocalizationKey;
+      }
+    >,
+
+  /**
+   * Updates an existing Localization Key.
+   * @param {string} sessionId The session ID
+   * @param {LocalizationKey} localizationKey Localization Key
+   */
+  patchLocalizationKey: async (
+    sessionId: string,
+    localizationKey: LocalizationKey
+  ) =>
+    apiFetcher(`/LocalizationKey/${sessionId}`, {
+      method: 'PATCH',
+      apiUrl,
+      body: localizationKey,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/media.ts

@@ -0,0 +1,79 @@
+import { ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/*****************
+ *               *
+ *     Media     *
+ *               *
+ *****************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Medium objects of a Memory.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   */
+  getMedia: async (sessionId: string, memoryId: string) =>
+    apiFetcher(`/Media/${sessionId}/${memoryId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Removes all Medium objects from a Memory.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   */
+  deleteMedia: async (sessionId: string, memoryId: string) =>
+    apiFetcher(`/Media/${sessionId}/${memoryId}`, {
+      method: 'DELETE',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of a Medium object of a Memory.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   * @param {string} mediumId The Medium object ID
+   */
+  getMedium: async (sessionId: string, memoryId: string, mediumId: string) =>
+    apiFetcher(`/Medium/${sessionId}/${memoryId}/${mediumId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Updates an existing Medium object of a Memory.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   * @param {string} mediumId The Medium object ID
+   */
+  patchMedium: async (sessionId: string, memoryId: string, mediumId: string) =>
+    apiFetcher(`/Medium/${sessionId}/${memoryId}/${mediumId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Removes an existing Medium object from a Memory.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   * @param {string} mediumId The Medium object ID
+   */
+  deleteMedium: (sessionId: string, memoryId: string, mediumId: string) =>
+    apiFetcher(`/Medium/${sessionId}/${memoryId}/${mediumId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Adds a new Medium object to a Memory.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   */
+  postMedium: async (sessionId: string, memoryId: string) =>
+    apiFetcher(`/Medium/${sessionId}/${memoryId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/memori.ts

@@ -0,0 +1,51 @@
+import { ResponseSpec, Memori } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/******************
+ *                *
+ *     Memori     *
+ *                *
+ ******************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Registration of a new Memori object.
+   * @param {Memori} memori - The Memori object
+   */
+  postMemori: async (memori: Partial<Omit<Memori, 'memoriID'>>) =>
+    apiFetcher(`/Memori`, {
+      method: 'POST',
+      apiUrl,
+      body: memori,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Updates an existing Memori object.
+   * @param {Memori} memori - The Memori object
+   */
+  patchMemori: async (memori: Partial<Memori> & { memoriID: string }) =>
+    apiFetcher(`/Memori/${memori.memoriID}`, {
+      method: 'PATCH',
+      apiUrl,
+      body: memori,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Deletes an existing Memori object.
+   * @param {string} memoriId The Memori object ID
+   */
+  deleteMemori: async (memoriId: string) =>
+    apiFetcher(`/Memori/${memoriId}`, {
+      method: 'DELETE',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Lists Memori objects, with optional filtering.
+   */
+  postSearchMemori: async () =>
+    apiFetcher(`/SearchMemori`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/memories.ts

@@ -0,0 +1,89 @@
+import { Memory, ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/********************
+ *                  *
+ *     Memories     *
+ *                  *
+ ********************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Memory objects.
+   * @param {string} sessionId The session ID
+   */
+  getMemories: async (sessionId: string) =>
+    apiFetcher(`/Memories/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memories: Memory[];
+      }
+    >,
+
+  /**
+   * Gets the details of a Memory object.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   */
+  getMemory: async (sessionId: string, memoryId: string) =>
+    apiFetcher(`/Memory/${sessionId}/${memoryId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memory: Memory;
+      }
+    >,
+
+  /**
+   * Updates an existing Memory object.
+   * @param {string} sessionId The session ID
+   * @param {Memory} memory The Memory object
+   */
+  patchMemory: async (sessionId: string, memory: Memory) =>
+    apiFetcher(`/Memory/${sessionId}/${memory.memoryID}`, {
+      method: 'PATCH',
+      apiUrl,
+      body: memory,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Removes an existing Memory object.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   */
+  deleteMemory: async (sessionId: string, memoryId: string) =>
+    apiFetcher(`/Memory/${sessionId}/${memoryId}`, {
+      method: 'DELETE',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Adds a new Memory object.
+   * @param {string} sessionId The session ID
+   * @param {Memory} memory The Memory object
+   */
+  postMemory: async (sessionId: string, memory: Memory) =>
+    apiFetcher(`/Memory/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: memory,
+    }) as Promise<
+      ResponseSpec & {
+        memoryID: string;
+      }
+    >,
+
+  /**
+   * Checks if a Memory object is accessible from the specified session.
+   * @param {string} sessionId The session ID
+   * @param {string} memoryId The Memory object ID
+   */
+  getMemoryAccess: async (sessionId: string, memoryId: string) =>
+    apiFetcher(`/MemoryAccess/${sessionId}/${memoryId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/nlp.ts

@@ -0,0 +1,39 @@
+import { ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/***************
+ *             *
+ *     NLP     *
+ *             *
+ ***************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Looks up the vector definition for a word.
+   * @param {string} sessionId The session ID
+   * @param {string} word Word to be looked up
+   */
+  getWordVector: async (sessionId: string, word: string) =>
+    apiFetcher(`/WordVector/${sessionId}/${word}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Tries to guess the language of a sentence by analyzing key word occurrences.
+   * @param {string} sessionId The session ID
+   * @param {string} text Text to be used for guessing the language.
+   */
+  guessLanguage: async (sessionId: string, text: string) =>
+    apiFetcher(`/GuessLanguage/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: { text },
+    }) as Promise<
+      ResponseSpec & {
+        languageGuesses: {
+          [lang: string]: number;
+        };
+      }
+    >,
+});