@memori.ai/memori-api-client 0.10.3 → 1.0.0

package/dist/types.d.ts

@@ -65,6 +65,7 @@ export declare type Memori = {
     disableR4Loop?: boolean;
     disableR5Loop?: boolean;
     enableCompletions?: boolean;
+    completionDescription?: string;
     chainingMemoriID?: string;
     chainingBaseURL?: string;
     chainingPassword?: string;
@@ -125,6 +126,7 @@ export declare type User = {
     flowID?: string;
     newsletterSubscribed?: boolean;
     maxMemori?: number;
+    maxCompletions?: number;
     canCreateMemori?: boolean;
     canAccessAPI?: boolean;
     canRunSnippets?: boolean;
@@ -139,6 +141,7 @@ export declare type User = {
     couponCode?: string;
     paying?: boolean;
     notificationPrefs?: NotificationPrefs[];
+    dontSendInvitationEmail?: boolean;
 };
 export declare type IntegrationResource = {
     name: string;
@@ -206,8 +209,11 @@ export declare type Tenant = {
     maxMemoriPerAdmin?: number;
     maxMemoriPerUser?: number;
     maxTotalMemori?: number;
+    memoriCount?: number;
     maxAdmins?: number;
+    adminCount?: number;
     maxUsers?: number;
+    userCount?: number;
     usersCanCreateMemori?: boolean;
     usersCanAccessAPI?: boolean;
     usersCanEditIntegrations?: boolean;
@@ -216,6 +222,9 @@ export declare type Tenant = {
     maxFreeSessions?: number;
     maxFreeSessionsPerUser?: number;
     nonFreeSessionCost?: number;
+    maxCompletions?: number;
+    maxCompletionsPerUser?: number;
+    paying?: boolean;
 };
 export declare type OpenSession = {
     memoriID: string;
@@ -450,10 +459,18 @@ export declare type Memory = {
     contextVarsToMatch?: {
         [variable: string]: string;
     };
+    /**
+     * Used for Unanswered Questions
+     */
+    contextVars?: {
+        [variable: string]: string;
+    };
     creationTimestamp?: string;
     creationName?: string;
+    creationSessionID?: string;
     lastChangeTimestamp?: string;
     lastChangeName?: string;
+    lastChangeSessionID?: string;
 };
 export declare type UnansweredQuestion = {
     unansweredQuestionID?: string;
@@ -464,15 +481,19 @@ export declare type UnansweredQuestion = {
     receiverName?: string;
     creationTimestamp?: string;
     creationName?: string;
+    creationSessionID?: string;
     lastChangeTimestamp?: string;
     lastChangeName?: string;
+    lastChangeSessionID?: string;
     suggestions?: SearchMatches[];
 };
 export declare type Message = {
+    memoryID?: string;
     text: string;
     translatedText?: string;
-    fromUser?: boolean;
+    acceptsFeedback?: boolean;
     generatedByAI?: boolean;
+    fromUser?: boolean;
     media?: Medium[];
     initial?: boolean;
     timestamp?: string;
@@ -489,6 +510,7 @@ export declare type ConsumptionLog = {
     memoriID?: string;
     totalSessions: number;
     validSessions: number;
+    completions: number;
 };
 export declare type Notification = {
     notificationID: string;
@@ -554,6 +576,17 @@ export declare type ChatLogLine = {
     contextVars?: {
         [key: string]: string;
     };
+    /**
+     * @type {boolean}
+     * If True the text is a complation obtained via a generative AI. Can only be True for outbound lines.
+     */
+    completion?: boolean;
+    /**
+     * @type {boolean}
+     * If True the line is the result of a high confidence Memory object match, and as such can be subject to feedback.
+     * Can only be True for outbound lines.
+     */
+    acceptsFeedback?: boolean;
 };
 export declare type ChatLog = {
     /**
@@ -587,6 +620,13 @@ export declare type ChatLog = {
      */
     lines: ChatLogLine[];
 };
+export declare type CorrelationPair = {
+    pairID?: string;
+    text1: string;
+    text2: string;
+    correlated: boolean;
+    occurrencies?: number;
+};
 export declare type Utterance = {
     /**
      * Utterance object ID.
@@ -761,3 +801,40 @@ 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[];
+    hasHeaders?: boolean;
+    headerNames?: string[];
+    forceImport?: boolean;
+    questionColumnName: string;
+    answerColumnName: string;
+    contextVarsToMatchColumnName?: string;
+    contextVarsToSetColumnName?: string;
+    csvSeparator?: string;
+    questionTitleVariantsSeparator?: string;
+};
+export declare type ExportCSVParams = {
+    newLine: '\n' | '\r\n';
+    hasHeaders?: boolean;
+    questionColumnName: string;
+    answerColumnName: string;
+    contextVarsToMatchColumnName?: string;
+    contextVarsToSetColumnName?: string;
+    csvSeparator?: string;
+    questionTitleVariantsSeparator?: string;
+};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.3",
+  "version": "1.0.0",
   "name": "@memori.ai/memori-api-client",
   "description": "React library to integrate a Memori in your app or website",
   "license": "Apache-2.0",
@@ -126,7 +126,6 @@
     "typescript": "4.7.4"
   },
   "dependencies": {
-    "cross-fetch": "^3.1.5",
-    "microsoft-cognitiveservices-speech-sdk": "1.20.0"
+    "cross-fetch": "^3.1.5"
   }
 }

package/src/engine/chatLogs.ts

@@ -29,6 +29,21 @@ export default (apiUrl: string) => ({
       }
     >,
 
+  /**
+   * Gets the Chat Log objects for the Memori of the current session recorded during a specific other session.
+   * @param {string} sessionId The session ID
+   * @param {string} chatLogSessionID The session ID for which Chat Log objects are being searched
+   */
+  getSessionChatLogs: async (sessionId: string, chatLogSessionID: string) =>
+    apiFetcher(`/SessionChatLogs/${sessionId}/${chatLogSessionID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        chatLogs: ChatLog[];
+      }
+    >,
+
   /**
    * Removes all Chat Log objects in a specific date internval.
    * @param {string} sessionId The session ID

package/src/engine/correlationPairs.ts

@@ -1,4 +1,4 @@
-import { ResponseSpec } from '../types';
+import { ResponseSpec, CorrelationPair } from '../types';
 import { apiFetcher } from '../apiFetcher';
 
 /****************************
@@ -11,12 +11,46 @@ export default (apiUrl: string) => ({
   /**
    * Lists all Correlation Pair objects.
    * @param {string} sessionId The session ID
+   * @param {number=} from The starting index
+   * @param {number=} howMany The number of items to return
    */
-  getCorrelationPairs: async (sessionId: string) =>
-    apiFetcher(`/CorrelationPairs/${sessionId}`, {
-      method: 'GET',
+  getCorrelationPairs: async (
+    sessionId: string,
+    from?: number,
+    howMany?: number
+  ) =>
+    apiFetcher(
+      `/CorrelationPairs/${sessionId}${
+        from ? `/${from}${howMany ? `/${howMany}` : ''}` : ''
+      }`,
+      {
+        method: 'GET',
+        apiUrl,
+      }
+    ) as Promise<
+      ResponseSpec & {
+        correlationPairs: CorrelationPair[];
+      }
+    >,
+
+  /**
+   * Adds a new Correlation Pair object.
+   * @param {string} sessionId The session ID
+   * @param {CorrelationPair} correlationPair The Correlation Pair object
+   */
+  postCorrelationPair: async (
+    sessionId: string,
+    correlationPair: CorrelationPair
+  ) =>
+    apiFetcher(`/CorrelationPair/${sessionId}`, {
+      method: 'POST',
       apiUrl,
-    }) as Promise<ResponseSpec>,
+      body: correlationPair,
+    }) as Promise<
+      ResponseSpec & {
+        correlationPair: CorrelationPair;
+      }
+    >,
 
   /**
    * Removes an existing Correlation Pair object.
@@ -25,7 +59,7 @@ export default (apiUrl: string) => ({
    */
   deleteCorrelationPair: async (sessionId: string, pairId: string) =>
     apiFetcher(`/CorrelationPair/${sessionId}/${pairId}`, {
-      method: 'GET',
+      method: 'DELETE',
       apiUrl,
     }) as Promise<ResponseSpec>,
 });

package/src/engine/importExport.ts

@@ -1,45 +1,11 @@
-import { ResponseSpec } from '../types';
+import {
+  ResponseSpec,
+  ImportReponse,
+  ImportCSVParams,
+  ExportCSVParams,
+} from '../types';
 import { apiFetcher } from '../apiFetcher';
 
-export interface ImportCSVParams {
-  includedRows?: number[];
-  hasHeaders?: boolean;
-  headerNames?: string[];
-  forceImport?: boolean;
-  questionColumnName: string;
-  answerColumnName: string;
-  contextVarsToMatchColumnName?: string;
-  contextVarsToSetColumnName?: string;
-  csvSeparator?: string;
-  questionTitleVariantsSeparator?: string;
-}
-
-export interface ExportCSVParams {
-  newLine: '\n' | '\r\n';
-  hasHeaders?: boolean;
-  questionColumnName: string;
-  answerColumnName: string;
-  contextVarsToMatchColumnName?: string;
-  contextVarsToSetColumnName?: string;
-  csvSeparator?: string;
-  questionTitleVariantsSeparator?: string;
-}
-
-export interface ImportReponse {
-  importID: string;
-  importedMemories?: number;
-  importWarnings?: {
-    warningType: 'Existing Similar Memory' | 'Internal Error';
-    rowNumber?: number;
-    csvRow: string;
-    text?: string;
-    similarTexts?: {
-      text: string;
-      similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
-    }[];
-  }[];
-}
-
 /************************
  *                      *
  *     ImportExport     *

package/src/engine/memories.ts

@@ -11,9 +11,13 @@ export default (apiUrl: string) => ({
   /**
    * Lists all Memory objects.
    * @param {string} sessionId The session ID
+   * @param {string=} type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS
    */
-  getMemories: async (sessionId: string) =>
-    apiFetcher(`/Memories/${sessionId}`, {
+  getMemories: async (
+    sessionId: string,
+    type?: 'ALL' | 'CONTENTS' | 'DEFAULTS' | 'DRAFTS'
+  ) =>
+    apiFetcher(`/Memories/${sessionId}${type ? `/${type}` : ''}`, {
       method: 'GET',
       apiUrl,
     }) as Promise<
@@ -27,7 +31,7 @@ export default (apiUrl: string) => ({
    * @param {string} sessionId The session ID
    * @param {number} from The starting index
    * @param {number} howMany The number of items to return
-   * @param {string=} type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS
+   * @param {string=} type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS
    */
   getMemoriesPaginated: async (
     sessionId: string,
@@ -91,7 +95,7 @@ export default (apiUrl: string) => ({
    * @param {string} sessionId The session ID
    * @param {Memory} memory The Memory object
    */
-  postMemory: async (sessionId: string, memory: Memory) =>
+  postMemory: async (sessionId: string, memory: Omit<Memory, 'memoryID'>) =>
     apiFetcher(`/Memory/${sessionId}`, {
       method: 'POST',
       apiUrl,

package/src/engine/unansweredQuestions.ts

@@ -41,6 +41,25 @@ export default (apiUrl: string) => ({
       }
     >,
 
+  /**
+   * Adds a new Unanswered Question object.
+   * @param {string} sessionId The session ID
+   * @param {UnansweredQuestion} unansweredQuestion The Unanswered Question object
+   */
+  postUnansweredQuestion: async (
+    sessionId: string,
+    unansweredQuestion: UnansweredQuestion
+  ) =>
+    apiFetcher(`/UnansweredQuestion/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: unansweredQuestion,
+    }) as Promise<
+      ResponseSpec & {
+        unansweredQuestion: UnansweredQuestion;
+      }
+    >,
+
   /**
    * Removes an existing Unanswered Question object.
    * @param {string} sessionId The session ID

package/src/index.ts

@@ -2,7 +2,6 @@ import { getApiUrl } from './helpers/getApiUrl';
 import backend from './backend';
 import engine from './engine';
 import * as constants from './constants';
-import speech from './speech';
 import asset from './helpers/asset';
 
 const api = (hostname?: string) => {
@@ -11,7 +10,6 @@ const api = (hostname?: string) => {
   return {
     backend: backend(`${apiUrl}/api/v2`),
     ...engine(`${apiUrl}/memori/v2`),
-    speech,
     constants,
     asset: asset(`${apiUrl}/api/v2`),
   };

package/src/types.ts

@@ -64,6 +64,7 @@ export declare type Memori = {
   disableR4Loop?: boolean;
   disableR5Loop?: boolean;
   enableCompletions?: boolean;
+  completionDescription?: string;
   chainingMemoriID?: string;
   chainingBaseURL?: string;
   chainingPassword?: string;
@@ -127,6 +128,7 @@ export declare type User = {
   flowID?: string;
   newsletterSubscribed?: boolean;
   maxMemori?: number;
+  maxCompletions?: number;
   canCreateMemori?: boolean;
   canAccessAPI?: boolean;
   canRunSnippets?: boolean;
@@ -141,6 +143,7 @@ export declare type User = {
   couponCode?: string;
   paying?: boolean;
   notificationPrefs?: NotificationPrefs[];
+  dontSendInvitationEmail?: boolean;
 };
 
 export declare type IntegrationResource = {
@@ -229,8 +232,11 @@ export declare type Tenant = {
   maxMemoriPerAdmin?: number;
   maxMemoriPerUser?: number;
   maxTotalMemori?: number;
+  memoriCount?: number;
   maxAdmins?: number;
+  adminCount?: number;
   maxUsers?: number;
+  userCount?: number;
   usersCanCreateMemori?: boolean;
   usersCanAccessAPI?: boolean;
   usersCanEditIntegrations?: boolean;
@@ -239,6 +245,9 @@ export declare type Tenant = {
   maxFreeSessions?: number;
   maxFreeSessionsPerUser?: number;
   nonFreeSessionCost?: number;
+  maxCompletions?: number;
+  maxCompletionsPerUser?: number;
+  paying?: boolean;
 };
 
 export declare type OpenSession = {
@@ -481,10 +490,16 @@ export declare type Memory = {
   maxTimeout?: number;
   contextVarsToSet?: { [variable: string]: string };
   contextVarsToMatch?: { [variable: string]: string };
+  /**
+   * Used for Unanswered Questions
+   */
+  contextVars?: { [variable: string]: string };
   creationTimestamp?: string;
   creationName?: string;
+  creationSessionID?: string;
   lastChangeTimestamp?: string;
   lastChangeName?: string;
+  lastChangeSessionID?: string;
 };
 
 export declare type UnansweredQuestion = {
@@ -496,16 +511,20 @@ export declare type UnansweredQuestion = {
   receiverName?: string;
   creationTimestamp?: string;
   creationName?: string;
+  creationSessionID?: string;
   lastChangeTimestamp?: string;
   lastChangeName?: string;
+  lastChangeSessionID?: string;
   suggestions?: SearchMatches[];
 };
 
 export declare type Message = {
+  memoryID?: string;
   text: string;
   translatedText?: string;
-  fromUser?: boolean;
+  acceptsFeedback?: boolean;
   generatedByAI?: boolean;
+  fromUser?: boolean;
   media?: Medium[];
   initial?: boolean;
   timestamp?: string;
@@ -521,6 +540,7 @@ export type ConsumptionLog = {
   memoriID?: string;
   totalSessions: number;
   validSessions: number;
+  completions: number;
 };
 
 export type Notification = {
@@ -585,6 +605,17 @@ export type ChatLogLine = {
    * Dialog State Machine context variables after the emission, if present. Empty if the line is inbound.
    */
   contextVars?: { [key: string]: string };
+  /**
+   * @type {boolean}
+   * If True the text is a complation obtained via a generative AI. Can only be True for outbound lines.
+   */
+  completion?: boolean;
+  /**
+   * @type {boolean}
+   * If True the line is the result of a high confidence Memory object match, and as such can be subject to feedback.
+   * Can only be True for outbound lines.
+   */
+  acceptsFeedback?: boolean;
 };
 
 export type ChatLog = {
@@ -621,6 +652,14 @@ export type ChatLog = {
   lines: ChatLogLine[];
 };
 
+export type CorrelationPair = {
+  pairID?: string;
+  text1: string;
+  text2: string;
+  correlated: boolean;
+  occurrencies?: number;
+};
+
 export type Utterance = {
   /**
    * Utterance object ID.
@@ -800,3 +839,44 @@ export type CustomWord = {
   lastChangeTimestamp: string;
   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[];
+  hasHeaders?: boolean;
+  headerNames?: string[];
+  forceImport?: boolean;
+  questionColumnName: string;
+  answerColumnName: string;
+  contextVarsToMatchColumnName?: string;
+  contextVarsToSetColumnName?: string;
+  csvSeparator?: string;
+  questionTitleVariantsSeparator?: string;
+};
+
+export type ExportCSVParams = {
+  newLine: '\n' | '\r\n';
+  hasHeaders?: boolean;
+  questionColumnName: string;
+  answerColumnName: string;
+  contextVarsToMatchColumnName?: string;
+  contextVarsToSetColumnName?: string;
+  csvSeparator?: string;
+  questionTitleVariantsSeparator?: string;
+};

package/dist/speech.d.ts

@@ -1,13 +0,0 @@
-import * as speechSdk from 'microsoft-cognitiveservices-speech-sdk';
-/**
- * EXPERIMENTAL
- */
-declare const speech: (AZURE_COGNITIVE_SERVICES_TTS_KEY: string, DEBUG?: boolean) => (lang: string, voiceType: 'FEMALE' | 'MALE') => {
-    speak: (text: string, onAudioEnd?: ((sender: speechSdk.IPlayer) => void) | undefined) => void;
-    isSpeaking: () => boolean;
-    stopSpeaking: () => void;
-    recognize: (onRecognized: (transcript: string) => void) => void;
-    isRecognizing: () => boolean;
-    stopRecognizing: (onStop?: (() => void) | undefined) => void;
-};
-export default speech;