refactor: add threshold in followers search apis

memori-ai · Mar 29, 2024 · 4cf6140 · 4cf6140
1 parent ecf43c0
commit 4cf6140
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/src/backend/analysis.ts b/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',

diff --git a/src/types.ts b/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 {