Merge branch 'main' into sort-facets-value-460

Author: curquiza

.code-samples.meilisearch.yaml

@@ -809,3 +809,16 @@ facet_search_2: |-
       }
   };
   await client.Index("books").UpdateFacetingAsync(newFaceting);
+facet_search_1: |-
+  var query = new SearchFacetsQuery()
+  {
+    FacetQuery = "fiction",
+    Filter = "rating > 3"
+  };
+  await client.Index("books").FacetSearchAsync("genres", query);
+facet_search_3: |-
+  var query = new SearchFacetsQuery()
+  {
+    FacetQuery = "c"
+  };
+  await client.Index("books").FacetSearchAsync("genres", query);

src/Meilisearch/FacetSearchQuery.cs

@@ -0,0 +1,47 @@
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace Meilisearch
+{
+    /// <summary>
+    /// Wrapper for facet search query
+    /// </summary>
+    public class FacetSearchQuery
+    {
+        /// <summary>
+        /// Gets or sets the facetName property
+        /// </summary>
+        [JsonPropertyName("facetName")]
+        public string FacetName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the facetQuery property
+        /// </summary>
+        [JsonPropertyName("facetQuery")]
+        public string FacetQuery { get; set; }
+
+        /// <summary>
+        /// Gets or sets the q property
+        /// </summary>
+        [JsonPropertyName("q")]
+        public string Query { get; set; }
+
+        /// <summary>
+        /// Gets or sets the filter property
+        /// </summary>
+        [JsonPropertyName("filter")]
+        public dynamic Filter { get; set; }
+
+        /// <summary>
+        /// Gets or sets the matchingStrategy property, can be <c>last</c>, <c>all</c> or <c>frequency</c>.
+        /// </summary>
+        [JsonPropertyName("matchingStrategy")]
+        public string MatchingStrategy { get; set; }
+
+        /// <summary>
+        /// Gets or sets the attributesToSearchOn property
+        /// </summary>
+        [JsonPropertyName("attributesToSearchOn")]
+        public IEnumerable<string> AttributesToSearchOn { get; set; }
+    }
+}

src/Meilisearch/FacetSearchResult.cs

@@ -0,0 +1,47 @@
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace Meilisearch
+{
+    /// <summary>
+    /// Wrapper for FacetSearchResponse
+    /// </summary>
+    public class FacetSearchResult
+    {
+        /// <summary>
+        /// Gets or sets the facetHits property
+        /// </summary>
+        [JsonPropertyName("facetHits")]
+        public IEnumerable<FacetHit> FacetHits { get; set; }
+
+        /// <summary>
+        /// Gets or sets the facet query
+        /// </summary>
+        [JsonPropertyName("facetQuery")]
+        public string FacetQuery { get; set; }
+
+        /// <summary>
+        /// Gets or sets the processingTimeMs property
+        /// </summary>
+        [JsonPropertyName("processingTimeMs")]
+        public int ProcessingTimeMs { get; set; }
+
+        /// <summary>
+        /// Wrapper for Facet Hit
+        /// </summary>
+        public class FacetHit
+        {
+            /// <summary>
+            /// Gets or sets the value property
+            /// </summary>
+            [JsonPropertyName("value")]
+            public string Value { get; set; }
+
+            /// <summary>
+            /// Gets or sets the count property
+            /// </summary>
+            [JsonPropertyName("count")]
+            public int Count { get; set; }
+        }
+    }
+}

src/Meilisearch/Index.Documents.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net.Http;
@@ -543,5 +542,35 @@ public async Task<ISearchable<T>> SearchAsync<T>(string query,
                 .ReadFromJsonAsync<ISearchable<T>>(cancellationToken: cancellationToken)
                 .ConfigureAwait(false);
         }
+
+        /// <summary>
+        /// Search index facets
+        /// </summary>
+        /// <param name="facetName">Name of the facet to search.</param>
+        /// <param name="query">The search criteria to find the facet matches.</param>
+        /// <param name="cancellationToken">The cancellation token for this call.</param>
+        /// <returns>Facets meeting the search criteria.</returns>
+        public async Task<FacetSearchResult> FacetSearchAsync(string facetName,
+            FacetSearchQuery query = default, CancellationToken cancellationToken = default)
+        {
+            FacetSearchQuery body;
+            if (query == null)
+            {
+                body = new FacetSearchQuery() { FacetName = facetName };
+            }
+            else
+            {
+                body = query;
+                body.FacetName = facetName;
+            }
+
+            var responseMessage = await _http.PostAsJsonAsync($"indexes/{Uid}/facet-search", body,
+                    Constants.JsonSerializerOptionsRemoveNulls, cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+
+            return await responseMessage.Content
+                .ReadFromJsonAsync<FacetSearchResult>(cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+        }
     }
 }

src/Meilisearch/SearchQuery.cs

@@ -147,6 +147,6 @@ public class SearchQuery
         /// Gets or sets rankingScoreThreshold, a number between 0.0 and 1.0. 
         /// </summary>
         [JsonPropertyName("rankingScoreThreshold")]
-        public decimal RankingScoreThreshold { get; set; }
+        public decimal? RankingScoreThreshold { get; set; }
     }
 }