Merge pull request #505 from meilisearch/search-changes

Apply search changes

Author: alallema

src/main/java/com/meilisearch/sdk/Search.java

@@ -48,9 +48,9 @@ String rawSearch(String uid, String q) throws MeilisearchException {
      * @param highlightPostTag String to customize highlight tag after every highlighted query terms
      * @param attributesToHighlight Attributes whose values will contain highlighted matching terms
      * @param filter Filter queries by an attribute value
-     * @param matches Defines whether an object that contains information about the matches should
-     *     be returned or not
-     * @param facetsDistribution Facets for which to retrieve the matching count
+     * @param showMatchesPosition Defines whether an object that contains information about the
+     *     matches should be returned or not
+     * @param facets Facets for which to retrieve the matching count
      * @param sort Sort queries by an attribute value
      * @return search results, as raw data
      * @throws MeilisearchException Search Exception or Client Error
@@ -68,8 +68,8 @@ String rawSearch(
             String highlightPostTag,
             String[] attributesToHighlight,
             String[] filter,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort)
             throws MeilisearchException {
         String requestQuery = "/indexes/" + uid + "/search";
@@ -86,8 +86,8 @@ String rawSearch(
                         highlightPostTag,
                         attributesToHighlight,
                         filter,
-                        matches,
-                        facetsDistribution,
+                        showMatchesPosition,
+                        facets,
                         sort);
         return httpClient.post(requestQuery, sr, String.class);
     }
@@ -131,9 +131,9 @@ SearchResult search(String uid, String q) throws MeilisearchException {
      * @param highlightPostTag String to customize highlight tag after every highlighted query terms
      * @param attributesToHighlight Attributes whose values will contain highlighted matching terms
      * @param filter Filter queries by an attribute value
-     * @param matches Defines whether an object that contains information about the matches should
-     *     be returned or not
-     * @param facetsDistribution Facets for which to retrieve the matching count
+     * @param showMatchesPosition Defines whether an object that contains information about the
+     *     matches should be returned or not
+     * @param facets Facets for which to retrieve the matching count
      * @param sort Sort queries by an attribute value
      * @return search results
      * @throws MeilisearchException Search Exception or Client Error
@@ -151,8 +151,8 @@ SearchResult search(
             String highlightPostTag,
             String[] attributesToHighlight,
             String[] filter,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort)
             throws MeilisearchException {
         return httpClient.jsonHandler.decode(
@@ -169,8 +169,8 @@ SearchResult search(
                         highlightPostTag,
                         attributesToHighlight,
                         filter,
-                        matches,
-                        facetsDistribution,
+                        showMatchesPosition,
+                        facets,
                         sort),
                 SearchResult.class);
     }

src/main/java/com/meilisearch/sdk/SearchRequest.java

@@ -22,8 +22,8 @@ public class SearchRequest {
     private String[] attributesToHighlight;
     private String[] filter;
     private String[][] filterArray;
-    private boolean matches;
-    private String[] facetsDistribution;
+    private boolean showMatchesPosition;
+    private String[] facets;
     private String[] sort;
 
     /** Empty SearchRequest constructor */
@@ -32,7 +32,7 @@ public SearchRequest() {}
     /**
      * Constructor for SearchRequest for building search queries with the default values: offset: 0,
      * limit: 20, attributesToRetrieve: ["*"], attributesToCrop: null, cropLength: 200,
-     * attributesToHighlight: null, filter: null, matches: false, facetsDistribution: null, sort:
+     * attributesToHighlight: null, filter: null, showMatchesPosition: false, facets: null, sort:
      * null
      *
      * @param q Query String
@@ -44,7 +44,7 @@ public SearchRequest(String q) {
     /**
      * Constructor for SearchRequest for building search queries with the default values: limit: 20,
      * attributesToRetrieve: ["*"], attributesToCrop: null, cropLength: 200, attributesToHighlight:
-     * null, filter: null, matches: false, facetsDistribution: null, sort: null
+     * null, filter: null, showMatchesPosition: false, facets: null, sort: null
      *
      * @param q Query String
      * @param offset Number of documents to skip
@@ -56,7 +56,7 @@ public SearchRequest(String q, int offset) {
     /**
      * Constructor for SearchRequest for building search queries with the default values:
      * attributesToRetrieve: ["*"], attributesToCrop: null, cropLength: 200, attributesToHighlight:
-     * null, filter: null, matches: false, facetsDistribution: null, sort: null
+     * null, filter: null, showMatchesPosition: false, facets: null, sort: null
      *
      * @param q Query String
      * @param offset Number of documents to skip
@@ -68,8 +68,8 @@ public SearchRequest(String q, int offset, int limit) {
 
     /**
      * Constructor for SearchRequest for building search queries with the default values:
-     * attributesToCrop: null, cropLength: 200, attributesToHighlight: null, filter: null, matches:
-     * false, facetsDistribution: null, sort: null
+     * attributesToCrop: null, cropLength: 200, attributesToHighlight: null, filter: null,
+     * showMatchesPosition: false, facets: null, sort: null
      *
      * @param q Query String
      * @param offset Number of documents to skip
@@ -105,9 +105,9 @@ public SearchRequest(String q, int offset, int limit, String[] attributesToRetri
      * @param cropLength Length used to crop field values
      * @param attributesToHighlight Attributes whose values will contain highlighted matching terms
      * @param filter Filter queries by an attribute value
-     * @param matches Defines whether an object that contains information about the matches should
-     *     be returned or not
-     * @param facetsDistribution Facets for which to retrieve the matching count
+     * @param showMatchesPosition Defines whether an object that contains information about the
+     *     matches should be returned or not
+     * @param facets Facets for which to retrieve the matching count
      * @param sort Sort queries by an attribute value
      */
     public SearchRequest(
@@ -119,8 +119,8 @@ public SearchRequest(
             int cropLength,
             String[] attributesToHighlight,
             String[] filter,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort) {
         this(
                 q,
@@ -135,8 +135,8 @@ public SearchRequest(
                 attributesToHighlight,
                 filter,
                 null,
-                matches,
-                facetsDistribution,
+                showMatchesPosition,
+                facets,
                 sort);
     }
 
@@ -154,9 +154,9 @@ public SearchRequest(
      * @param highlightPostTag String to customize highlight tag after every highlighted query terms
      * @param attributesToHighlight Attributes whose values will contain highlighted matching terms
      * @param filter Filter queries by an attribute value
-     * @param matches Defines whether an object that contains information about the matches should
-     *     be returned or not
-     * @param facetsDistribution Facets for which to retrieve the matching count
+     * @param showMatchesPosition Defines whether an object that contains information about the
+     *     matches should be returned or not
+     * @param facets Facets for which to retrieve the matching count
      * @param sort Sort queries by an attribute value
      */
     public SearchRequest(
@@ -171,8 +171,8 @@ public SearchRequest(
             String highlightPostTag,
             String[] attributesToHighlight,
             String[] filter,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort) {
         this(
                 q,
@@ -187,8 +187,8 @@ public SearchRequest(
                 attributesToHighlight,
                 filter,
                 null,
-                matches,
-                facetsDistribution,
+                showMatchesPosition,
+                facets,
                 sort);
     }
 
@@ -203,9 +203,9 @@ public SearchRequest(
      * @param cropLength Length used to crop field values
      * @param attributesToHighlight Attributes whose values will contain highlighted matching terms
      * @param filterArray String array that can take multiple nested filters
-     * @param matches Defines whether an object that contains information about the matches should
-     *     be returned or not
-     * @param facetsDistribution Facets for which to retrieve the matching count
+     * @param showMatchesPosition Defines whether an object that contains information about the
+     *     matches should be returned or not
+     * @param facets Facets for which to retrieve the matching count
      * @param sort Sort queries by an attribute value
      */
     public SearchRequest(
@@ -217,8 +217,8 @@ public SearchRequest(
             int cropLength,
             String[] attributesToHighlight,
             String[][] filterArray,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort) {
         this(
                 q,
@@ -233,8 +233,8 @@ public SearchRequest(
                 attributesToHighlight,
                 null,
                 filterArray,
-                matches,
-                facetsDistribution,
+                showMatchesPosition,
+                facets,
                 sort);
     }
 
@@ -252,9 +252,9 @@ public SearchRequest(
      * @param highlightPostTag String to customize highlight tag after every highlighted query terms
      * @param attributesToHighlight Attributes whose values will contain highlighted matching terms
      * @param filterArray String array that can take multiple nested filters
-     * @param matches Defines whether an object that contains information about the matches should
-     *     be returned or not
-     * @param facetsDistribution Facets for which to retrieve the matching count
+     * @param showMatchesPosition Defines whether an object that contains information about the
+     *     matches should be returned or not
+     * @param facets Facets for which to retrieve the matching count
      * @param sort Sort queries by an attribute value
      */
     public SearchRequest(
@@ -269,8 +269,8 @@ public SearchRequest(
             String highlightPostTag,
             String[] attributesToHighlight,
             String[][] filterArray,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort) {
         this(
                 q,
@@ -285,8 +285,8 @@ public SearchRequest(
                 attributesToHighlight,
                 null,
                 filterArray,
-                matches,
-                facetsDistribution,
+                showMatchesPosition,
+                facets,
                 sort);
     }
 
@@ -303,8 +303,8 @@ private SearchRequest(
             String[] attributesToHighlight,
             String[] filter,
             String[][] filterArray,
-            boolean matches,
-            String[] facetsDistribution,
+            boolean showMatchesPosition,
+            String[] facets,
             String[] sort) {
         this.q = q;
         this.offset = offset;
@@ -318,8 +318,8 @@ private SearchRequest(
         this.attributesToHighlight = attributesToHighlight;
         this.setFilter(filter);
         this.setFilterArray(filterArray);
-        this.matches = matches;
-        this.facetsDistribution = facetsDistribution;
+        this.showMatchesPosition = showMatchesPosition;
+        this.facets = facets;
         this.sort = sort;
     }
 
@@ -352,8 +352,8 @@ public String toString() {
                         .put("cropMarker", this.cropMarker)
                         .put("highlightPreTag", this.highlightPreTag)
                         .put("highlightPostTag", this.highlightPostTag)
-                        .put("matches", this.matches)
-                        .put("facetsDistribution", this.facetsDistribution)
+                        .put("showMatchesPosition", this.showMatchesPosition)
+                        .put("facets", this.facets)
                         .put("sort", this.sort)
                         .putOpt("attributesToCrop", this.attributesToCrop)
                         .putOpt("attributesToHighlight", this.attributesToHighlight)

src/main/java/com/meilisearch/sdk/model/SearchResult.java

@@ -17,10 +17,8 @@ public class SearchResult implements Serializable {
     protected ArrayList<HashMap<String, Object>> hits;
     protected int offset;
     protected int limit;
-    protected int nbHits;
-    protected boolean exhaustiveNbHits;
-    protected Object facetsDistribution;
-    protected boolean exhaustiveFacetsCount;
+    protected int estimatedTotalHits;
+    protected Object facetDistribution;
     protected int processingTimeMs;
     protected String query;
 

src/test/java/com/meilisearch/integration/SearchNestedTest.java

@@ -24,7 +24,6 @@ final class Results {
         int offset;
         int limit;
         int nbHits;
-        boolean exhaustiveNbHits;
         int processingTimeMs;
         String query;
     }

src/test/java/com/meilisearch/integration/SearchTest.java

@@ -27,8 +27,7 @@ final class Results {
         Movie[] hits;
         int offset;
         int limit;
-        int nbHits;
-        boolean exhaustiveNbHits;
+        int estimatedTotalHits;
         int processingTimeMs;
         String query;
     }
@@ -59,11 +58,11 @@ public void testBasicSearch() throws Exception {
 
         SearchResult searchResult = index.search("batman");
 
-        assertNull(searchResult.getFacetsDistribution());
+        assertNull(searchResult.getFacetDistribution());
         assertEquals(1, searchResult.getHits().size());
         assertEquals(0, searchResult.getOffset());
         assertEquals(20, searchResult.getLimit());
-        assertEquals(1, searchResult.getNbHits());
+        assertEquals(1, searchResult.getEstimatedTotalHits());
     }
 
     /** Test search offset */
@@ -81,7 +80,7 @@ public void testSearchOffset() throws Exception {
         SearchResult searchResult = index.search(searchRequest);
 
         assertEquals(10, searchResult.getHits().size());
-        assertEquals(30, searchResult.getNbHits());
+        assertEquals(30, searchResult.getEstimatedTotalHits());
     }
 
     /** Test search limit */
@@ -99,7 +98,7 @@ public void testSearchLimit() throws Exception {
         SearchResult searchResult = index.search(searchRequest);
 
         assertEquals(2, searchResult.getHits().size());
-        assertEquals(30, searchResult.getNbHits());
+        assertEquals(30, searchResult.getEstimatedTotalHits());
     }
 
     /** Test search attributesToRetrieve */
@@ -316,13 +315,12 @@ public void testSearchFacetsDistribution() throws Exception {
         settings.setFilterableAttributes(new String[] {"title"});
         index.waitForTask(index.updateSettings(settings).getUid());
 
-        SearchRequest searchRequest =
-                new SearchRequest("knight").setFacetsDistribution(new String[] {"*"});
+        SearchRequest searchRequest = new SearchRequest("knight").setFacets(new String[] {"*"});
 
         SearchResult searchResult = index.search(searchRequest);
 
         assertEquals(1, searchResult.getHits().size());
-        assertNotNull(searchResult.getFacetsDistribution());
+        assertNotNull(searchResult.getFacetDistribution());
     }
 
     /** Test search sort */
@@ -454,7 +452,7 @@ public void testSearchMatches() throws Exception {
 
         index.waitForTask(task.getUid());
 
-        SearchRequest searchRequest = new SearchRequest("and").setMatches(true);
+        SearchRequest searchRequest = new SearchRequest("and").setShowMatchesPosition(true);
         SearchResult searchResult = index.search(searchRequest);
 
         assertEquals(20, searchResult.getHits().size());