Add rankingScoreThreshold in search (#1669)

* Add rankingScoreThreshold in search

* Update src/types/types.ts

* Update src/types/types.ts

* Apply suggestions from code review

* Update src/types/types.ts

---------

Co-authored-by: Clémentine <[email protected]>

Author: serendipty01

src/types/types.ts

@@ -127,6 +127,7 @@ export type SearchParams = Query &
     showRankingScoreDetails?: boolean;
     attributesToSearchOn?: string[] | null;
     hybrid?: HybridSearch;
+    rankingScoreThreshold?: number;
   };
 
 // Search parameters for searches made with the GET method
@@ -1011,6 +1012,14 @@ export const ErrorStatusCode = {
 
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_facet_search_facet_query */
   INVALID_FACET_SEARCH_FACET_QUERY: 'invalid_facet_search_facet_query',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_search_ranking_score_threshold */
+  INVALID_SEARCH_RANKING_SCORE_THRESHOLD:
+    'invalid_search_ranking_score_threshold',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_similar_ranking_score_threshold */
+  INVALID_SIMILAR_RANKING_SCORE_THRESHOLD:
+    'invalid_similar_ranking_score_threshold',
 };
 
 export type ErrorStatusCode =

tests/search.test.ts

@@ -306,6 +306,29 @@ describe.each([
     ]);
   });
 
+  test(`${permission} key: search with rankingScoreThreshold filter`, async () => {
+    const client = await getClient(permission);
+
+    const response = await client.index(index.uid).search('prince', {
+      showRankingScore: true,
+      rankingScoreThreshold: 0.8,
+    });
+
+    const hit = response.hits[0];
+
+    expect(response).toHaveProperty('hits', expect.any(Array));
+    expect(response).toHaveProperty('query', 'prince');
+    expect(hit).toHaveProperty('_rankingScore');
+    expect(hit['_rankingScore']).toBeGreaterThanOrEqual(0.8);
+
+    const response2 = await client.index(index.uid).search('prince', {
+      showRankingScore: true,
+      rankingScoreThreshold: 0.9,
+    });
+
+    expect(response2.hits.length).toBeLessThanOrEqual(0);
+  });
+
   test(`${permission} key: search with array options`, async () => {
     const client = await getClient(permission);