@memori.ai/memori-api-client 2.3.0 → 2.5.0

package/esm/types.d.ts

@@ -49,19 +49,23 @@ export declare type Memori = {
     publishedInTheMetaverse?: boolean;
     metaverseEnvironment?: string;
     exposed?: boolean;
-    ageRestriction?: number;
-    nsfw?: boolean;
     disableR2R3Loop?: boolean;
     disableR4Loop?: boolean;
     disableR5Loop?: boolean;
+    ageRestriction?: number;
+    nsfw?: boolean;
     enableCompletions?: boolean;
     completionDescription?: string;
+    completionProvider?: '-' | 'OpenAI';
+    completionProviderConfig?: string;
+    enableDeepThought?: boolean;
+    disableCompletionMediaExtraction?: boolean;
     chainingMemoriID?: string;
     chainingBaseURL?: string;
     chainingPassword?: string;
-    properties?: {
-        [key: string]: any;
-    };
+    properties?: [{
+        [key: string]: string;
+    }];
     creationTimestamp?: string;
     lastChangeTimestamp?: string;
     blockedUntil?: string;
@@ -106,22 +110,30 @@ export declare type User = {
     canEditIntegrations?: boolean;
     canEditDynamicIntents?: boolean;
     canEditMemoriChaining?: boolean;
+    enableBadges?: boolean;
     monthSessions?: number;
     monthValidSessions?: number;
     maxFreeSessions?: number;
     nonFreeSessionCost?: number;
     monthCompletions?: number;
     maxCompletions?: number;
+    monthImportedSize?: number;
+    maxImportSize?: number;
     creationTimestamp?: string;
     lastChangeTimestamp?: string;
     referral?: string;
     couponCode?: string;
+    defaultCompletionProvider?: '-' | 'OpenAI';
+    defaultCompletionProviderConfig?: string;
     paying?: boolean;
     notificationPrefs?: NotificationPrefs[];
     birthDate?: string;
     age?: number;
     tnCAndPPAccepted?: boolean;
     tnCAndPPAcceptanceDate?: string;
+    avatarURL?: string;
+    avatar3DURL?: string;
+    avatar3DURLType?: string;
 };
 export declare type IntegrationResource = {
     name: string;
@@ -311,6 +323,7 @@ export declare type DialogState = {
     confidence?: number;
     confidenceLevel?: 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
     emission?: string;
+    emitter?: string;
     completion?: boolean;
     continuationEmitted?: boolean;
     lastMatchedMemoryID?: string;
@@ -424,7 +437,7 @@ export declare type Answer = {
 };
 export declare type Memory = {
     memoryID: string;
-    memoryType: string;
+    memoryType: 'Question' | 'Story' | 'Default' | 'CompletionDraft' | 'ExpertReference';
     lastRead?: string;
     readOccurrences?: number;
     receiverID?: string;
@@ -489,6 +502,7 @@ export declare type Message = {
     fromUser?: boolean;
     media?: Medium[];
     initial?: boolean;
+    emitter?: string;
     timestamp?: string;
     contextVars?: {
         [key: string]: string;
@@ -504,6 +518,12 @@ export type ConsumptionLog = {
     totalSessions: number;
     validSessions: number;
     completions: number;
+    promptTokens: {
+        [key: string]: number;
+    };
+    completionTokens: {
+        [key: string]: number;
+    };
 };
 export type Notification = {
     notificationID: string;
@@ -609,6 +629,10 @@ export interface TxtSpecs {
     sourceAttachmentTitle?: string;
     questionsGenerationInstructions?: string;
 }
+export interface JSONLSpecs {
+    platform?: string;
+    includeInstructions?: boolean;
+}
 export interface ImportParams {
     forceImport?: boolean;
     csvSpecs?: CsvSpecs;
@@ -642,6 +666,7 @@ export interface ImportResponse {
     end?: string;
     eta?: number;
     importedMemories?: number;
+    importWarningsCount?: number;
     importWarnings?: ImportWarning[];
 }
 export interface Badge {
@@ -656,3 +681,16 @@ export interface Badge {
     issuerEmail?: string;
     issuerURL?: string;
 }
+export interface ExpertReference {
+    expertID: string;
+    name: string;
+    description: string;
+    default?: boolean;
+    expertMemoriID: string;
+    expertPassword?: string;
+    expertBaseURL: string;
+    creationTimestamp?: string;
+    creationSessionID?: string;
+    lastChangeTimestamp?: string;
+    lastChangeSessionID?: string;
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.3.0",
+  "version": "2.5.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

@@ -5,17 +5,23 @@ export default (apiUrl: string) => ({
   /**
    * URL to upload a file creating a new Asset object to access it.
    * @param {string} authToken - The login token
-   * @param {string} memoriID - The memori ID
+   * @param {string=} memoriID - The memori ID
    * @param {string=} memoryID - The memory ID
    * @returns The URL to upload a file
    */
-  getUploadAssetURL: (authToken: string, memoriID: string, memoryID?: string) =>
-    `${apiUrl}/Asset/${authToken}/${memoriID}${memoryID ? `/${memoryID}` : ''}`,
+  getUploadAssetURL: (
+    authToken: string,
+    memoriID?: string,
+    memoryID?: string
+  ) =>
+    `${apiUrl}/Asset/${authToken}${memoriID ? `/${memoriID}` : ''}${
+      memoryID ? `/${memoryID}` : ''
+    }`,
 
   /**
    * Uploads a file and creates a new Asset object to access it.
    * @param {string} authToken - The login token
-   * @param {string} memoriID - The memori ID
+   * @param {string=} memoriID - The memori ID
    * @param {string=} memoryID - The memory ID
    * @returns Response of an Upload Asset request.
    */
@@ -23,7 +29,7 @@ export default (apiUrl: string) => ({
     fileName: string,
     fileUrl: string,
     authToken: string,
-    memoriID: string,
+    memoriID?: string,
     memoryID?: string
   ) => {
     const data = new FormData();
@@ -33,7 +39,7 @@ export default (apiUrl: string) => ({
     data.append(fileName, fileBlob, fileName);
 
     const upload = await fetch(
-      `${apiUrl}/Asset/${authToken}/${memoriID}${
+      `${apiUrl}/Asset/${authToken}${memoriID ? `/${memoriID}` : ''}${
         memoryID ? `/${memoryID}` : ''
       }`,
       {

package/src/backend/importExport.ts

@@ -3,6 +3,7 @@ import type {
   ImportParams,
   ImportResponse,
   CsvSpecs,
+  JSONLSpecs,
 } from '../types';
 import { apiFetcher } from '../apiFetcher';
 
@@ -132,4 +133,28 @@ export default (apiUrl: string) => ({
       },
       text: true,
     }) as Promise<string>,
+
+  /**
+   * Exports contents of a Memori object to a JSONL file, suitable for fine-tuning with generative AI platforms.
+   * @param {string} authToken - The login token.
+   * @param {string} memoriID - The ID of the Memori object.
+   * @param {JSONLSpecs} jsonlSpecs - Specifications for requests involving import/export of JSONL contents.
+   * @param {string=} password - Memori password, if its privacy model is set to Secret.
+   * @returns The JSONL file content
+   */
+  exportJSONL: async (
+    authToken: string,
+    memoriID: string,
+    jsonlSpecs: JSONLSpecs,
+    password?: string
+  ) =>
+    apiFetcher(`/ImportExport/ExportJSONL/${authToken}/${memoriID}`, {
+      apiUrl,
+      method: 'POST',
+      body: {
+        jsonlSpecs,
+        password,
+      },
+      text: true,
+    }) as Promise<string>,
 });

package/src/backend/memori.ts

@@ -8,7 +8,7 @@ export default (apiUrl: string) => ({
    * @returns A list of Memori objects
    */
   getTenantPublicMemoriList: (tenant: string) =>
-    apiFetcher(`/TenantPublicMemori/${encodeURI(tenant)}`, {
+    apiFetcher(`/TenantPublicMemori/${encodeURIComponent(tenant)}`, {
       apiUrl,
     }) as Promise<
       ResponseSpec & {
@@ -22,7 +22,7 @@ export default (apiUrl: string) => ({
    * @returns A list of Memori objects
    */
   getTenantMetaverseMemoriList: (tenant: string) =>
-    apiFetcher(`/TenantMetaverseMemori/${encodeURI(tenant)}`, {
+    apiFetcher(`/TenantMetaverseMemori/${encodeURIComponent(tenant)}`, {
       apiUrl,
     }) as Promise<
       ResponseSpec & {
@@ -142,7 +142,7 @@ export default (apiUrl: string) => ({
    * @returns A list of Memori categories
    */
   getTenantCategories: (tenant: string) =>
-    apiFetcher(`/TenantMemoriCategories/${encodeURI(tenant)}`, {
+    apiFetcher(`/TenantMemoriCategories/${encodeURIComponent(tenant)}`, {
       apiUrl,
     }) as Promise<
       ResponseSpec & {
@@ -253,9 +253,9 @@ export default (apiUrl: string) => ({
     authToken?: string
   ) =>
     apiFetcher(
-      `/Memori/${encodeURI(tenant)}/${encodeURI(userName)}/${encodeURI(
-        memoriName
-      )}/${authToken ?? ''}`,
+      `/Memori/${encodeURIComponent(tenant)}/${encodeURIComponent(
+        userName
+      )}/${encodeURIComponent(memoriName)}/${authToken ?? ''}`,
       {
         apiUrl,
       }

package/src/engine/expertReferences.test.ts

@@ -0,0 +1,19 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/expertReferences api', () => {
+  it('works on expertReferences apis', async () => {
+    expect(
+      await client.expertReferences.getExpertReferences(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on chatLogs apis with shorthand version', async () => {
+    expect(
+      await client.getExpertReferences('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+});

package/src/engine/expertReferences.ts

@@ -0,0 +1,120 @@
+import type { ResponseSpec, ExpertReference } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/************************
+ *                      *
+ *   Expert References  *
+ *                      *
+ ************************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Expert Reference objects.
+   * @param {string} sessionId The session ID
+   */
+  getExpertReferences: async (sessionId: string) =>
+    apiFetcher(`/ExpertReferences/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Expert Reference objects.
+         */
+        count: number;
+        /**
+         * List of Expert Reference objects. May be empty.
+         */
+        experts: ExpertReference[];
+      }
+    >,
+
+  /**
+   * Lists Expert Reference objects with pagination.
+   * @param {string} sessionId The session ID
+   * @param {number} from The 0-based index of the first Expert Reference object to list
+   * @param {number} howMany The number of the Expert Reference objects to list
+   */
+  getExpertReferencesPaginated: async (
+    sessionId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/ExpertReferences/${sessionId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Expert Reference objects.
+         */
+        count: number;
+        /**
+         * List of Expert Reference objects. May be empty.
+         */
+        experts: ExpertReference[];
+      }
+    >,
+
+  /**
+   * Gets the details of an Expert Reference object.
+   * @param {string} sessionId The session ID
+   * @param {string} expertID The Expert Reference object ID
+   */
+  getExpertReference: async (sessionId: string, expertID: string) =>
+    apiFetcher(`/ExpertReference/${sessionId}/${expertID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        expert: ExpertReference;
+      }
+    >,
+
+  /**
+   * Updates an existing Expert Reference object.
+   * @param {string} sessionId The session ID
+   * @param {ExpertReference} expertReference The Expert Reference object
+   */
+  updateExpertReference: async (
+    sessionId: string,
+    expertReference: Partial<ExpertReference> & {
+      expertID: ExpertReference['expertID'];
+    }
+  ) =>
+    apiFetcher(`/ExpertReference/${sessionId}/${expertReference.expertID}`, {
+      method: 'PATCH',
+      apiUrl,
+      body: expertReference,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Adds a new Expert Reference object.
+   * @param {string} sessionId The session ID
+   * @param {ExpertReference} expertReference The Expert Reference object
+   */
+  createExpertReference: async (
+    sessionId: string,
+    expertReference: Omit<Partial<ExpertReference>, 'expertID'>
+  ) =>
+    apiFetcher(`/ExpertReference/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: expertReference,
+    }) as Promise<
+      ResponseSpec & {
+        expertID: ExpertReference['expertID'];
+      }
+    >,
+
+  /**
+   * Removes an existing Expert Reference object.
+   * @param {string} sessionId The session ID
+   * @param {string} expertID The Expert Reference object ID
+   */
+  deleteExpertReference: async (sessionId: string, expertID: string) =>
+    apiFetcher(`/ExpertReference/${sessionId}/${expertID}`, {
+      method: 'DELETE',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});

package/src/engine/memories.ts

@@ -11,11 +11,11 @@ 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
+   * @param {string=} type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES
    */
   getMemories: async (
     sessionId: string,
-    type?: 'ALL' | 'CONTENTS' | 'DEFAULTS' | 'DRAFTS'
+    type?: 'ALL' | 'CONTENTS' | 'DEFAULTS' | 'DRAFTS' | 'EXPERT_REFERENCES'
   ) =>
     apiFetcher(`/Memories/${sessionId}${type ? `/${type}` : ''}`, {
       method: 'GET',
@@ -31,13 +31,13 @@ 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, DRAFTS
+   * @param {string=} type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES
    */
   getMemoriesPaginated: async (
     sessionId: string,
     from: number,
     howMany: number,
-    type?: 'ALL' | 'CONTENTS' | 'DEFAULTS' | 'DRAFTS'
+    type?: 'ALL' | 'CONTENTS' | 'DEFAULTS' | 'DRAFTS' | 'EXPERT_REFERENCES'
   ) =>
     apiFetcher(
       `/Memories/${sessionId}/${from}/${howMany}${type ? `/${type}` : ''}`,

package/src/engine.ts

@@ -14,6 +14,7 @@ import unansweredQuestions from './engine/unansweredQuestions';
 import contextVars from './engine/contextVars';
 import customDictionary from './engine/customDictionary';
 import chatLogs from './engine/chatLogs';
+import expertReferences from './engine/expertReferences';
 
 export default (apiUrl: string) => ({
   correlationPairs: correlationPairs(apiUrl),
@@ -48,4 +49,6 @@ export default (apiUrl: string) => ({
   ...customDictionary(apiUrl),
   chatLogs: chatLogs(apiUrl),
   ...chatLogs(apiUrl),
+  expertReferences: expertReferences(apiUrl),
+  ...expertReferences(apiUrl),
 });

package/src/types.ts

@@ -60,17 +60,30 @@ export declare type Memori = {
   publishedInTheMetaverse?: boolean;
   metaverseEnvironment?: string;
   exposed?: boolean;
-  ageRestriction?: number;
-  nsfw?: boolean;
   disableR2R3Loop?: boolean;
   disableR4Loop?: boolean;
   disableR5Loop?: boolean;
+  ageRestriction?: number;
+  nsfw?: boolean;
   enableCompletions?: boolean;
   completionDescription?: string;
+  completionProvider?: '-' | 'OpenAI';
+  /**
+   * Format: chiave1:valore1|chiave2:valore2|...|chiaveN:valoreN
+   *
+   * OpenAI accetta i seguenti:
+   * - APIKey è l'API key
+   * - Model è il nome del modello: gpt-3.5-turbo, gpt-4 ecc.
+   * - MaxTokens è il numero massimo di token in output
+   * - Temperature è la temperature
+   */
+  completionProviderConfig?: string;
+  enableDeepThought?: boolean;
+  disableCompletionMediaExtraction?: boolean;
   chainingMemoriID?: string;
   chainingBaseURL?: string;
   chainingPassword?: string;
-  properties?: { [key: string]: any };
+  properties?: [{ [key: string]: string }];
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
   blockedUntil?: string;
@@ -138,22 +151,39 @@ export declare type User = {
   canEditIntegrations?: boolean;
   canEditDynamicIntents?: boolean;
   canEditMemoriChaining?: boolean;
+  enableBadges?: boolean;
   monthSessions?: number;
   monthValidSessions?: number;
   maxFreeSessions?: number;
   nonFreeSessionCost?: number;
   monthCompletions?: number;
   maxCompletions?: number;
+  monthImportedSize?: number;
+  maxImportSize?: number;
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
   referral?: string;
   couponCode?: string;
+  defaultCompletionProvider?: '-' | 'OpenAI';
+  /**
+   * Format: chiave1:valore1|chiave2:valore2|...|chiaveN:valoreN
+   *
+   * OpenAI accetta i seguenti:
+   * - APIKey è l'API key
+   * - Model è il nome del modello: gpt-3.5-turbo, gpt-4 ecc.
+   * - MaxTokens è il numero massimo di token in output
+   * - Temperature è la temperature
+   */
+  defaultCompletionProviderConfig?: string;
   paying?: boolean;
   notificationPrefs?: NotificationPrefs[];
   birthDate?: string;
   age?: number;
   tnCAndPPAccepted?: boolean;
   tnCAndPPAcceptanceDate?: string;
+  avatarURL?: string;
+  avatar3DURL?: string;
+  avatar3DURLType?: string;
 };
 
 export declare type IntegrationResource = {
@@ -371,6 +401,7 @@ export declare type DialogState = {
   confidence?: number;
   confidenceLevel?: 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
   emission?: string;
+  emitter?: string;
   completion?: boolean;
   continuationEmitted?: boolean;
   lastMatchedMemoryID?: string;
@@ -490,7 +521,12 @@ export declare type Answer = {
 
 export declare type Memory = {
   memoryID: string;
-  memoryType: string;
+  memoryType:
+    | 'Question'
+    | 'Story'
+    | 'Default'
+    | 'CompletionDraft'
+    | 'ExpertReference';
   lastRead?: string;
   readOccurrences?: number;
   receiverID?: string;
@@ -554,6 +590,7 @@ export declare type Message = {
   fromUser?: boolean;
   media?: Medium[];
   initial?: boolean;
+  emitter?: string;
   timestamp?: string;
   contextVars?: { [key: string]: string };
 };
@@ -568,6 +605,8 @@ export type ConsumptionLog = {
   totalSessions: number;
   validSessions: number;
   completions: number;
+  promptTokens: { [key: string]: number };
+  completionTokens: { [key: string]: number };
 };
 
 export type Notification = {
@@ -907,6 +946,21 @@ export interface TxtSpecs {
   questionsGenerationInstructions?: string;
 }
 
+export interface JSONLSpecs {
+  /**
+   * @type {string=}
+   * Name of the platform for which the JSONL is intended.
+   * Currently supported values are:
+   * - OpenAI: the OpenAI platform
+   */
+  platform?: string;
+  /**
+   * @type {boolean=}
+   * If True the JSONL includes the instructions for the generative AI, i.e. the "System" role of each message. Used only in Export operations.
+   */
+  includeInstructions?: boolean;
+}
+
 export interface ImportParams {
   forceImport?: boolean;
   csvSpecs?: CsvSpecs;
@@ -1006,6 +1060,10 @@ export interface ImportResponse {
    * Number of Imported Memory objects so far.
    */
   importedMemories?: number;
+  /**
+   * Number of Import Warning objects
+   */
+  importWarningsCount?: number;
   /**
    * List of Import Warning objects. May be empty.
    */
@@ -1024,3 +1082,46 @@ export interface Badge {
   issuerEmail?: string;
   issuerURL?: string;
 }
+
+export interface ExpertReference {
+  /**
+   * @type {string}
+   * Expert Reference object ID. Returned during Get operations. Ignored in other cases.
+   */
+  expertID: string;
+  /**
+   * @type {string}
+   * Name of the expert. Returned during Get operations. Required during Add operations. Optional during Update operations.
+   */
+  name: string;
+  /**
+   * @type {string}
+   * Description of the expert, i.e. a list of the expert's skills and knowledge. Returned during Get operations. Required during Add operations. Optional during Update operations.
+   */
+  description: string;
+  /**
+   * @type {boolean}
+   * If True, this expert is used when no other expert is competent for the current question. Returned during Get operations. Optional during Add operations. Optional during Update operations.
+   */
+  default?: boolean;
+  /**
+   * @type {string}
+   * ID of the expert Memori. Returned during Get operations. Required during Add operations. Optional during Update operations.
+   * NOTE: engine memroi ID
+   */
+  expertMemoriID: string;
+  /**
+   * @type {string=}
+   * Password of the expert Memori. Required if the chained Memori is private or secret. Optional during Add operations and Update operations. Ignore in other cases.
+   */
+  expertPassword?: string;
+  /**
+   * @type {string}
+   * Base URL of a chained Memori, typically https://engine.memori.ai/. Returned during Get operations. Required during Add operations. Optional during Update operations.
+   */
+  expertBaseURL: string;
+  creationTimestamp?: string;
+  creationSessionID?: string;
+  lastChangeTimestamp?: string;
+  lastChangeSessionID?: string;
+}