Changes related to Meilisearch v1.10.0

[curquiza]

This issue gathers the changes related to the v1.10.0 of Meilisearch that will impact the integrations scope.

📅 Release date: 2024-08-26

Timelines & steps

Pre-release

• With the help of the Product team and this CI, define which integrations should be updated and how (New feature? Update README? Update tests?) -> Fill in the "What to implement?" section below in this issue 👇.
  Minial implementation: PHP, JS, Instant-meilisearch.
• Create a branch by running Octopus script: only open branches for the integrations we choose to update (defined in the previous step) + Kubernetes repository + Cloud provider repository (changing the version)
• Update integrations according to the decisions (cf "What to implement?" section below in this issue 👇)
  ⚠️ If possible, this step is done before pre-release, once the feature is ready thanks to the prototype released by the engine team
  • JS: implementation of new features + update tests
  • PHP: implementation of new features
  • Instant-meilisearch (update meilisearch-js version)
• Add code samples for the chosen up-to-date integrations with the new version of Meilisearch
• Update the library version of the related integrations and prepare the changelogs

Release day

• Release the integrations
  • JS
  • PHP
  • Instant-meilisearch (update the meilisearch-js version)
• Merge the related PR in K8s repository
• Publish DevOps tools:
  • create the git tag
  • publish images (steps are in CONTRIBUTING.md)
• Open issues in the repositories that are not up-to-date with the latest version of Meilisearch (including code samples)
• Update AI-powered search issues still opened in some repositories (example here)
• Delete ALL images from AWS (devOps tools)
• Close this issue once all the steps below are done

What to implement?

Federated search

Usage: https://meilisearch.notion.site/v1-10-federated-search-698dfe36ab6b4668b044f735fb40f0b2?pvs=74

Pass new search parameters to /multi-search route to get one single list of result

TODO:

• JS: [v1.10.0] Federated search meilisearch-js#1683
• PHP: [v1.10.0] Federated search meilisearch-php#659

The following integrations will not have the feature available for the release day except if the community implements it: .NET, Dart, Go, Java, Python, Ruby, Rust, Swift

Language settings & search parameter

Usage: https://meilisearch.notion.site/v1-10-Language-settings-usage-26c5d98b553349d9abacbe7aff698e4e

• new settings localizedAttributes and the methods associated to it
• new search parameter locales

TODO:

• JS: [v1.10.0] Language settings & search parameter meilisearch-js#1684
• PHP: [v1.10.0] Language settings & search parameter meilisearch-php#660

The following integrations will not have the feature available for the release day except if the community implements it: .NET, Dart, Go, Java, Python, Ruby, Rust, Swift
Implemented by default without doing anything for the search parameter: Python, Ruby

Experimental: edit documents by using a function

Usage: https://meilisearch.notion.site/Update-Documents-by-Function-0cff8fea7655436592e7c8a6de932062

New route /indexes/UID/documents/edit to update document following a function in function field

TODO:

• JS: [v1.10.0] Update documents by function meilisearch-js#1686
• PHP: [v1.10.0] Update documents by function meilisearch-php#661

The following integrations will not have the feature available for the release day except if the community implements it: .NET, Dart, Go, Java, Python, Ruby, Rust, Swift

Experimental AI-powered search: quality of life improvements

Usage: https://meilisearch.notion.site/v1-10-AI-search-changes-737c9d7d010d4dd685582bf5dab579e2?pvs=74

• Rest API
  • Removed parameters: query, inputField, inputType, pathToEmbeddings and embeddingObject.
  • Replaced by request and response
  • New parameter: headers
• Add url parameter to the OpenAI embedder
• dimensions is now available as an optional parameter for ollama embedders.

TODO:

• JS: [v1.10.0] AI-powered search changes meilisearch-js#1685
• JS: Update tests
• PHP: nothing to change on this since the embedder models are not defined in the code 🎉

Vector search feature will be fully available in: PHP, JS
Vector search will be partially available (missing methods or models): Python, Go, Ruby, Dart
Feature not implemented at all: Dotnet, Rust, Swift, Java.

Experimental: CONTAINS filter operator

Usage: https://github.com/orgs/meilisearch/discussions/763

New operator when using filter

TODO:

• Nothing to do: filters is accept a string in all SDKs, so the feature is already available by default in all SDKs once the exp feature is activated 🎉