@memori.ai/memori-api-client 4.0.1 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 
 
+## [4.0.3](https://github.com/memori-ai/memori-api-client/compare/v4.0.2...v4.0.3) (2024-03-29)
+
+
+### Changes
+
+* add threshold in followers search apis ([4cf6140](https://github.com/memori-ai/memori-api-client/commit/4cf6140a80b7748b73d50a79aa8251bcc0661b6b))
+
+## [4.0.2](https://github.com/memori-ai/memori-api-client/compare/v4.0.1...v4.0.2) (2024-03-25)
+
+
+### Maintenance
+
+* add attributes to ProcessStatus ([c72da0a](https://github.com/memori-ai/memori-api-client/commit/c72da0adca92f7a799cbdba640b010ef3f9040ee))
+
 ## [4.0.1](https://github.com/memori-ai/memori-api-client/compare/v4.0.0...v4.0.1) (2024-03-22)
 
 

package/dist/backend/analysis.d.ts

@@ -3,7 +3,7 @@ declare const _default: (apiUrl: string) => {
     analyzeUserQuery: (authToken: string, memoriID: string, params: AnalysisParams) => Promise<ResponseSpec & {
         status: AnalysisStatus;
     }>;
-    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<ResponseSpec & {
+    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number) => Promise<ResponseSpec & {
         count: number;
         matches: UserQueryMatch[];
     }>;

package/dist/backend/analysis.js

@@ -9,7 +9,7 @@ exports.default = (apiUrl) => ({
             ...params,
         },
     }),
-    getUserQueryMatches: async (authToken, analysisID, from, howMany) => (0, apiFetcher_1.apiFetcher)(`/Analysis/AnalyzeUserQuery/${authToken}/${analysisID}/${from}/${howMany}`, {
+    getUserQueryMatches: async (authToken, analysisID, from, howMany, threshold) => (0, apiFetcher_1.apiFetcher)(`/Analysis/AnalyzeUserQuery/${authToken}/${analysisID}/${from}/${howMany}${threshold ? `/${threshold}` : ''}`, {
         apiUrl,
         method: 'GET',
     }),

package/dist/backend/analysis.js.map

@@ -1 +1 @@
-{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../src/backend/analysis.ts"],"names":[],"mappings":";;AAMA,8CAA2C;AAE3C,kBAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAOlC,gBAAgB,EAAE,KAAK,EACrB,SAAiB,EACjB,QAAgB,EAChB,MAAsB,EACtB,EAAE,CACF,IAAA,uBAAU,EAAC,8BAA8B,SAAS,IAAI,QAAQ,EAAE,EAAE;QAChE,MAAM;QACN,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACJ,GAAG,MAAM;SACV;KACF,CAIA;IASH,mBAAmB,EAAE,KAAK,EACxB,SAAiB,EACjB,UAAkB,EAClB,IAAY,EACZ,OAAe,EACf,EAAE,CACF,IAAA,uBAAU,EACR,8BAA8B,SAAS,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,EAAE,EAC1E;QACE,MAAM;QACN,MAAM,EAAE,KAAK;KACd,CAYF;CACJ,CAAC,CAAC"}
+{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../src/backend/analysis.ts"],"names":[],"mappings":";;AAMA,8CAA2C;AAE3C,kBAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAOlC,gBAAgB,EAAE,KAAK,EACrB,SAAiB,EACjB,QAAgB,EAChB,MAAsB,EACtB,EAAE,CACF,IAAA,uBAAU,EAAC,8BAA8B,SAAS,IAAI,QAAQ,EAAE,EAAE;QAChE,MAAM;QACN,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACJ,GAAG,MAAM;SACV;KACF,CAIA;IAUH,mBAAmB,EAAE,KAAK,EACxB,SAAiB,EACjB,UAAkB,EAClB,IAAY,EACZ,OAAe,EACf,SAAkB,EAClB,EAAE,CACF,IAAA,uBAAU,EACR,8BAA8B,SAAS,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,GACtE,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAChC,EAAE,EACF;QACE,MAAM;QACN,MAAM,EAAE,KAAK;KACd,CAYF;CACJ,CAAC,CAAC"}

package/dist/backend.d.ts

@@ -2,7 +2,7 @@ declare const backendAPI: (apiUrl: string) => {
     analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
         status: import("./types").AnalysisStatus;
     }>;
-    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
         count: number;
         matches: import("./types").UserQueryMatch[];
     }>;
@@ -402,7 +402,7 @@ declare const backendAPI: (apiUrl: string) => {
         analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
             status: import("./types").AnalysisStatus;
         }>;
-        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
             count: number;
             matches: import("./types").UserQueryMatch[];
         }>;

package/dist/index.d.ts

@@ -609,7 +609,7 @@ declare const api: (hostname?: string) => {
         analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
             status: import("./types").AnalysisStatus;
         }>;
-        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
             count: number;
             matches: import("./types").UserQueryMatch[];
         }>;
@@ -1009,7 +1009,7 @@ declare const api: (hostname?: string) => {
             analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
                 status: import("./types").AnalysisStatus;
             }>;
-            getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+            getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
                 count: number;
                 matches: import("./types").UserQueryMatch[];
             }>;

package/dist/types.d.ts

@@ -667,6 +667,7 @@ export interface ImportWarning {
 }
 export interface AnalysisParams {
     query: string;
+    threshold?: number;
 }
 export interface AnalysisWarning {
     warningType: 'Error' | string;
@@ -688,6 +689,8 @@ export interface ProcessStatus {
     begin?: string;
     end?: string;
     eta?: number;
+    processedElements?: number;
+    totalElements?: number;
     creationTimestamp?: string;
     lastChangeTimestamp?: string;
 }

package/esm/backend/analysis.d.ts

@@ -3,7 +3,7 @@ declare const _default: (apiUrl: string) => {
     analyzeUserQuery: (authToken: string, memoriID: string, params: AnalysisParams) => Promise<ResponseSpec & {
         status: AnalysisStatus;
     }>;
-    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<ResponseSpec & {
+    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number) => Promise<ResponseSpec & {
         count: number;
         matches: UserQueryMatch[];
     }>;

package/esm/backend/analysis.js

@@ -7,7 +7,7 @@ export default (apiUrl) => ({
             ...params,
         },
     }),
-    getUserQueryMatches: async (authToken, analysisID, from, howMany) => apiFetcher(`/Analysis/AnalyzeUserQuery/${authToken}/${analysisID}/${from}/${howMany}`, {
+    getUserQueryMatches: async (authToken, analysisID, from, howMany, threshold) => apiFetcher(`/Analysis/AnalyzeUserQuery/${authToken}/${analysisID}/${from}/${howMany}${threshold ? `/${threshold}` : ''}`, {
         apiUrl,
         method: 'GET',
     }),

package/esm/backend/analysis.js.map

@@ -1 +1 @@
-{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../src/backend/analysis.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,eAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAOlC,gBAAgB,EAAE,KAAK,EACrB,SAAiB,EACjB,QAAgB,EAChB,MAAsB,EACtB,EAAE,CACF,UAAU,CAAC,8BAA8B,SAAS,IAAI,QAAQ,EAAE,EAAE;QAChE,MAAM;QACN,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACJ,GAAG,MAAM;SACV;KACF,CAIA;IASH,mBAAmB,EAAE,KAAK,EACxB,SAAiB,EACjB,UAAkB,EAClB,IAAY,EACZ,OAAe,EACf,EAAE,CACF,UAAU,CACR,8BAA8B,SAAS,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,EAAE,EAC1E;QACE,MAAM;QACN,MAAM,EAAE,KAAK;KACd,CAYF;CACJ,CAAC,CAAC"}
+{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../src/backend/analysis.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,eAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAOlC,gBAAgB,EAAE,KAAK,EACrB,SAAiB,EACjB,QAAgB,EAChB,MAAsB,EACtB,EAAE,CACF,UAAU,CAAC,8BAA8B,SAAS,IAAI,QAAQ,EAAE,EAAE;QAChE,MAAM;QACN,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACJ,GAAG,MAAM;SACV;KACF,CAIA;IAUH,mBAAmB,EAAE,KAAK,EACxB,SAAiB,EACjB,UAAkB,EAClB,IAAY,EACZ,OAAe,EACf,SAAkB,EAClB,EAAE,CACF,UAAU,CACR,8BAA8B,SAAS,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,GACtE,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAChC,EAAE,EACF;QACE,MAAM;QACN,MAAM,EAAE,KAAK;KACd,CAYF;CACJ,CAAC,CAAC"}

package/esm/backend.d.ts

@@ -2,7 +2,7 @@ declare const backendAPI: (apiUrl: string) => {
     analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
         status: import("./types").AnalysisStatus;
     }>;
-    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+    getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
         count: number;
         matches: import("./types").UserQueryMatch[];
     }>;
@@ -402,7 +402,7 @@ declare const backendAPI: (apiUrl: string) => {
         analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
             status: import("./types").AnalysisStatus;
         }>;
-        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
             count: number;
             matches: import("./types").UserQueryMatch[];
         }>;

package/esm/index.d.ts

@@ -609,7 +609,7 @@ declare const api: (hostname?: string) => {
         analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
             status: import("./types").AnalysisStatus;
         }>;
-        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
             count: number;
             matches: import("./types").UserQueryMatch[];
         }>;
@@ -1009,7 +1009,7 @@ declare const api: (hostname?: string) => {
             analyzeUserQuery: (authToken: string, memoriID: string, params: import("./types").AnalysisParams) => Promise<import("./types").ResponseSpec & {
                 status: import("./types").AnalysisStatus;
             }>;
-            getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+            getUserQueryMatches: (authToken: string, analysisID: string, from: number, howMany: number, threshold?: number | undefined) => Promise<import("./types").ResponseSpec & {
                 count: number;
                 matches: import("./types").UserQueryMatch[];
             }>;

package/esm/types.d.ts

@@ -667,6 +667,7 @@ export interface ImportWarning {
 }
 export interface AnalysisParams {
     query: string;
+    threshold?: number;
 }
 export interface AnalysisWarning {
     warningType: 'Error' | string;
@@ -688,6 +689,8 @@ export interface ProcessStatus {
     begin?: string;
     end?: string;
     eta?: number;
+    processedElements?: number;
+    totalElements?: number;
     creationTimestamp?: string;
     lastChangeTimestamp?: string;
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.0.1",
+  "version": "4.0.3",
   "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/analysis.ts

@@ -36,15 +36,19 @@ export default (apiUrl: string) => ({
    * @param {string} analysisID - The Analysis process 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
+   * @param {number=} threshold Threshold between 0.0 and 1.0. User objects whose match level is below this threshold will be discarded. If null, all User objects will be returned.
    */
   getUserQueryMatches: async (
     authToken: string,
     analysisID: string,
     from: number,
-    howMany: number
+    howMany: number,
+    threshold?: number
   ) =>
     apiFetcher(
-      `/Analysis/AnalyzeUserQuery/${authToken}/${analysisID}/${from}/${howMany}`,
+      `/Analysis/AnalyzeUserQuery/${authToken}/${analysisID}/${from}/${howMany}${
+        threshold ? `/${threshold}` : ''
+      }`,
       {
         apiUrl,
         method: 'GET',

package/src/types.ts

@@ -1034,7 +1034,17 @@ export interface ImportWarning {
 }
 
 export interface AnalysisParams {
+  /**
+   * @type {string}
+   * Query to be matched with User objects in the analysis.
+   */
   query: string;
+  /**
+   * @type {number=}
+   * Threshold between 0.0 and 1.0. User objects whose match level is below this threshold will be discarded.
+   * If null, all User objects will be returned.
+   */
+  threshold?: number;
 }
 
 export interface AnalysisWarning {
@@ -1140,6 +1150,16 @@ export interface ProcessStatus {
    * Estimated time required to complete the Import process, in seconds.
    */
   eta?: number;
+  /**
+   * @type {number=}
+   * Number of elements this Process has processed so far.
+   */
+  processedElements?: number;
+  /**
+   * @type {number=}
+   * Total elements this Process is processing.
+   */
+  totalElements?: number;
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
 }