@memori.ai/memori-api-client 5.0.1 → 5.1.1

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 (49) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/backend/completionConfig.d.ts +19 -0
  3. package/dist/backend/completionConfig.js +28 -0
  4. package/dist/backend/completionConfig.js.map +1 -0
  5. package/dist/backend/completionConfig.test.d.ts +1 -0
  6. package/dist/backend/completionConfig.test.js +14 -0
  7. package/dist/backend/completionConfig.test.js.map +1 -0
  8. package/dist/backend/memori.d.ts +0 -1
  9. package/dist/backend/memori.js +0 -4
  10. package/dist/backend/memori.js.map +1 -1
  11. package/dist/backend.d.ts +32 -2
  12. package/dist/backend.js +3 -0
  13. package/dist/backend.js.map +1 -1
  14. package/dist/engine/stats.d.ts +1 -9
  15. package/dist/engine/stats.js +0 -8
  16. package/dist/engine/stats.js.map +1 -1
  17. package/dist/engine/stats.test.js +2 -2
  18. package/dist/engine/stats.test.js.map +1 -1
  19. package/dist/engine.d.ts +0 -16
  20. package/dist/index.d.ts +32 -18
  21. package/dist/types.d.ts +25 -6
  22. package/esm/backend/completionConfig.d.ts +19 -0
  23. package/esm/backend/completionConfig.js +26 -0
  24. package/esm/backend/completionConfig.js.map +1 -0
  25. package/esm/backend/completionConfig.test.d.ts +1 -0
  26. package/esm/backend/completionConfig.test.js +11 -0
  27. package/esm/backend/completionConfig.test.js.map +1 -0
  28. package/esm/backend/memori.d.ts +0 -1
  29. package/esm/backend/memori.js +0 -4
  30. package/esm/backend/memori.js.map +1 -1
  31. package/esm/backend.d.ts +32 -2
  32. package/esm/backend.js +3 -0
  33. package/esm/backend.js.map +1 -1
  34. package/esm/engine/stats.d.ts +1 -9
  35. package/esm/engine/stats.js +0 -8
  36. package/esm/engine/stats.js.map +1 -1
  37. package/esm/engine/stats.test.js +2 -2
  38. package/esm/engine/stats.test.js.map +1 -1
  39. package/esm/engine.d.ts +0 -16
  40. package/esm/index.d.ts +32 -18
  41. package/esm/types.d.ts +25 -6
  42. package/package.json +1 -1
  43. package/src/backend/completionConfig.test.ts +23 -0
  44. package/src/backend/completionConfig.ts +77 -0
  45. package/src/backend/memori.ts +0 -12
  46. package/src/backend.ts +3 -0
  47. package/src/engine/stats.test.ts +10 -2
  48. package/src/engine/stats.ts +0 -44
  49. package/src/types.ts +95 -33
package/esm/backend.d.ts CHANGED
@@ -1,4 +1,19 @@
1
1
  declare const backendAPI: (apiUrl: string) => {
2
+ getCompletionConfigs: (authToken: string, purpose?: "QA" | "IE" | "DT" | undefined) => Promise<import("./types").ResponseSpec & {
3
+ configs: import("./types").CompletionConfig[];
4
+ }>;
5
+ getCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec & {
6
+ config: import("./types").CompletionConfig;
7
+ }>;
8
+ updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
9
+ completionConfigID: string;
10
+ }) => Promise<import("./types").ResponseSpec>;
11
+ deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
12
+ createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
13
+ completionConfigID?: string | undefined;
14
+ }) => Promise<import("./types").ResponseSpec & {
15
+ config: import("./types").CompletionConfig;
16
+ }>;
2
17
  analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
3
18
  status: import("./types").AnalysisStatus;
4
19
  }>;
@@ -183,7 +198,6 @@ declare const backendAPI: (apiUrl: string) => {
183
198
  ownerTenantName: string;
184
199
  ownerUserName: string;
185
200
  }) => Promise<import("./types").ResponseSpec>;
186
- memoriContentUpdated: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec>;
187
201
  getUploadAssetURL: (authToken: string, memoriID?: string | undefined, memoryID?: string | undefined) => string;
188
202
  uploadAsset: (fileName: string, fileUrl: string, authToken: string, memoriID?: string | undefined, memoryID?: string | undefined) => Promise<import("./types").ResponseSpec & {
189
203
  asset: import("./types").Asset;
@@ -261,7 +275,6 @@ declare const backendAPI: (apiUrl: string) => {
261
275
  ownerTenantName: string;
262
276
  ownerUserName: string;
263
277
  }) => Promise<import("./types").ResponseSpec>;
264
- memoriContentUpdated: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec>;
265
278
  };
266
279
  user: {
267
280
  userSignUp: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
@@ -407,5 +420,22 @@ declare const backendAPI: (apiUrl: string) => {
407
420
  matches: import("./types").UserQueryMatch[];
408
421
  }>;
409
422
  };
423
+ completionConfig: {
424
+ getCompletionConfigs: (authToken: string, purpose?: "QA" | "IE" | "DT" | undefined) => Promise<import("./types").ResponseSpec & {
425
+ configs: import("./types").CompletionConfig[];
426
+ }>;
427
+ getCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec & {
428
+ config: import("./types").CompletionConfig;
429
+ }>;
430
+ updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
431
+ completionConfigID: string;
432
+ }) => Promise<import("./types").ResponseSpec>;
433
+ deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
434
+ createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
435
+ completionConfigID?: string | undefined;
436
+ }) => Promise<import("./types").ResponseSpec & {
437
+ config: import("./types").CompletionConfig;
438
+ }>;
439
+ };
410
440
  };
411
441
  export default backendAPI;
package/esm/backend.js CHANGED
@@ -8,6 +8,7 @@ import notifications from './backend/notifications';
8
8
  import importExport from './backend/importExport';
9
9
  import process from './backend/process';
10
10
  import analysis from './backend/analysis';
11
+ import completionConfig from './backend/completionConfig';
11
12
  const backendAPI = (apiUrl) => ({
12
13
  asset: asset(apiUrl),
13
14
  memori: memori(apiUrl),
@@ -19,6 +20,7 @@ const backendAPI = (apiUrl) => ({
19
20
  importExport: importExport(apiUrl),
20
21
  process: process(apiUrl),
21
22
  analysis: analysis(apiUrl),
23
+ completionConfig: completionConfig(apiUrl),
22
24
  ...asset(apiUrl),
23
25
  ...memori(apiUrl),
24
26
  ...user(apiUrl),
@@ -29,6 +31,7 @@ const backendAPI = (apiUrl) => ({
29
31
  ...importExport(apiUrl),
30
32
  ...process(apiUrl),
31
33
  ...analysis(apiUrl),
34
+ ...completionConfig(apiUrl),
32
35
  });
33
36
  export default backendAPI;
34
37
  //# sourceMappingURL=backend.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"backend.js","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,kBAAkB,CAAC;AACtC,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAClC,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,UAAU,MAAM,sBAAsB,CAAC;AAC9C,OAAO,eAAe,MAAM,2BAA2B,CAAC;AACxD,OAAO,aAAa,MAAM,yBAAyB,CAAC;AACpD,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,OAAO,MAAM,mBAAmB,CAAC;AACxC,OAAO,QAAQ,MAAM,oBAAoB,CAAC;AAE1C,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IAChC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC;IAC9B,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;IACxC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC;IACpC,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,GAAG,KAAK,CAAC,MAAM,CAAC;IAChB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,GAAG,IAAI,CAAC,MAAM,CAAC;IACf,GAAG,WAAW,CAAC,MAAM,CAAC;IACtB,GAAG,UAAU,CAAC,MAAM,CAAC;IACrB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC1B,GAAG,aAAa,CAAC,MAAM,CAAC;IACxB,GAAG,YAAY,CAAC,MAAM,CAAC;IACvB,GAAG,OAAO,CAAC,MAAM,CAAC;IAClB,GAAG,QAAQ,CAAC,MAAM,CAAC;CACpB,CAAC,CAAC;AAEH,eAAe,UAAU,CAAC"}
1
+ {"version":3,"file":"backend.js","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,kBAAkB,CAAC;AACtC,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAClC,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,UAAU,MAAM,sBAAsB,CAAC;AAC9C,OAAO,eAAe,MAAM,2BAA2B,CAAC;AACxD,OAAO,aAAa,MAAM,yBAAyB,CAAC;AACpD,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,OAAO,MAAM,mBAAmB,CAAC;AACxC,OAAO,QAAQ,MAAM,oBAAoB,CAAC;AAC1C,OAAO,gBAAgB,MAAM,4BAA4B,CAAC;AAE1D,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IAChC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC;IAC9B,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;IACxC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC;IACpC,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,KAAK,CAAC,MAAM,CAAC;IAChB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,GAAG,IAAI,CAAC,MAAM,CAAC;IACf,GAAG,WAAW,CAAC,MAAM,CAAC;IACtB,GAAG,UAAU,CAAC,MAAM,CAAC;IACrB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC1B,GAAG,aAAa,CAAC,MAAM,CAAC;IACxB,GAAG,YAAY,CAAC,MAAM,CAAC;IACvB,GAAG,OAAO,CAAC,MAAM,CAAC;IAClB,GAAG,QAAQ,CAAC,MAAM,CAAC;IACnB,GAAG,gBAAgB,CAAC,MAAM,CAAC;CAC5B,CAAC,CAAC;AAEH,eAAe,UAAU,CAAC"}
@@ -1,13 +1,5 @@
1
- import { ResponseSpec, Stats, Memory, EventLog } from '../types';
1
+ import { ResponseSpec, Memory, EventLog } from '../types';
2
2
  declare const _default: (apiUrl: string) => {
3
- getStatistics: (sessionId: string) => Promise<ResponseSpec & {
4
- statistics: Stats;
5
- }>;
6
- getContentQualityIndexes: (memoriID: string) => Promise<ResponseSpec & {
7
- contentQualityIndex: number;
8
- answerQualityIndex: number;
9
- unansweredQuestions: number;
10
- }>;
11
3
  getTextQualityIndexes: (sessionId: string) => Promise<ResponseSpec & {
12
4
  textQualityIndex: number;
13
5
  undefinedWords: string[];
@@ -1,13 +1,5 @@
1
1
  import { apiFetcher } from '../apiFetcher';
2
2
  export default (apiUrl) => ({
3
- getStatistics: async (sessionId) => apiFetcher(`/Statistics/${sessionId}`, {
4
- method: 'GET',
5
- apiUrl,
6
- }),
7
- getContentQualityIndexes: async (memoriID) => apiFetcher(`/ContentQualityIndexes/${memoriID}`, {
8
- method: 'GET',
9
- apiUrl,
10
- }),
11
3
  getTextQualityIndexes: async (sessionId) => apiFetcher(`/TextQualityIndexes/${sessionId}`, {
12
4
  method: 'GET',
13
5
  apiUrl,
@@ -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,aAAa,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE,CACzC,UAAU,CAAC,eAAe,SAAS,EAAE,EAAE;QACrC,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAIA;IAMH,wBAAwB,EAAE,KAAK,EAAE,QAAgB,EAAE,EAAE,CACnD,UAAU,CAAC,0BAA0B,QAAQ,EAAE,EAAE;QAC/C,MAAM,EAAE,KAAK;QACb,MAAM;KACP,CAoBA;IAMH,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;CACJ,CAAC,CAAC"}
@@ -2,10 +2,10 @@ import memori from '../index';
2
2
  const client = memori('https://backend.memori.ai');
3
3
  describe('engine/stats api', () => {
4
4
  it('works on statistics apis', async () => {
5
- expect(await client.stats.getStatistics('768b9654-e781-4c3c-81fa-ae1529d1bfbe')).not.toBeNull();
5
+ expect(await client.stats.getEventLogs('768b9654-e781-4c3c-81fa-ae1529d1bfbe', '2021-01-01T00:00:00.000Z', '2021-01-02T00:00:00.000Z')).not.toBeNull();
6
6
  });
7
7
  it('works on statistics apis with shorthand version', async () => {
8
- expect(await client.getStatistics('768b9654-e781-4c3c-81fa-ae1529d1bfbe')).not.toBeNull();
8
+ expect(await client.getEventLogs('768b9654-e781-4c3c-81fa-ae1529d1bfbe', '2021-01-01T00:00:00.000Z', '2021-01-02T00:00:00.000Z')).not.toBeNull();
9
9
  });
10
10
  });
11
11
  //# sourceMappingURL=stats.test.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"stats.test.js","sourceRoot":"","sources":["../../src/engine/stats.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAC;AAEnD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,CACJ,MAAM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,sCAAsC,CAAC,CACzE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,CACJ,MAAM,MAAM,CAAC,aAAa,CAAC,sCAAsC,CAAC,CACnE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"stats.test.js","sourceRoot":"","sources":["../../src/engine/stats.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAC;AAEnD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,CACJ,MAAM,MAAM,CAAC,KAAK,CAAC,YAAY,CAC7B,sCAAsC,EACtC,0BAA0B,EAC1B,0BAA0B,CAC3B,CACF,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,CACJ,MAAM,MAAM,CAAC,YAAY,CACvB,sCAAsC,EACtC,0BAA0B,EAC1B,0BAA0B,CAC3B,CACF,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
package/esm/engine.d.ts CHANGED
@@ -273,14 +273,6 @@ declare const _default: (apiUrl: string) => {
273
273
  }>;
274
274
  deleteUnansweredQuestion: (sessionId: string, unansweredQuestionId: string) => Promise<import("./types").ResponseSpec>;
275
275
  };
276
- getStatistics: (sessionId: string) => Promise<import("./types").ResponseSpec & {
277
- statistics: import("./types").Stats;
278
- }>;
279
- getContentQualityIndexes: (memoriID: string) => Promise<import("./types").ResponseSpec & {
280
- contentQualityIndex: number;
281
- answerQualityIndex: number;
282
- unansweredQuestions: number;
283
- }>;
284
276
  getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
285
277
  textQualityIndex: number;
286
278
  undefinedWords: string[];
@@ -297,14 +289,6 @@ declare const _default: (apiUrl: string) => {
297
289
  eventLogs: import("./types").EventLog[];
298
290
  }>;
299
291
  stats: {
300
- getStatistics: (sessionId: string) => Promise<import("./types").ResponseSpec & {
301
- statistics: import("./types").Stats;
302
- }>;
303
- getContentQualityIndexes: (memoriID: string) => Promise<import("./types").ResponseSpec & {
304
- contentQualityIndex: number;
305
- answerQualityIndex: number;
306
- unansweredQuestions: number;
307
- }>;
308
292
  getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
309
293
  textQualityIndex: number;
310
294
  undefinedWords: string[];
package/esm/index.d.ts CHANGED
@@ -282,14 +282,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
282
282
  }>;
283
283
  deleteUnansweredQuestion: (sessionId: string, unansweredQuestionId: string) => Promise<import("./types").ResponseSpec>;
284
284
  };
285
- getStatistics: (sessionId: string) => Promise<import("./types").ResponseSpec & {
286
- statistics: import("./types").Stats;
287
- }>;
288
- getContentQualityIndexes: (memoriID: string) => Promise<import("./types").ResponseSpec & {
289
- contentQualityIndex: number;
290
- answerQualityIndex: number;
291
- unansweredQuestions: number;
292
- }>;
293
285
  getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
294
286
  textQualityIndex: number;
295
287
  undefinedWords: string[];
@@ -306,14 +298,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
306
298
  eventLogs: import("./types").EventLog[];
307
299
  }>;
308
300
  stats: {
309
- getStatistics: (sessionId: string) => Promise<import("./types").ResponseSpec & {
310
- statistics: import("./types").Stats;
311
- }>;
312
- getContentQualityIndexes: (memoriID: string) => Promise<import("./types").ResponseSpec & {
313
- contentQualityIndex: number;
314
- answerQualityIndex: number;
315
- unansweredQuestions: number;
316
- }>;
317
301
  getTextQualityIndexes: (sessionId: string) => Promise<import("./types").ResponseSpec & {
318
302
  textQualityIndex: number;
319
303
  undefinedWords: string[];
@@ -661,6 +645,21 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
661
645
  deleteCorrelationPair: (sessionId: string, pairId: string) => Promise<import("./types").ResponseSpec>;
662
646
  };
663
647
  backend: {
648
+ getCompletionConfigs: (authToken: string, purpose?: "QA" | "IE" | "DT" | undefined) => Promise<import("./types").ResponseSpec & {
649
+ configs: import("./types").CompletionConfig[];
650
+ }>;
651
+ getCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec & {
652
+ config: import("./types").CompletionConfig;
653
+ }>;
654
+ updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
655
+ completionConfigID: string;
656
+ }) => Promise<import("./types").ResponseSpec>;
657
+ deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
658
+ createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
659
+ completionConfigID?: string | undefined;
660
+ }) => Promise<import("./types").ResponseSpec & {
661
+ config: import("./types").CompletionConfig;
662
+ }>;
664
663
  analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
665
664
  status: import("./types").AnalysisStatus;
666
665
  }>;
@@ -845,7 +844,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
845
844
  ownerTenantName: string;
846
845
  ownerUserName: string;
847
846
  }) => Promise<import("./types").ResponseSpec>;
848
- memoriContentUpdated: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec>;
849
847
  getUploadAssetURL: (authToken: string, memoriID?: string | undefined, memoryID?: string | undefined) => string;
850
848
  uploadAsset: (fileName: string, fileUrl: string, authToken: string, memoriID?: string | undefined, memoryID?: string | undefined) => Promise<import("./types").ResponseSpec & {
851
849
  asset: import("./types").Asset;
@@ -923,7 +921,6 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
923
921
  ownerTenantName: string;
924
922
  ownerUserName: string;
925
923
  }) => Promise<import("./types").ResponseSpec>;
926
- memoriContentUpdated: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec>;
927
924
  };
928
925
  user: {
929
926
  userSignUp: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
@@ -1069,6 +1066,23 @@ declare const api: (backendEndpoint?: string, engineEndpoint?: string) => {
1069
1066
  matches: import("./types").UserQueryMatch[];
1070
1067
  }>;
1071
1068
  };
1069
+ completionConfig: {
1070
+ getCompletionConfigs: (authToken: string, purpose?: "QA" | "IE" | "DT" | undefined) => Promise<import("./types").ResponseSpec & {
1071
+ configs: import("./types").CompletionConfig[];
1072
+ }>;
1073
+ getCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec & {
1074
+ config: import("./types").CompletionConfig;
1075
+ }>;
1076
+ updateCompletionConfig: (authToken: string, config: Partial<import("./types").CompletionConfig> & {
1077
+ completionConfigID: string;
1078
+ }) => Promise<import("./types").ResponseSpec>;
1079
+ deleteCompletionConfig: (authToken: string, configID: string) => Promise<import("./types").ResponseSpec>;
1080
+ createCompletionConfig: (authToken: string, config: import("./types").CompletionConfig & {
1081
+ completionConfigID?: string | undefined;
1082
+ }) => Promise<import("./types").ResponseSpec & {
1083
+ config: import("./types").CompletionConfig;
1084
+ }>;
1085
+ };
1072
1086
  };
1073
1087
  };
1074
1088
  export default api;
package/esm/types.d.ts CHANGED
@@ -57,8 +57,14 @@ export declare type Memori = {
57
57
  nsfw?: boolean;
58
58
  enableCompletions?: boolean;
59
59
  completionDescription?: string;
60
- completionProvider?: '-' | 'Mistral' | 'Anthropic' | 'OpenAI';
61
- completionProviderConfig?: string;
60
+ completionConfigNameForQuestionAnswering?: string;
61
+ completionConfigForQuestionAnswering?: CompletionConfig;
62
+ completionConfigNameForImportExport?: string;
63
+ completionConfigForImportExport?: CompletionConfig;
64
+ completionConfigNameForDeepThought?: string;
65
+ completionConfigForDeepThought?: CompletionConfig;
66
+ completionTemperature?: number;
67
+ completionMaxTokens?: number;
62
68
  enableDeepThought?: boolean;
63
69
  enableBoardOfExperts?: boolean;
64
70
  disableCompletionMediaExtraction?: boolean;
@@ -83,6 +89,23 @@ export declare type Memori = {
83
89
  contentQualityIndex?: number;
84
90
  contentQualityIndexTimestamp?: string;
85
91
  };
92
+ export type CompletionConfig = {
93
+ completionConfigID: string;
94
+ configName: string;
95
+ description?: string;
96
+ provider: 'OpenAI' | 'Anthropic' | 'Mistral' | 'Azure_OpenAI';
97
+ endPoint?: string;
98
+ apiKey?: string;
99
+ model: string;
100
+ questionAnsweringEnabled?: boolean;
101
+ importExportEnabled?: boolean;
102
+ deepThoughtEnabled?: boolean;
103
+ ownerUserID?: string;
104
+ ownerUserName?: string;
105
+ ownerTenantName?: string;
106
+ visibleToTenantUsers?: boolean;
107
+ visibleToOtherUsers?: boolean;
108
+ };
86
109
  export declare type Venue = {
87
110
  placeName: string;
88
111
  latitude: number;
@@ -127,8 +150,6 @@ export declare type User = {
127
150
  lastChangeTimestamp?: string;
128
151
  referral?: string;
129
152
  couponCode?: string;
130
- defaultCompletionProvider?: '-' | 'Mistral' | 'Anthropic' | 'OpenAI';
131
- defaultCompletionProviderConfig?: string;
132
153
  paying?: boolean;
133
154
  notificationPrefs?: NotificationPrefs[];
134
155
  birthDate?: string;
@@ -221,8 +242,6 @@ export type TenantBase = {
221
242
  maxImportSizePerUser?: number;
222
243
  maxCompletions?: number;
223
244
  maxCompletionsPerUser?: number;
224
- defaultCompletionProvider?: '-' | 'Mistral' | 'Anthropic' | 'OpenAI';
225
- defaultCompletionProviderConfig?: string;
226
245
  paying?: boolean;
227
246
  enableUserMemoriCreation?: boolean;
228
247
  enableBoardOfExperts?: boolean;
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "5.0.1",
2
+ "version": "5.1.1",
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",
@@ -0,0 +1,23 @@
1
+ import memori from '../index';
2
+
3
+ const client = memori('https://backend-staging.memori.ai');
4
+
5
+ describe('backend/completionConfig api', () => {
6
+ it('works on users apis', async () => {
7
+ expect(
8
+ await client.backend.completionConfig.getCompletionConfig(
9
+ '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
10
+ 'be2e4a44-890b-483b-a26a-f6e122f36e2b'
11
+ )
12
+ ).not.toBeNull();
13
+ });
14
+
15
+ it('works on completionConfig apis with shorthand version', async () => {
16
+ expect(
17
+ await client.backend.getCompletionConfig(
18
+ '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
19
+ 'be2e4a44-890b-483b-a26a-f6e122f36e2b'
20
+ )
21
+ ).not.toBeNull();
22
+ });
23
+ });
@@ -0,0 +1,77 @@
1
+ import { ResponseSpec, CompletionConfig } from '../types';
2
+ import { apiFetcher } from '../apiFetcher';
3
+
4
+ export default (apiUrl: string) => ({
5
+ /**
6
+ * Gets a list of Completion Config objects allowed for the user.
7
+ * @param {string} authToken - The login token
8
+ * @param {string=} purpose - Optional filter on Completion Config purpose ("QA" for Question Answering, "IE" for Import/Export, "DT" for Deep Thought).
9
+ */
10
+ getCompletionConfigs: (authToken: string, purpose?: 'QA' | 'IE' | 'DT') =>
11
+ apiFetcher(
12
+ `/CompletionConfigs/${authToken}${purpose ? `/${purpose}` : ''}`,
13
+ {
14
+ apiUrl,
15
+ method: 'GET',
16
+ }
17
+ ) as Promise<
18
+ ResponseSpec & {
19
+ configs: CompletionConfig[];
20
+ }
21
+ >,
22
+
23
+ /**
24
+ * Gets the details of a Completion Config of a specific object
25
+ * @param {string} authToken - The login token
26
+ * @param {string} configID - The Completion Config object ID
27
+ */
28
+ getCompletionConfig: (authToken: string, configID: string) =>
29
+ apiFetcher(`/CompletionConfig/${authToken}/${configID}`, {
30
+ apiUrl,
31
+ method: 'GET',
32
+ }) as Promise<
33
+ ResponseSpec & {
34
+ config: CompletionConfig;
35
+ }
36
+ >,
37
+
38
+ /**
39
+ * Updates an existing Completion Config object.
40
+ * A user can only update a Completion Config object owned by him, unless it has administrative rights.
41
+ * @param {string} authToken - The login token
42
+ * @param {CompletionConfig} config - The updated Completion Config object
43
+ */
44
+ updateCompletionConfig: (
45
+ authToken: string,
46
+ config: Partial<CompletionConfig> & { completionConfigID: string }
47
+ ) =>
48
+ apiFetcher(`/CompletionConfig/${authToken}/${config.completionConfigID}`, {
49
+ apiUrl,
50
+ method: 'PATCH',
51
+ body: config,
52
+ }) as Promise<ResponseSpec>,
53
+
54
+ /**
55
+ * Deletes an existing Completion Config object.
56
+ * A user can only delete a Completion Config object owned by him, unless it has administrative rights.
57
+ */
58
+ deleteCompletionConfig: (authToken: string, configID: string) =>
59
+ apiFetcher(`/CompletionConfig/${authToken}/${configID}`, {
60
+ apiUrl,
61
+ method: 'DELETE',
62
+ }) as Promise<ResponseSpec>,
63
+
64
+ /**
65
+ * Creates a new Completion Config object.
66
+ * The created Completion Config object is owned by the currently logged-in user.
67
+ */
68
+ createCompletionConfig: (
69
+ authToken: string,
70
+ config: CompletionConfig & { completionConfigID?: string }
71
+ ) =>
72
+ apiFetcher(`/CompletionConfig/${authToken}`, {
73
+ apiUrl,
74
+ method: 'POST',
75
+ body: config,
76
+ }) as Promise<ResponseSpec & { config: CompletionConfig }>,
77
+ });
@@ -307,16 +307,4 @@ export default (apiUrl: string) => ({
307
307
  body: memori,
308
308
  method: 'POST',
309
309
  }) as Promise<ResponseSpec>,
310
-
311
- /**
312
- * Signals that the content of a Memori object has been updated.
313
- * Consequently, a run of the Content Quality Job will be scheduled as soon as possible.
314
- * @param {string} authToken - The login token
315
- * @param {string} memoriID - The ID of the Memori object
316
- */
317
- memoriContentUpdated: (authToken: string, memoriID: string) =>
318
- apiFetcher(`/MemoriContentUpdated/${authToken}/${memoriID}`, {
319
- apiUrl,
320
- method: 'POST',
321
- }) as Promise<ResponseSpec>,
322
310
  });
package/src/backend.ts CHANGED
@@ -8,6 +8,7 @@ import notifications from './backend/notifications';
8
8
  import importExport from './backend/importExport';
9
9
  import process from './backend/process';
10
10
  import analysis from './backend/analysis';
11
+ import completionConfig from './backend/completionConfig';
11
12
 
12
13
  const backendAPI = (apiUrl: string) => ({
13
14
  asset: asset(apiUrl),
@@ -20,6 +21,7 @@ const backendAPI = (apiUrl: string) => ({
20
21
  importExport: importExport(apiUrl),
21
22
  process: process(apiUrl),
22
23
  analysis: analysis(apiUrl),
24
+ completionConfig: completionConfig(apiUrl),
23
25
  ...asset(apiUrl),
24
26
  ...memori(apiUrl),
25
27
  ...user(apiUrl),
@@ -30,6 +32,7 @@ const backendAPI = (apiUrl: string) => ({
30
32
  ...importExport(apiUrl),
31
33
  ...process(apiUrl),
32
34
  ...analysis(apiUrl),
35
+ ...completionConfig(apiUrl),
33
36
  });
34
37
 
35
38
  export default backendAPI;
@@ -5,13 +5,21 @@ const client = memori('https://backend.memori.ai');
5
5
  describe('engine/stats api', () => {
6
6
  it('works on statistics apis', async () => {
7
7
  expect(
8
- await client.stats.getStatistics('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
8
+ await client.stats.getEventLogs(
9
+ '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
10
+ '2021-01-01T00:00:00.000Z',
11
+ '2021-01-02T00:00:00.000Z'
12
+ )
9
13
  ).not.toBeNull();
10
14
  });
11
15
 
12
16
  it('works on statistics apis with shorthand version', async () => {
13
17
  expect(
14
- await client.getStatistics('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
18
+ await client.getEventLogs(
19
+ '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
20
+ '2021-01-01T00:00:00.000Z',
21
+ '2021-01-02T00:00:00.000Z'
22
+ )
15
23
  ).not.toBeNull();
16
24
  });
17
25
  });
@@ -8,50 +8,6 @@ import { apiFetcher } from '../apiFetcher';
8
8
  *****************/
9
9
 
10
10
  export default (apiUrl: string) => ({
11
- /**
12
- * Computes usage statistics for the Memori of the current session.
13
- * @param {string} sessionId The session ID
14
- */
15
- getStatistics: async (sessionId: string) =>
16
- apiFetcher(`/Statistics/${sessionId}`, {
17
- method: 'GET',
18
- apiUrl,
19
- }) as Promise<
20
- ResponseSpec & {
21
- statistics: Stats;
22
- }
23
- >,
24
-
25
- /**
26
- * Computes content quality indexes for a Memori.
27
- * @param {string} memoriID - The Memori object ID
28
- */
29
- getContentQualityIndexes: async (memoriID: string) =>
30
- apiFetcher(`/ContentQualityIndexes/${memoriID}`, {
31
- method: 'GET',
32
- apiUrl,
33
- }) as Promise<
34
- ResponseSpec & {
35
- /**
36
- * @type {number}
37
- * An index of content quality of this Memori. The more content is added (and especially content with media, or stories with dates and places) the more the index grows.
38
- */
39
- contentQualityIndex: number;
40
-
41
- /**
42
- * @type {number}
43
- * An index of answer quality of this Memori. It is the ratio of the number of successful answer vs. the total of answers (successful, wrongful or missing).
44
- */
45
- answerQualityIndex: number;
46
-
47
- /**
48
- * @type {number}
49
- * The current number of unanswered questions.
50
- */
51
- unansweredQuestions: number;
52
- }
53
- >,
54
-
55
11
  /**
56
12
  * Computes text quality indexes for a Memori.
57
13
  * @param {string} sessionId - The session ID