@memori.ai/memori-api-client 5.3.0 → 5.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/backend/asset.d.ts +3 -0
  3. package/dist/backend/asset.js +4 -0
  4. package/dist/backend/asset.js.map +1 -1
  5. package/dist/backend/badge.d.ts +11 -0
  6. package/dist/backend/badge.js +16 -0
  7. package/dist/backend/badge.js.map +1 -0
  8. package/dist/backend/badge.test.d.ts +1 -0
  9. package/dist/backend/badge.test.js +14 -0
  10. package/dist/backend/badge.test.js.map +1 -0
  11. package/dist/backend/completionConfig.d.ts +7 -1
  12. package/dist/backend/completionConfig.js.map +1 -1
  13. package/dist/backend/tenant.d.ts +17 -0
  14. package/dist/backend/tenant.js +25 -0
  15. package/dist/backend/tenant.js.map +1 -0
  16. package/dist/backend/tenant.test.d.ts +1 -0
  17. package/dist/backend/tenant.test.js +14 -0
  18. package/dist/backend/tenant.test.js.map +1 -0
  19. package/dist/backend/user.d.ts +1 -4
  20. package/dist/backend/user.js +0 -3
  21. package/dist/backend/user.js.map +1 -1
  22. package/dist/backend.d.ts +64 -8
  23. package/dist/backend.js +6 -0
  24. package/dist/backend.js.map +1 -1
  25. package/dist/engine/nlp.d.ts +9 -0
  26. package/dist/engine/nlp.js +15 -0
  27. package/dist/engine/nlp.js.map +1 -1
  28. package/dist/engine/stats.d.ts +3 -0
  29. package/dist/engine/stats.js +4 -0
  30. package/dist/engine/stats.js.map +1 -1
  31. package/dist/engine.d.ts +24 -0
  32. package/dist/index.d.ts +88 -8
  33. package/esm/backend/asset.d.ts +3 -0
  34. package/esm/backend/asset.js +4 -0
  35. package/esm/backend/asset.js.map +1 -1
  36. package/esm/backend/badge.d.ts +11 -0
  37. package/esm/backend/badge.js +14 -0
  38. package/esm/backend/badge.js.map +1 -0
  39. package/esm/backend/badge.test.d.ts +1 -0
  40. package/esm/backend/badge.test.js +11 -0
  41. package/esm/backend/badge.test.js.map +1 -0
  42. package/esm/backend/completionConfig.d.ts +7 -1
  43. package/esm/backend/completionConfig.js.map +1 -1
  44. package/esm/backend/tenant.d.ts +17 -0
  45. package/esm/backend/tenant.js +23 -0
  46. package/esm/backend/tenant.js.map +1 -0
  47. package/esm/backend/tenant.test.d.ts +1 -0
  48. package/esm/backend/tenant.test.js +11 -0
  49. package/esm/backend/tenant.test.js.map +1 -0
  50. package/esm/backend/user.d.ts +1 -4
  51. package/esm/backend/user.js +0 -3
  52. package/esm/backend/user.js.map +1 -1
  53. package/esm/backend.d.ts +64 -8
  54. package/esm/backend.js +6 -0
  55. package/esm/backend.js.map +1 -1
  56. package/esm/engine/nlp.d.ts +9 -0
  57. package/esm/engine/nlp.js +15 -0
  58. package/esm/engine/nlp.js.map +1 -1
  59. package/esm/engine/stats.d.ts +3 -0
  60. package/esm/engine/stats.js +4 -0
  61. package/esm/engine/stats.js.map +1 -1
  62. package/esm/engine.d.ts +24 -0
  63. package/esm/index.d.ts +88 -8
  64. package/package.json +1 -1
  65. package/src/backend/asset.ts +11 -0
  66. package/src/backend/badge.test.ts +19 -0
  67. package/src/backend/badge.ts +36 -0
  68. package/src/backend/completionConfig.ts +14 -2
  69. package/src/backend/tenant.test.ts +17 -0
  70. package/src/backend/tenant.ts +74 -0
  71. package/src/backend/user.ts +0 -13
  72. package/src/backend.ts +6 -0
  73. package/src/engine/nlp.ts +66 -0
  74. package/src/engine/stats.ts +15 -0
@@ -16,5 +16,9 @@ export default (apiUrl) => ({
16
16
  method: 'GET',
17
17
  apiUrl,
18
18
  }),
19
+ getSessionEventLogs: async (sessionID, eventLogSessionID) => apiFetcher(`/SessionEventLogs/${sessionID}/${eventLogSessionID}`, {
20
+ method: 'GET',
21
+ apiUrl,
22
+ }),
19
23
  });
20
24
  //# sourceMappingURL=stats.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"stats.js","sourceRoot":"","sources":["../../src/engine/stats.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAQ3C,eAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAKlC,qBAAqB,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE,CACjD,UAAU,CAAC,uBAAuB,SAAS,EAAE,EAAE;QAC7C,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CA0BA;IAQH,YAAY,EAAE,KAAK,EACjB,SAAiB,EACjB,WAAmB,EACnB,SAAiB,EACjB,EAAE,CACF,UAAU,CAAC,cAAc,SAAS,IAAI,WAAW,IAAI,SAAS,EAAE,EAAE;QAChE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAIA;IASH,kBAAkB,EAAE,KAAK,EACvB,SAAiB,EACjB,QAAgB,EAChB,WAAmB,EACnB,SAAiB,EACjB,EAAE,CACF,UAAU,CACR,cAAc,SAAS,IAAI,QAAQ,IAAI,WAAW,IAAI,SAAS,EAAE,EACjE;QACE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAKF;IASH,kBAAkB,EAAE,KAAK,EACvB,SAAiB,EACjB,QAAgB,EAChB,WAAmB,EACnB,SAAiB,EACjB,EAAE,CACF,UAAU,CACR,cAAc,SAAS,IAAI,QAAQ,IAAI,WAAW,IAAI,SAAS,EAAE,EACjE;QACE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAKF;CACJ,CAAC,CAAC"}
1
+ {"version":3,"file":"stats.js","sourceRoot":"","sources":["../../src/engine/stats.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAQ3C,eAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAKlC,qBAAqB,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE,CACjD,UAAU,CAAC,uBAAuB,SAAS,EAAE,EAAE;QAC7C,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CA0BA;IAQH,YAAY,EAAE,KAAK,EACjB,SAAiB,EACjB,WAAmB,EACnB,SAAiB,EACjB,EAAE,CACF,UAAU,CAAC,cAAc,SAAS,IAAI,WAAW,IAAI,SAAS,EAAE,EAAE;QAChE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAIA;IASH,kBAAkB,EAAE,KAAK,EACvB,SAAiB,EACjB,QAAgB,EAChB,WAAmB,EACnB,SAAiB,EACjB,EAAE,CACF,UAAU,CACR,cAAc,SAAS,IAAI,QAAQ,IAAI,WAAW,IAAI,SAAS,EAAE,EACjE;QACE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAKF;IASH,kBAAkB,EAAE,KAAK,EACvB,SAAiB,EACjB,QAAgB,EAChB,WAAmB,EACnB,SAAiB,EACjB,EAAE,CACF,UAAU,CACR,cAAc,SAAS,IAAI,QAAQ,IAAI,WAAW,IAAI,SAAS,EAAE,EACjE;QACE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAKF;IAOH,mBAAmB,EAAE,KAAK,EAAE,SAAiB,EAAE,iBAAyB,EAAE,EAAE,CAC1E,UAAU,CAAC,qBAAqB,SAAS,IAAI,iBAAiB,EAAE,EAAE;QAChE,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAIA;CACJ,CAAC,CAAC"}
package/esm/engine.d.ts CHANGED
@@ -302,6 +302,9 @@ declare const _default: (apiUrl: string) => {
302
302
  getIntentEventLogs: (sessionId: string, intentId: string, strDateFrom: string, strDateTo: string) => Promise<import("./types").ResponseSpec & {
303
303
  eventLogs: import("./types").EventLog[];
304
304
  }>;
305
+ getSessionEventLogs: (sessionID: string, eventLogSessionID: string) => Promise<import("./types").ResponseSpec & {
306
+ eventLogs: import("./types").EventLog[];
307
+ }>;
305
308
  stats: {
306
309
  getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
307
310
  textQualityIndex: number;
@@ -318,6 +321,9 @@ declare const _default: (apiUrl: string) => {
318
321
  getIntentEventLogs: (sessionId: string, intentId: string, strDateFrom: string, strDateTo: string) => Promise<import("./types").ResponseSpec & {
319
322
  eventLogs: import("./types").EventLog[];
320
323
  }>;
324
+ getSessionEventLogs: (sessionID: string, eventLogSessionID: string) => Promise<import("./types").ResponseSpec & {
325
+ eventLogs: import("./types").EventLog[];
326
+ }>;
321
327
  };
322
328
  initSession: (params: import("./types").OpenSession) => Promise<import("./types").ResponseSpec & {
323
329
  sessionID: string;
@@ -435,6 +441,15 @@ declare const _default: (apiUrl: string) => {
435
441
  checkWords: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
436
442
  undefinedWords: string[];
437
443
  }>;
444
+ suggestAnswer: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
445
+ answer: string;
446
+ }>;
447
+ suggestTags: (sessionId: string, question: string, answer: string, questionVariants?: string[] | undefined) => Promise<import("./types").ResponseSpec & {
448
+ tags: string[];
449
+ }>;
450
+ suggestQuestions: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
451
+ questions: string[];
452
+ }>;
438
453
  nlp: {
439
454
  getWordVector: (sessionId: string, word: string) => Promise<import("./types").ResponseSpec & {
440
455
  vector: number[];
@@ -454,6 +469,15 @@ declare const _default: (apiUrl: string) => {
454
469
  checkWords: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
455
470
  undefinedWords: string[];
456
471
  }>;
472
+ suggestAnswer: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
473
+ answer: string;
474
+ }>;
475
+ suggestTags: (sessionId: string, question: string, answer: string, questionVariants?: string[] | undefined) => Promise<import("./types").ResponseSpec & {
476
+ tags: string[];
477
+ }>;
478
+ suggestQuestions: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
479
+ questions: string[];
480
+ }>;
457
481
  };
458
482
  getMemories: (sessionId: string, type?: "ALL" | "CONTENTS" | "DEFAULTS" | "DRAFTS" | "EXPERT_REFERENCES" | undefined) => Promise<import("./types").ResponseSpec & {
459
483
  memories: import("./types").Memory[];
package/esm/index.d.ts CHANGED
@@ -311,6 +311,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
311
311
  getIntentEventLogs: (sessionId: string, intentId: string, strDateFrom: string, strDateTo: string) => Promise<import("./types").ResponseSpec & {
312
312
  eventLogs: import("./types").EventLog[];
313
313
  }>;
314
+ getSessionEventLogs: (sessionID: string, eventLogSessionID: string) => Promise<import("./types").ResponseSpec & {
315
+ eventLogs: import("./types").EventLog[];
316
+ }>;
314
317
  stats: {
315
318
  getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
316
319
  textQualityIndex: number;
@@ -327,6 +330,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
327
330
  getIntentEventLogs: (sessionId: string, intentId: string, strDateFrom: string, strDateTo: string) => Promise<import("./types").ResponseSpec & {
328
331
  eventLogs: import("./types").EventLog[];
329
332
  }>;
333
+ getSessionEventLogs: (sessionID: string, eventLogSessionID: string) => Promise<import("./types").ResponseSpec & {
334
+ eventLogs: import("./types").EventLog[];
335
+ }>;
330
336
  };
331
337
  initSession: (params: import("./types").OpenSession) => Promise<import("./types").ResponseSpec & {
332
338
  sessionID: string;
@@ -444,6 +450,15 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
444
450
  checkWords: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
445
451
  undefinedWords: string[];
446
452
  }>;
453
+ suggestAnswer: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
454
+ answer: string;
455
+ }>;
456
+ suggestTags: (sessionId: string, question: string, answer: string, questionVariants?: string[] | undefined) => Promise<import("./types").ResponseSpec & {
457
+ tags: string[];
458
+ }>;
459
+ suggestQuestions: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
460
+ questions: string[];
461
+ }>;
447
462
  nlp: {
448
463
  getWordVector: (sessionId: string, word: string) => Promise<import("./types").ResponseSpec & {
449
464
  vector: number[];
@@ -463,6 +478,15 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
463
478
  checkWords: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
464
479
  undefinedWords: string[];
465
480
  }>;
481
+ suggestAnswer: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
482
+ answer: string;
483
+ }>;
484
+ suggestTags: (sessionId: string, question: string, answer: string, questionVariants?: string[] | undefined) => Promise<import("./types").ResponseSpec & {
485
+ tags: string[];
486
+ }>;
487
+ suggestQuestions: (sessionId: string, text: string) => Promise<import("./types").ResponseSpec & {
488
+ questions: string[];
489
+ }>;
466
490
  };
467
491
  getMemories: (sessionId: string, type?: "ALL" | "CONTENTS" | "DEFAULTS" | "DRAFTS" | "EXPERT_REFERENCES" | undefined) => Promise<import("./types").ResponseSpec & {
468
492
  memories: import("./types").Memory[];
@@ -685,6 +709,26 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
685
709
  deleteCorrelationPair: (sessionId: string, pairId: string) => Promise<import("./types").ResponseSpec>;
686
710
  };
687
711
  backend: {
712
+ healthCheck: () => Promise<import("./types").ResponseSpec>;
713
+ getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
714
+ tenant: import("./types").TenantBase;
715
+ }>;
716
+ getTenantList: (authToken: string) => Promise<import("./types").ResponseSpec & {
717
+ tenants: import("./types").TenantBase[];
718
+ }>;
719
+ createTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
720
+ tenant: import("./types").TenantBase;
721
+ }>;
722
+ patchTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
723
+ tenant: import("./types").TenantBase;
724
+ }>;
725
+ postOutcome: (authToken: string, outcomeCode: string) => Promise<import("./types").ResponseSpec>;
726
+ getUserBadges: (authToken: string) => Promise<import("./types").ResponseSpec & {
727
+ badges: import("./types").Badge[];
728
+ }>;
729
+ getBadge: (authToken: string, badgeID: string) => Promise<import("./types").ResponseSpec & {
730
+ badge: import("./types").Badge;
731
+ }>;
688
732
  getCompletionConfigs: (authToken: string, purpose?: "QA" | "IE" | "DT" | undefined) => Promise<import("./types").ResponseSpec & {
689
733
  configs: import("./types").CompletionConfig[];
690
734
  }>;
@@ -693,12 +737,18 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
693
737
  }>;
694
738
  updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
695
739
  completionConfigID: string;
696
- }) => Promise<import("./types").ResponseSpec>;
740
+ }) => Promise<import("./types").ResponseSpec & {
741
+ config: import("./types").CompletionConfig;
742
+ appliedMemoriIDs?: string[] | undefined;
743
+ appliedMemoriNames?: string[] | undefined;
744
+ }>;
697
745
  deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
698
746
  createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
699
747
  completionConfigID?: string | undefined;
700
748
  }) => Promise<import("./types").ResponseSpec & {
701
749
  config: import("./types").CompletionConfig;
750
+ appliedMemoriIDs?: string[] | undefined;
751
+ appliedMemoriNames?: string[] | undefined;
702
752
  }>;
703
753
  analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
704
754
  status: import("./types").AnalysisStatus;
@@ -825,9 +875,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
825
875
  flowID?: string | undefined;
826
876
  }>;
827
877
  recoverUsername: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
828
- getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
829
- tenant: import("./types").Tenant;
830
- }>;
831
878
  resendVerificationCode: (user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec>;
832
879
  createUser: (authToken: string, user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec & {
833
880
  user: import("./types").User;
@@ -893,6 +940,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
893
940
  asset: import("./types").Asset;
894
941
  }>;
895
942
  getAsset: (fileName: string, sessionID: string) => Promise<any>;
943
+ getAssetList: (authToken: string) => Promise<import("./types").ResponseSpec & {
944
+ assets: import("./types").Asset[];
945
+ }>;
896
946
  updateAsset: (authToken: string, assetURL: string, asset: import("./types").Asset) => Promise<import("./types").ResponseSpec & {
897
947
  asset: import("./types").Asset;
898
948
  }>;
@@ -903,6 +953,9 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
903
953
  asset: import("./types").Asset;
904
954
  }>;
905
955
  getAsset: (fileName: string, sessionID: string) => Promise<any>;
956
+ getAssetList: (authToken: string) => Promise<import("./types").ResponseSpec & {
957
+ assets: import("./types").Asset[];
958
+ }>;
906
959
  updateAsset: (authToken: string, assetURL: string, asset: import("./types").Asset) => Promise<import("./types").ResponseSpec & {
907
960
  asset: import("./types").Asset;
908
961
  }>;
@@ -1004,9 +1057,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
1004
1057
  flowID?: string | undefined;
1005
1058
  }>;
1006
1059
  recoverUsername: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
1007
- getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
1008
- tenant: import("./types").Tenant;
1009
- }>;
1010
1060
  resendVerificationCode: (user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec>;
1011
1061
  createUser: (authToken: string, user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec & {
1012
1062
  user: import("./types").User;
@@ -1123,12 +1173,42 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
1123
1173
  }>;
1124
1174
  updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
1125
1175
  completionConfigID: string;
1126
- }) => Promise<import("./types").ResponseSpec>;
1176
+ }) => Promise<import("./types").ResponseSpec & {
1177
+ config: import("./types").CompletionConfig;
1178
+ appliedMemoriIDs?: string[] | undefined;
1179
+ appliedMemoriNames?: string[] | undefined;
1180
+ }>;
1127
1181
  deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
1128
1182
  createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
1129
1183
  completionConfigID?: string | undefined;
1130
1184
  }) => Promise<import("./types").ResponseSpec & {
1131
1185
  config: import("./types").CompletionConfig;
1186
+ appliedMemoriIDs?: string[] | undefined;
1187
+ appliedMemoriNames?: string[] | undefined;
1188
+ }>;
1189
+ };
1190
+ badge: {
1191
+ postOutcome: (authToken: string, outcomeCode: string) => Promise<import("./types").ResponseSpec>;
1192
+ getUserBadges: (authToken: string) => Promise<import("./types").ResponseSpec & {
1193
+ badges: import("./types").Badge[];
1194
+ }>;
1195
+ getBadge: (authToken: string, badgeID: string) => Promise<import("./types").ResponseSpec & {
1196
+ badge: import("./types").Badge;
1197
+ }>;
1198
+ };
1199
+ tenant: {
1200
+ healthCheck: () => Promise<import("./types").ResponseSpec>;
1201
+ getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
1202
+ tenant: import("./types").TenantBase;
1203
+ }>;
1204
+ getTenantList: (authToken: string) => Promise<import("./types").ResponseSpec & {
1205
+ tenants: import("./types").TenantBase[];
1206
+ }>;
1207
+ createTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
1208
+ tenant: import("./types").TenantBase;
1209
+ }>;
1210
+ patchTenant: (authToken: string, name: string, tenant: Partial<import("./types").TenantBase>) => Promise<import("./types").ResponseSpec & {
1211
+ tenant: import("./types").TenantBase;
1132
1212
  }>;
1133
1213
  };
1134
1214
  };
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "5.3.0",
2
+ "version": "5.4.0",
3
3
  "name": "@memori.ai/memori-api-client",
4
4
  "description": "React library to integrate a Memori in your app or website",
5
5
  "license": "Apache-2.0",
@@ -66,6 +66,17 @@ export default (apiUrl: string) => ({
66
66
  method: 'GET',
67
67
  }),
68
68
 
69
+ /**
70
+ * Gets a list of Asset objects owned the currently logged in User.
71
+ * @param {string} authToken - The login token
72
+ * @returns The list of Asset objects.
73
+ */
74
+ getAssetList: (authToken: string) =>
75
+ apiFetcher(`/Assets/${authToken}`, {
76
+ apiUrl,
77
+ method: 'GET',
78
+ }) as Promise<ResponseSpec & { assets: Asset[] }>,
79
+
69
80
  /**
70
81
  * Updates an Asset object
71
82
  * @param {string} authToken - The login token
@@ -0,0 +1,19 @@
1
+ import memori from '../index';
2
+
3
+ const client = memori('https://backend.memori.ai');
4
+
5
+ describe('backend/badge api', () => {
6
+ it('works on badge apis', async () => {
7
+ expect(
8
+ await client.backend.badge.getUserBadges(
9
+ 'be2e4a44-890b-483b-a26a-f6e122f36e2b'
10
+ )
11
+ ).not.toBeNull();
12
+ });
13
+
14
+ it('works on badge apis with shorthand version', async () => {
15
+ expect(
16
+ await client.backend.getUserBadges('be2e4a44-890b-483b-a26a-f6e122f36e2b')
17
+ ).not.toBeNull();
18
+ });
19
+ });
@@ -0,0 +1,36 @@
1
+ import { ResponseSpec, Badge } from '../types';
2
+ import { apiFetcher } from '../apiFetcher';
3
+
4
+ export default (apiUrl: string) => ({
5
+ /**
6
+ * Processes the specified outcome.
7
+ * @param {string} authToken - The login token
8
+ * @param {string} outcomeCode - The outcome code
9
+ */
10
+ postOutcome: (authToken: string, outcomeCode: string) =>
11
+ apiFetcher(`/Outcome/${authToken}/${outcomeCode}`, {
12
+ apiUrl,
13
+ method: 'POST',
14
+ }) as Promise<ResponseSpec>,
15
+
16
+ /**
17
+ * Gets a list of Badge objects assigned to the currently logged in User.
18
+ * @param {string} authToken - The login token
19
+ * @returns The list of Badge objects.
20
+ */
21
+ getUserBadges: (authToken: string) =>
22
+ apiFetcher(`/Badges/${authToken}`, {
23
+ apiUrl,
24
+ }) as Promise<ResponseSpec & { badges: Badge[] }>,
25
+
26
+ /**
27
+ * Get the detail of a Badge object of the currently logged in User.
28
+ * @param {string} authToken - The login token
29
+ * @param {string} badgeID - The ID of the Badge object
30
+ * @returns The Badge object
31
+ */
32
+ getBadge: (authToken: string, badgeID: string) =>
33
+ apiFetcher(`/Badge/${authToken}/${badgeID}`, {
34
+ apiUrl,
35
+ }) as Promise<ResponseSpec & { badge: Badge }>,
36
+ });
@@ -49,7 +49,13 @@ export default (apiUrl: string) => ({
49
49
  apiUrl,
50
50
  method: 'PATCH',
51
51
  body: config,
52
- }) as Promise<ResponseSpec>,
52
+ }) as Promise<
53
+ ResponseSpec & {
54
+ config: CompletionConfig;
55
+ appliedMemoriIDs?: string[];
56
+ appliedMemoriNames?: string[];
57
+ }
58
+ >,
53
59
 
54
60
  /**
55
61
  * Deletes an existing Completion Config object.
@@ -73,5 +79,11 @@ export default (apiUrl: string) => ({
73
79
  apiUrl,
74
80
  method: 'POST',
75
81
  body: config,
76
- }) as Promise<ResponseSpec & { config: CompletionConfig }>,
82
+ }) as Promise<
83
+ ResponseSpec & {
84
+ config: CompletionConfig;
85
+ appliedMemoriIDs?: string[];
86
+ appliedMemoriNames?: string[];
87
+ }
88
+ >,
77
89
  });
@@ -0,0 +1,17 @@
1
+ import memori from '../index';
2
+
3
+ const client = memori('https://backend.memori.ai');
4
+
5
+ describe('backend/tenant api', () => {
6
+ it('works on tenant apis', async () => {
7
+ expect(
8
+ await client.backend.tenant.getTenantConfig('www.aisuru.com')
9
+ ).not.toBeNull();
10
+ });
11
+
12
+ it('works on tenant apis with shorthand version', async () => {
13
+ expect(
14
+ await client.backend.getTenantConfig('www.aisuru.com')
15
+ ).not.toBeNull();
16
+ });
17
+ });
@@ -0,0 +1,74 @@
1
+ import { ResponseSpec, TenantBase } from '../types';
2
+ import { apiFetcher } from '../apiFetcher';
3
+
4
+ export default (apiUrl: string) => ({
5
+ /**
6
+ * Health check for the backend
7
+ */
8
+ healthCheck: () =>
9
+ apiFetcher(`/HealthCheck`, {
10
+ apiUrl,
11
+ method: 'GET',
12
+ }) as Promise<ResponseSpec>,
13
+
14
+ /**
15
+ * Gets the details of a Tenant object.
16
+ * @param tenantName - The name of the tenant
17
+ */
18
+ getTenantConfig: (tenantName: string) =>
19
+ apiFetcher(`/Tenant/${tenantName}`, { apiUrl }) as Promise<
20
+ ResponseSpec & {
21
+ tenant: TenantBase;
22
+ }
23
+ >,
24
+
25
+ /**
26
+ * Gets the list of of all Tenant objects.
27
+ * @param authToken - The login token
28
+ */
29
+ getTenantList: (authToken: string) =>
30
+ apiFetcher(`/Tenants/${authToken}`, {
31
+ apiUrl,
32
+ method: 'GET',
33
+ }) as Promise<ResponseSpec & { tenants: TenantBase[] }>,
34
+
35
+ /**
36
+ * Duplicates a Tenant object.
37
+ * @param {string} authToken - The login token
38
+ * @param {string} name - The name of the Tenant to duplicate
39
+ * @param {TenantBase} tenant
40
+ * @returns The specifications of the new Tenant object
41
+ */
42
+ createTenant: (
43
+ authToken: string,
44
+ name: string,
45
+ tenant: Partial<TenantBase>
46
+ ) =>
47
+ apiFetcher(`/Tenant/${authToken}/${name}`, {
48
+ apiUrl,
49
+ method: 'POST',
50
+ body: tenant,
51
+ }) as Promise<
52
+ ResponseSpec & {
53
+ tenant: TenantBase;
54
+ }
55
+ >,
56
+
57
+ /**
58
+ * Updates the details of a Tenant object.
59
+ * @param {string} authToken - The login token
60
+ * @param {string} name - The name of the Tenant to update
61
+ * @param {TenantBase} tenant
62
+ * @returns The new specifications of the Tenant object
63
+ */
64
+ patchTenant: (authToken: string, name: string, tenant: Partial<TenantBase>) =>
65
+ apiFetcher(`/Tenant/${authToken}/${name}`, {
66
+ apiUrl,
67
+ method: 'PATCH',
68
+ body: tenant,
69
+ }) as Promise<
70
+ ResponseSpec & {
71
+ tenant: TenantBase;
72
+ }
73
+ >,
74
+ });
@@ -182,19 +182,6 @@ export default (apiUrl: string) => ({
182
182
  method: 'POST',
183
183
  }) as Promise<ResponseSpec>,
184
184
 
185
- /**
186
- * Gets the details of a Tenant object.
187
- * @param tenantName - The name of the tenant
188
- */
189
- getTenantConfig: (tenantName: string) =>
190
- apiFetcher(`/Tenant/${tenantName}`, {
191
- apiUrl,
192
- }) as Promise<
193
- ResponseSpec & {
194
- tenant: Tenant;
195
- }
196
- >,
197
-
198
185
  /**
199
186
  * Re-sends the verification code to confirm a pending User registration.
200
187
  * @param {User} user - The user object
package/src/backend.ts CHANGED
@@ -9,6 +9,8 @@ import importExport from './backend/importExport';
9
9
  import process from './backend/process';
10
10
  import analysis from './backend/analysis';
11
11
  import completionConfig from './backend/completionConfig';
12
+ import badge from './backend/badge';
13
+ import tenant from './backend/tenant';
12
14
 
13
15
  const backendAPI = (apiUrl: string) => ({
14
16
  asset: asset(apiUrl),
@@ -22,6 +24,8 @@ const backendAPI = (apiUrl: string) => ({
22
24
  process: process(apiUrl),
23
25
  analysis: analysis(apiUrl),
24
26
  completionConfig: completionConfig(apiUrl),
27
+ badge: badge(apiUrl),
28
+ tenant: tenant(apiUrl),
25
29
  ...asset(apiUrl),
26
30
  ...memori(apiUrl),
27
31
  ...user(apiUrl),
@@ -33,6 +37,8 @@ const backendAPI = (apiUrl: string) => ({
33
37
  ...process(apiUrl),
34
38
  ...analysis(apiUrl),
35
39
  ...completionConfig(apiUrl),
40
+ ...badge(apiUrl),
41
+ ...tenant(apiUrl),
36
42
  });
37
43
 
38
44
  export default backendAPI;
package/src/engine/nlp.ts CHANGED
@@ -113,4 +113,70 @@ export default (apiUrl: string) => ({
113
113
  undefinedWords: string[];
114
114
  }
115
115
  >,
116
+
117
+ /**
118
+ * Tries to suggest the answer for a question, using as much content as possible from the session's associated Memori object.
119
+ * @param {string} sessionId The session ID
120
+ * @param {string} text Text of the sentence.
121
+ */
122
+ suggestAnswer: async (sessionId: string, text: string) =>
123
+ apiFetcher(`/SuggestAnswer/${sessionId}`, {
124
+ method: 'POST',
125
+ apiUrl,
126
+ body: { text },
127
+ }) as Promise<
128
+ ResponseSpec & {
129
+ /**
130
+ * Suggested answer. May be null if no answer could be suggested.
131
+ */
132
+ answer: string;
133
+ }
134
+ >,
135
+
136
+ /**
137
+ * Tries to suggest tags for a a question and its answer.
138
+ * Differently from ```SuggestAnswer```, no content from the session's associated Memori object is used.
139
+ * @param {string} sessionId The session ID
140
+ * @param {string} question Text of question.
141
+ * @param {string} answer Answer to the question (and its variants).
142
+ * @param {string[]=} questionVariants Optional list of question variants.
143
+ */
144
+ suggestTags: async (
145
+ sessionId: string,
146
+ question: string,
147
+ answer: string,
148
+ questionVariants?: string[]
149
+ ) =>
150
+ apiFetcher(`/SuggestTags/${sessionId}`, {
151
+ method: 'POST',
152
+ apiUrl,
153
+ body: { question, answer, questionVariants },
154
+ }) as Promise<
155
+ ResponseSpec & {
156
+ /**
157
+ * Suggested tags. May be null or empty if no tags could be suggested.
158
+ */
159
+ tags: string[];
160
+ }
161
+ >,
162
+
163
+ /**
164
+ * Tries to suggest questions for an answer.
165
+ * Differently from ```SuggestAnswer```, no content from the session's associated Memori object is used.
166
+ * @param {string} sessionId The session ID
167
+ * @param {string} text Text of the sentence.
168
+ */
169
+ suggestQuestions: async (sessionId: string, text: string) =>
170
+ apiFetcher(`/SuggestQuestions/${sessionId}`, {
171
+ method: 'POST',
172
+ apiUrl,
173
+ body: { text },
174
+ }) as Promise<
175
+ ResponseSpec & {
176
+ /**
177
+ * Suggested questions. May be null or empty if no questions could be suggested.
178
+ */
179
+ questions: string[];
180
+ }
181
+ >,
116
182
  });
@@ -113,4 +113,19 @@ export default (apiUrl: string) => ({
113
113
  eventLogs: EventLog[];
114
114
  }
115
115
  >,
116
+
117
+ /**
118
+ * Gets the Event Log objects for the Memori of the current session recorded during a specific other session.
119
+ * @param {string} sessionID The session ID
120
+ * @param {string} eventLogSessionID The session ID for which Event Log objects are being searched
121
+ */
122
+ getSessionEventLogs: async (sessionID: string, eventLogSessionID: string) =>
123
+ apiFetcher(`/SessionEventLogs/${sessionID}/${eventLogSessionID}`, {
124
+ method: 'GET',
125
+ apiUrl,
126
+ }) as Promise<
127
+ ResponseSpec & {
128
+ eventLogs: EventLog[];
129
+ }
130
+ >,
116
131
  });