Changes related to the next Meilisearch release (v0.27.0)

.code-samples.meilisearch.yaml

@@ -109,7 +109,13 @@ update_settings_1: |-
         'wolverine': ['xmen', 'logan'],
         'logan': ['wolverine']
     },
-    'acceptNewFields': False
+    'typoTolerance': {
+        'minWordSizeForTypos': {
+            'oneTypo': 8,
+            'twoTypos': 10
+        },
+        'disableOnAttributes': ['title']
+    }
   })
 reset_settings_1: |-
   client.index('movies').reset_settings()
@@ -180,6 +186,20 @@ update_displayed_attributes_1: |-
   ])
 reset_displayed_attributes_1: |-
   client.index('movies').reset_displayed_attributes()
+get_typo_tolerance_1:
+  client.index('books').get_typo_tolerance()
+update_typo_tolerance_1: |-
+  client.index('books').update_typo_tolerance({
+    'minWordSizeForTypos': {
+        'oneTypo': 4,
+        'twoTypos': 10
+      },
+      'disableOnAttributes': [
+         'title'
+      ]
+  })
+reset_typo_tolerance_1: |-
+  client.index('books').reset_typo_tolerance()
 get_sortable_attributes_1: |-
   client.index('books').get_sortable_attributes()
 update_sortable_attributes_1: |-
@@ -243,12 +263,23 @@ search_parameter_guide_retrieve_1: |-
 search_parameter_guide_crop_1: |-
   client.index('movies').search('shifu', {
     'attributesToCrop': ['overview'],
-    'cropLength': 10
+    'cropLength': 5
+  })
+search_parameter_guide_crop_marker_1: |-
+  client.index('movies').search('shifu', {
+    'attributesToCrop': ['overview'],
+    'cropMarker': '[…]'
   })
 search_parameter_guide_highlight_1: |-
   client.index('movies').search('winter feast', {
     'attributesToHighlight': ['overview']
   })
+search_parameter_guide_highlight_tag_1: |-
+  client.index('movies').search('winter feast', {
+    'attributesToHighlight': ['overview'],
+    'highlightPreTag': '<span class="highlight">',
+    'highlightPostTag': '</span>'
+  })
 search_parameter_guide_matches_1: |-
   client.index('movies').search('winter feast', {
     'matches': 'true'
@@ -309,6 +340,34 @@ settings_guide_sortable_1: |-
       'author'
     ]
   })
+settings_guide_typo_tolerance_1: |-
+  client.index('movies').update_typo_tolerance({
+    'minWordSizeForTypos': {
+      'twoTypos': 12
+    },
+    'disableOnAttributes': [
+      'title'
+    ]
+  })
+typo_tolerance_guide_1: |-
+  client.index('movies').update_typo_tolerance({
+    'enabled': False
+  })
+typo_tolerance_guide_2: |-
+  client.index('movies').update_typo_tolerance({
+    'disableOnAttributes': ['title']
+  })
+typo_tolerance_guide_3: |-
+  client.index('movies').update_typo_tolerance({
+    'disableOnWords': ['shrek']
+  })
+typo_tolerance_guide_4: |-
+  client.index('movies').update_typo_tolerance({
+    'minWordSizeForTypos': {
+      'oneTypo': 4,
+      'twoTypos': 10
+    }
+  })
 add_movies_json_1: |-
   import json
 

.github/workflows/pre-release-tests.yml

@@ -29,6 +29,6 @@ jobs:
       - name: Get the latest Meilisearch RC
         run: echo "MEILISEARCH_VERSION=$(curl https://raw.githubusercontent.com/meilisearch/integration-guides/main/scripts/get-latest-meilisearch-rc.sh | bash)" >> $GITHUB_ENV
       - name: Meilisearch (${{ env.MEILISEARCH_VERSION }}) setup with Docker
-        run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} ./meilisearch --master-key=masterKey --no-analytics
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} meilisearch --master-key=masterKey --no-analytics
       - name: Test with pytest
         run: pipenv run pytest

.github/workflows/tests.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Install dependencies
         run: pipenv install --dev
       - name: Meilisearch (latest version) setup with Docker
-        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics --master-key=masterKey
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics --master-key=masterKey
       - name: Test with pytest
         run: pipenv run pytest
 

CONTRIBUTING.md

@@ -51,7 +51,7 @@ Optionally tox can be used to run test on all supported version of Python, mypy,
 
 ```bash
 docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
-docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics
+docker run -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=masterKey --no-analytics
 pipenv run tox
 ```
 

README.md

@@ -197,7 +197,7 @@ index.search(
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.26.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.26.0).
+This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
 
 ## 💡 Learn More
 

datasets/nested_movies.json

@@ -0,0 +1,54 @@
+[
+  {
+    "id": 1,
+    "title": "Pride and Prejudice",
+    "info": {
+      "comment": "A great book",
+      "reviewNb": 50
+    }
+  },
+  {
+    "id": 2,
+    "title": "Le Petit Prince",
+    "info": {
+      "comment": "A french book",
+      "reviewNb": 600
+    }
+  },
+  {
+    "id": 3,
+    "title": "Le Rouge et le Noir",
+    "info": {
+      "comment": "Another french book",
+      "reviewNb": 700
+    }
+  },
+  {
+    "id": 4,
+    "title": "Alice In Wonderland",
+    "comment": "A weird book",
+    "info": {
+      "comment": "A weird book",
+      "reviewNb": 800
+    }
+  },
+  {
+    "id": 5,
+    "title": "The Hobbit",
+    "info": {
+      "comment": "An awesome book",
+      "reviewNb": 900
+    }
+  },
+  {
+    "id": 6,
+    "title": "Harry Potter and the Half-Blood Prince",
+    "info": {
+      "comment": "The best book",
+      "reviewNb": 1000
+    }
+  },
+  { "id": 7,
+    "title": "The Hitchhiker's Guide to the Galaxy"
+  }
+]

meilisearch/config.py

@@ -25,6 +25,7 @@ class Paths():
         accept_new_fields = 'accept-new-fields'
         filterable_attributes = 'filterable-attributes'
         sortable_attributes = 'sortable-attributes'
+        typo_tolerance = 'typo-tolerance'
         dumps = 'dumps'
 
     def __init__(