@memori.ai/memori-api-client 2.6.2 → 3.0.0

package/src/engine/topics.ts

@@ -0,0 +1,124 @@
+import { ResponseSpec, MemoriUser, Topic } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/****************
+ *              *
+ *    Topics    *
+ *              *
+ ****************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Topic objects.
+   * @param {string} sessionId The session ID
+   */
+  getTopics: async (sessionId: string) =>
+    apiFetcher(`/Topics/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+
+  /**
+   * Lists Topic objects with pagination.
+   * @param {string} sessionId The session ID
+   * @param {number} from The 0-based index of the first Topics object to list
+   * @param {number} howMany The number of the Topics objects to list
+   */
+  getTopicsPaginated: async (
+    sessionId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/Topics/${sessionId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Topic objects.
+         */
+        count: number;
+        /**
+         * List of Topic objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+
+  /**
+   * Gets the details of a Topic object.
+   * @param {string} sessionId The session ID
+   * @param {string} topicID The Topic object ID
+   */
+  getTopic: async (sessionId: string, topicID: string) =>
+    apiFetcher(`/Topic/${sessionId}/${topicID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        topic: Topic;
+      }
+    >,
+
+  /**
+   * Lists all MemoriUser objects referencing a specified Topic object.
+   * @param {string} sessionId The session ID
+   * @param {string} topicId The Topic object ID
+   */
+  getTopicUsers: async (sessionId: string, topicId: string) =>
+    apiFetcher(`/TopicUsers/${sessionId}/${topicId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+
+  /**
+   * Lists all MemoriUser objects referencing a specified Topic object, with pagination.
+   * @param {string} sessionId The session ID
+   * @param {string} topicId The Topic object ID
+   * @param {number} from The 0-based index of the first MemoriUser object to list
+   * @param {number} howMany The number of the MemoriUser objects to list
+   */
+  getTopicUsersPaginated: async (
+    sessionId: string,
+    topicId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/TopicUsers/${sessionId}/${topicId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+});

package/src/engine/{promptedQuestions.test.ts → user.test.ts}

@@ -2,19 +2,19 @@ import memori from '../index';
 
 const client = memori('https://backend.memori.ai');
 
-describe('engine/promptedQuestions api', () => {
-  it('works on promptedQuestions apis', async () => {
+describe('engine/user api', () => {
+  it('works on user apis', async () => {
     expect(
-      await client.promptedQuestions.getPromptedQuestion(
+      await client.user.getMemoriUser(
         '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
         'be2e4a44-890b-483b-a26a-f6e122f36e2b'
       )
     ).not.toBeNull();
   });
 
-  it('works on promptedQuestions apis with shorthand version', async () => {
+  it('works on user apis with shorthand version', async () => {
     expect(
-      await client.getPromptedQuestion(
+      await client.getMemoriUser(
         '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
         'be2e4a44-890b-483b-a26a-f6e122f36e2b'
       )

package/src/engine/user.ts

@@ -0,0 +1,124 @@
+import { ResponseSpec, MemoriUser, Topic } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/****************
+ *              *
+ *     User     *
+ *              *
+ ****************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all User objects associated with the Memori of the current session.
+   * @param {string} sessionId The session ID
+   */
+  getMemoriUsers: async (sessionId: string) =>
+    apiFetcher(`/Users/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+
+  /**
+   * Lists all MemoriUser objects associated with the Memori of the current session, with pagination.
+   * @param {string} sessionId The session ID
+   * @param {number} from The 0-based index of the first MemoriUser object to list
+   * @param {number} howMany The number of the MemoriUser objects to list
+   */
+  getMemoriUsersPaginated: async (
+    sessionId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/Users/${sessionId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+
+  /**
+   * Gets the details of a User object.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The User object ID
+   */
+  getMemoriUser: async (sessionId: string, userID: string) =>
+    apiFetcher(`/User/${sessionId}/${userID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        user: MemoriUser;
+      }
+    >,
+
+  /**
+   * Lists all Topic objects referenced by a specified MemoriUser object.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The User object ID
+   */
+  getMemoriUserTopics: async (sessionId: string, userID: string) =>
+    apiFetcher(`/UserTopics/${sessionId}/${userID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Topic objects.
+         */
+        count: number;
+        /**
+         * List of Topic objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+
+  /**
+   * Lists all Topic objects referenced by a specified MemoriUser object, with pagination.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The User object ID
+   * @param {number} from The 0-based index of the first Topics object to list
+   * @param {number} howMany The number of the Topics objects to list
+   */
+  getMemoriUserTopicsPaginated: async (
+    sessionId: string,
+    userID: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/UserTopics/${sessionId}/${userID}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Topic objects.
+         */
+        count: number;
+        /**
+         * List of Topic objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+});

package/src/engine.ts

@@ -6,7 +6,6 @@ import media from './engine/media';
 import memories from './engine/memories';
 import nlp from './engine/nlp';
 import people from './engine/people';
-import promptedQuestions from './engine/promptedQuestions';
 import search from './engine/search';
 import session from './engine/session';
 import stats from './engine/stats';
@@ -15,6 +14,9 @@ import contextVars from './engine/contextVars';
 import customDictionary from './engine/customDictionary';
 import chatLogs from './engine/chatLogs';
 import expertReferences from './engine/expertReferences';
+import knownFacts from './engine/knownFacts';
+import user from './engine/user';
+import topics from './engine/topics';
 
 export default (apiUrl: string) => ({
   correlationPairs: correlationPairs(apiUrl),
@@ -33,8 +35,6 @@ export default (apiUrl: string) => ({
   ...nlp(apiUrl),
   people: people(apiUrl),
   ...people(apiUrl),
-  promptedQuestions: promptedQuestions(apiUrl),
-  ...promptedQuestions(apiUrl),
   search: search(apiUrl),
   ...search(apiUrl),
   session: session(apiUrl),
@@ -51,4 +51,10 @@ export default (apiUrl: string) => ({
   ...chatLogs(apiUrl),
   expertReferences: expertReferences(apiUrl),
   ...expertReferences(apiUrl),
+  knownFacts: knownFacts(apiUrl),
+  ...knownFacts(apiUrl),
+  user: user(apiUrl),
+  ...user(apiUrl),
+  topics: topics(apiUrl),
+  ...topics(apiUrl),
 });

package/src/helpers/asset.ts

@@ -13,14 +13,14 @@ export default (apiUrl: string) => ({
    * @param {string=} params.type - wheather is the avatar or the cover
    * @param {string=} params.resourceURI - the resource URI
    * @param {string=} params.sessionID - the session ID, required for memory media attachments
-   * @param {string=} params.baseURL - the base URL for default static assets (defaults to https://app.twincreator.com)
+   * @param {string=} params.baseURL - the base URL for default static assets (defaults to https://aisuru.com)
    * @returns {string}
    */
   getResourceUrl: ({
     type,
     resourceURI,
     sessionID,
-    baseURL = 'https://app.twincreator.com',
+    baseURL = 'https://aisuru.com',
   }: ResourceURLParams): string => {
     let defaultUri =
       type === 'cover'

package/src/types.ts

@@ -65,10 +65,9 @@ export declare type Memori = {
   disableR5Loop?: boolean;
   ageRestriction?: number;
   nsfw?: boolean;
-  enableBoardOfExperts?: boolean;
   enableCompletions?: boolean;
   completionDescription?: string;
-  completionProvider?: '-' | 'OpenAI';
+  completionProvider?: '-' | 'Mistral' | 'OpenAI';
   /**
    * Format: chiave1:valore1|chiave2:valore2|...|chiaveN:valoreN
    *
@@ -80,10 +79,30 @@ export declare type Memori = {
    */
   completionProviderConfig?: string;
   enableDeepThought?: boolean;
+  enableBoardOfExperts?: boolean;
   disableCompletionMediaExtraction?: boolean;
   chainingMemoriID?: string;
   chainingBaseURL?: string;
   chainingPassword?: string;
+  /**
+   * @type {string=}
+   * User name of the optional integration with the DCM platform.
+   * If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation.
+   * When updating, set it to a single dash character (-) to remove a previously set integration.
+   */
+  dcmUser?: string;
+  /**
+   * @type {string=}
+   * Shared secret of the optional integration with the DCM platform.
+   * Required if DCMUser is set.
+   */
+  dcmSecret?: string;
+  /**
+   * @type {string=}
+   * Application context of the optional integration with the DCM platform.
+   * Required if DCMUser is set.
+   */
+  dcmAppContext?: string;
   properties?: [{ [key: string]: string }];
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
@@ -165,7 +184,7 @@ export declare type User = {
   lastChangeTimestamp?: string;
   referral?: string;
   couponCode?: string;
-  defaultCompletionProvider?: '-' | 'OpenAI';
+  defaultCompletionProvider?: '-' | 'Mistral' | 'OpenAI';
   /**
    * Format: chiave1:valore1|chiave2:valore2|...|chiaveN:valoreN
    *
@@ -182,6 +201,8 @@ export declare type User = {
   age?: number;
   tnCAndPPAccepted?: boolean;
   tnCAndPPAcceptanceDate?: string;
+  pAndCUAccepted?: boolean;
+  pAndCUAcceptanceDate?: string;
   avatarURL?: string;
   avatar3DURL?: string;
   avatar3DURLType?: string;
@@ -262,7 +283,6 @@ export type TenantConfig = {
   name: string;
   showNewUser: boolean;
   requirePosition: boolean;
-  feedbackURL?: string;
 };
 
 export type TenantBase = {
@@ -270,6 +290,11 @@ export type TenantBase = {
   name?: string;
   description?: string;
   logoURL?: string;
+  /**
+   * Additional Tenant names.
+   * Usually host names, e.g. app.memorytwin.com.
+   */
+  aliases?: string[];
   adminCount?: number;
   userCount?: number;
   memoriCount?: number;
@@ -282,15 +307,28 @@ export type TenantBase = {
   maxFreeSessions?: number;
   maxFreeSessionsPerUser?: number;
   nonFreeSessionCost?: number;
+  maxImportSize?: number;
+  maxImportSizePerUser?: number;
   maxCompletions?: number;
   maxCompletionsPerUser?: number;
+  defaultCompletionProvider?: '-' | 'Mistral' | '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;
-  usersCanCreateMemori?: boolean;
-  usersCanAccessAPI?: boolean;
-  usersCanEditIntegrations?: boolean;
-  usersCanEditDynamicIntents?: boolean;
-  usersCanEditMemoriChaining?: boolean;
-  usersCanRunSnippets?: boolean;
+  enableUserMemoriCreation?: boolean;
+  enableBoardOfExperts?: boolean;
+  enableDCMIntegration?: boolean;
+  enableBadges?: boolean;
+  enableVirtualSpaces?: boolean;
+  enableDeepThought?: boolean;
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
 };
@@ -1137,3 +1175,57 @@ export interface ExpertReference {
   lastChangeTimestamp?: string;
   lastChangeSessionID?: string;
 }
+
+export interface KnownFact {
+  /**
+   * Known Fact object ID.
+   * @type {string}
+   */
+  knownFactID: string;
+  /**
+   * Known Fact type, e.g. ShortTerm or LongTerm.
+   * Currently possible values are:
+   * - ShortTerm: this Known Fact is always used during conversations
+   * - LongTerm: this Known Fact is used during conversations only if relevant to the current question
+   */
+  knownFactType: 'ShortTerm' | 'LongTerm';
+  /**
+   * Text of the Known Fact.
+   */
+  text: string;
+  creationTimestamp?: string;
+  creationSessionID?: string;
+  lastChangeTimestamp?: string;
+  lastChangeSessionID?: string;
+}
+
+export interface MemoriUser {
+  userID: string;
+  email: string;
+  userName: string;
+  tenantName: string;
+  disableDeepThought: boolean;
+
+  creationTimestamp: string;
+  creationSessionID: string;
+  lastChangeTimestamp: string;
+  lastChangeSessionID: string;
+}
+
+export interface Topic {
+  topicID: string;
+  /**
+   * Topic name.
+   */
+  name: string;
+  /**
+     * Topic weight, i.e. the ratio between the number of times this topic has been referenced versus to
+  total number of references.
+     */
+  weight: number;
+
+  creationTimestamp: string;
+  creationSessionID: string;
+  lastChangeTimestamp: string;
+  lastChangeSessionID: string;
+}

package/src/engine/promptedQuestions.ts

@@ -1,63 +0,0 @@
-import { ResponseSpec } from '../types';
-import { apiFetcher } from '../apiFetcher';
-
-/*****************************
- *                           *
- *     PromptedQuestions     *
- *                           *
- *****************************/
-
-export default (apiUrl: string) => ({
-  /**
-   * Lists all Prompted Question objects.
-   * @param {string} sessionId The session ID
-   */
-  getPromptedQuestions: async (sessionId: string) =>
-    apiFetcher(`/PromptedQuestions/${sessionId}`, {
-      method: 'GET',
-      apiUrl,
-    }) as Promise<ResponseSpec>,
-
-  /**
-   * Gets the details of a Prompted Question object.
-   * @param {string} sessionId The session ID
-   * @param {string} promptId The Prompted Question object ID
-   */
-  getPromptedQuestion: async (sessionId: string, promptId: string) =>
-    apiFetcher(`/PromptedQuestion/${sessionId}/${promptId}`, {
-      method: 'GET',
-      apiUrl,
-    }) as Promise<ResponseSpec>,
-
-  /**
-   * Updates an existing Prompted Question object.
-   * @param {string} sessionId The session ID
-   * @param {string} promptId The Prompted Question object ID
-   */
-  patchPromptedQuestion: async (sessionId: string, promptId: string) =>
-    apiFetcher(`/PromptedQuestion/${sessionId}/${promptId}`, {
-      method: 'GET',
-      apiUrl,
-    }) as Promise<ResponseSpec>,
-
-  /**
-   * Removes an existing Prompted Question object.
-   * @param {string} sessionId The session ID
-   * @param {string} promptId The Prompted Question object ID
-   */
-  deletePromptedQuestion: async (sessionId: string, promptId: string) =>
-    apiFetcher(`/PromptedQuestion/${sessionId}/${promptId}`, {
-      method: 'GET',
-      apiUrl,
-    }) as Promise<ResponseSpec>,
-
-  /**
-   * Adds a new Prompted Question object.
-   * @param {string} sessionId The session ID
-   */
-  postPromptedQuestion: async (sessionId: string) =>
-    apiFetcher(`/PromptedQuestion/${sessionId}`, {
-      method: 'GET',
-      apiUrl,
-    }) as Promise<ResponseSpec>,
-});