Changes related to Meilisearch v1.7.0

[curquiza]

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

📅 Release date: 2024-03-11

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.
• 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 👇)
  • JS: Update library for v1.7.0 meilisearch-js#1632
  • PHP: stabilize scoreDetails
  • Rust: stabilize scoreDetails
  • Ruby: stabilize scoreDetails
  • Dart: stabilize scoreDetails
  • Python: Hybrid search
  • Instant Meilisearch: use new meilisearch-js version
• Add code samples for the chosen up-to-date integrations with the new version of Meilisearch. v1.7: Code sample tracker documentation#2741
• Update the library version of the related integrations and prepare the changelogs
  • JS
  • PHP
  • Rust
  • Ruby -> NOT needed
  • Dart
  • Python
  • Instant Meilisearch

Release day

• Release the integrations
  • JS
  • PHP
  • Rust
  • Python
  • Instant Meilisearch
• 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)
  • For scoreDetails stabilization
  • For the new usage of OpenAI embedders
• Ensure the issues related to scoreDetails feature are up to date with this stabilization in different repositories (close them or update them)

What to implement?

Stabilize scoreDetails experimental feature

Issue: meilisearch/meilisearch#4359

showRankingScoreDetails parameter was previously present as experimental since v1.3.0. The boolean scoreDetails had to be activated as true in the /experimental-features route to make showRankingScoreDetails available.

It means this feature is already available in some integrations.

Here is the details

Not present in

• Dotnet
• Java
• Go (but showRankingScore is)
• Rust (but showRankingScore is, and some tests to activate scoreDetails are present)
• Swift (but showRankingScore is)

Already present in:

• Dart
• JS
• PHP
• Python
• Ruby

TODO

• JS: Update tests related to scoreDetails
• PHP: Update tests related to scoreDetails
• Rust: Update tests and code-samples related to scoreDetails + scoreDetails in the code base -> but showRankingScoreDetails is NOT present in the library
• Dart: remove scoreDetails mention in code base + update the commented test
• Ruby: remove mention of scoreDetails in README + update tests

The following integrations will not have the feature available for the release day: Dotnet, Java, Go, Rust and Swift

Improvement with OpenAI model for Hybrid search

Issue: meilisearch/meilisearch#4394

Hybrid search & embedders are already available in some integrations 👇

• JS
• PHP
• Python

But not in

• Dotnet
• Dart
• Go
• Java
• Ruby
• Rust
• Swift

dimensions field is now available in the openAi embedder settings

Example:

"embedders": {
  "large": {
    "source": "openAi",
    "model": "text-embedding-3-large",
    "dimensions": 512
  }
}

TODO

• JS: make dimensions field work for OpenAi models
• PHP -> already working
• Python: make dimensions field work for OpenAi models

The following integrations will not have the Hybrid search feature, so the OpenAI improvements, available for the release day: Dart, Dotnet, Java, Go, Ruby, Rust and Swift

New /logs experimental route

Related issue: meilisearch/meilisearch#4317

We will not implement anything in our SDKs because this new route is mostly an internal & debugging tool than a real usage in code base

[curquiza]

Closing this issue since all the issues of missing features have been opened, and old issues updated in the different repositories

well done everyone 🎉