Changes regarding Meilisearch v0.27.0

[brunoocasali]

This issue gathers the changes related to the v0.27.0 of Meilisearch that will impact the integrations.

Release date: 09/05/2022

The whole milestone of v0.27.0 is here: https://github.com/meilisearch/meilisearch/milestone/28

---

Docker run changes

Related to:

• issue: Tracking issue: simplify Docker usage and Dockerfile meilisearch#2235

Meilisearch docker image has changed a lot internally in order to make it simpler to run and maintain:

old way: ❌
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics
new way: ✅
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics

This change will be made by our internal tool, just need to be reviewed.

Support nested fields

Related to:

• issue: Support nested fields meilisearch#2211
• spec: Data Types - Add Nested Fields Support specifications#121

In this new version, Meilisearch will add support to access nested fields, which means now we can define the searchableAttributes the value of person.documents.passport directly, without having to deal with the nesting definition.

According to the spec, the API will support the usage of nested fields in every place we need a document attribute (eg. searchableAttributes, attributesToRetrieve, filterableAttributes, and so on).

Since this change does not affect any integration directly, we could still ensure that the behavior is maintained through tests.

Customize the typo tolerance

Related to:

• this issue Customize the typo tolerance meilisearch#2213
• this spec: Settings API - Typo Tolerance specifications#117

Add a typoTolerance index settings resource to manage customization of the typo tolerance feature at the index level.

• Expose typoTolerance object on /indexes/:index_uid/settings endpoints.
• Add GET/POST/DELETE - /indexes/:index_uid/settings/typo-tolerance endpoints.

The typoTolerance object definition is made of the following properties:

• enabled type (boolean)
• disableOnAttributes type (array[string])
• disableOnWords type (array[string])
• minWordSizeForTypos type (object)
  • oneTypo type (int)
  • twoTypos type (int)

More information about what each field does could be checked in the spec.

We will provide a good first issue for some of the SDKs, and the Integrations team will be responsible to implement the feature on the others.

• Integrations team: Python, JavaScript, PHP, .NET.
• Community: Go, Symfony, Java, Swift, Rust, Dart, Ruby, Ruby on Rails.

😃 Friendly reminder is about the testing, we just need to ensure our integration is correctly calling the endpoint with the correct values, we should not check if the typo tolerance is working.

Improve and stabilize cropping and highlighting

Related to:

• this issue: Improve and stabilize cropping and highlighting meilisearch#2214
• this spec: Search API - Formatting Search Results specifications#120

This new version comes with the possibility to customize the highlighting tag we use to mark the important parts of the search result.

Add support to use these new search attributes:

• highlightPreTag type (string default "<em>")
  • could be any valid string, no need to validate.
• highlightPostTag type (string default "</em>")
  • could be any valid string, no need to validate.
• cropMarker type (string default "…")
  • could be any valid string, no need to validate.

For some particular SDK maybe there is no change needed in the public API, but we still must add some tests to make
sure the SDK will handle the new parameters correctly.

---

[EDIT 25 April]

Code samples update

1. Update search_parameter_guide_crop_1 PR:

Change the value of cropLength from 10 to 5.

2. New search_parameter_guide_crop_marker_1 PR:

Search request in the movies index with these params:

• q: "shifu",
• cropMarker: "[…]",
• attributesToCrop: ["overview"]

3. New search_parameter_guide_highlight_tag_1 PR:

Search request in the movies index with these params:

• q: "winter feast",
• attributesToHighlight: ["overview"],
• highlightPreTag: "<span class=\"highlight\">"
• highlightPostTag: "</span>"

4) Typo tolerance changes::

Check this PR to see all the changes regarding the typo tolerance meilisearch/documentation#1606.
⚠️ Only for the required SDKs.

[brunoocasali]

FYI: @meilisearch/integration-team

Regarding the typo-tolerance implementation, I moved Ruby/Rails repositories to the community side. I will implement it in the .NET package instead.

[brunoocasali]

I created all the issues and automated PRs. Let me know if you have any problem :)

[brunoocasali]

@meilisearch/integration-team I've added the code-samples section of the issue as we agreed in our internal meeting :)

[bidoubiwa]

Changes in the typo tolerance code-samples:

get_typo_tolerance => get_typo_tolerance_1
update_typo_tolerance => update_typo_tolerance_1
reset_typo_tolerance => reset_typo_tolerance_1

[brunoocasali]

Congratulations team, we made it! 🎉 🎉