Merge #352

352: Add search example with `filter` r=curquiza a=Sukriti-sood

Fixes #349 

Co-authored-by: Sukriti-sood <[email protected]>
Co-authored-by: Sukriti Sood <[email protected]>
Co-authored-by: Clémentine Urquizar <[email protected]>

Author: 3 people

README.md

@@ -152,6 +152,49 @@ JSON output:
 }
 ```
 
+#### Custom Search With Filters <!-- omit in toc -->
+
+If you want to enable filtering, you must add your attributes to the `filterableAttributes` index setting.
+
+```py
+index.update_filterable_attributes([
+  'id',
+  'genres'
+])
+```
+
+You only need to perform this operation once.
+
+Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+
+Then, you can perform the search:
+
+```py
+index.search(
+  'wonder',
+  {
+    filter: ['id > 1 AND genres = Action']
+  }
+)
+```
+
+```json
+{
+  "hits": [
+    {
+      "id": 2,
+      "title": "Wonder Woman",
+      "genres": ["Action","Adventure"]
+    }
+  ],
+  "offset": 0,
+  "limit": 20,
+  "nbHits": 1,
+  "processingTimeMs": 0,
+  "query": "wonder"
+}
+```
+
 ## 🤖 Compatibility with MeiliSearch
 
 This package only guarantees the compatibility with the [version v0.23.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.23.0).