Merge branch 'main' into create-snapshot-501

Author: curquiza

.code-samples.meilisearch.yaml

@@ -797,3 +797,16 @@ reset_dictionary_1: |-
   await client.Index("books").ResetDictionaryAsync();
 create_snapshot_1: |-
   await client.CreateSnapshotAsync();
+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);

README.md

@@ -30,7 +30,6 @@
 ## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
-- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🚀 Getting started](#-getting-started)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
@@ -49,10 +48,6 @@ This readme contains all the documentation you need to start using this Meilisea
 For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs/).
 
 
-## ⚡ Supercharge your Meilisearch experience
-
-Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-dotnet). Get started with a 14-day free trial! No credit card required.
-
 ## 🔧 Installation
 
 This package targets .NET Standard 2.1.
@@ -71,18 +66,9 @@ Install-Package MeiliSearch
 
 ### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
-
-For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
-
-```bash
-# Install Meilisearch
-curl -L https://install.meilisearch.com | sh
-# Launch Meilisearch
-./meilisearch --master-key=masterKey
-```
+⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-dotnet).
 
-NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
+🪨  Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-dotnet) our fast, open-source search engine on your own infrastructure.
 
 ## 🚀 Getting started
 

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; }
     }
 }