meilisearch / meilisearch-js

JavaScript client for the Meilisearch API

Home Page:https://www.meilisearch.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update library for v1.7.0

curquiza opened this issue · comments

Based on meilisearch/integration-guides#296

Make your changes on bump-meilisearch-v1.7.0 branch, cf the associated PR: #1631

TODO

Stabilization of scoreDetails

  • Understand why this test does NOT fail when running with v1.7.0-rc.X (cf CI). It should fail when trying to enable the exp feature because the feature is not activable as experimental anymore -> let us know in this issue about the investigation
  • Remove all mention/usage of scoreDetails exp feature in code base, tests and README (if there is): this feature is not experimental anymore and can be used directly through the showRankingScoreDetails search parameter without activating anything
  • Ensure we have test for the showRankingScoreDetails parameter during the /search

Hybrid search

Release a beta of the version

  • Once all steps before are done, by following the CONTRIBUTING.md steps, release a beta version of v0.38.0 of meilisearch-js. Inform your team once it's done, because they need it to implement the Search AI demo.

Understand why this test does NOT fail when running with v1.7.0-rc.X (cf CI). It should fail when trying to enable the exp feature because the feature is not activable as experimental anymore -> let us know in this issue about the investigation

We expected this test with version 1.7.0-rc.1 to fail when attempting to enable the experimental feature. The investigation revealed that sending a PATCH request to /experimental-features with { scoreDetails: true } correctly results in a 400 Bad Request error during the tests, which aligns with our expectations. However, the test's structure doesn't lead to a failure when encountering this error, allowing the test to proceed. The test ultimately passes because the feature in question has been enabled by default.

I've seen in the engine issue about dimensions for the openAi model that there are some limitations, such as:

"dimensions": 512 // must be >0, must be <= 3072 for "text-embedding-3-large"
"dimensions": 1024 // must be >0, must be <= 1536 for "text-embedding-3-small"
"dimensions": 1536 // must =1536  for "text-embedding-ada-002"

I'm assuming here meilisearch-js does not need to handle that and just needs to be able to send a dimensions field when doing a request to meilisearch. meilisearch will handle the error.

Looking to release a beta version using this PR

I created a release v0.38.0-v1.7.0-pre-release.0 by following the beta release process. It's based on this branch.

It's available in npm.

I'm assuming here meilisearch-js does not need to handle that and just needs to be able to send a dimensions field when doing a request to meilisearch. meilisearch will handle the error.

Good guess! Nothing to handle on the library side, should be handled by the engine

Thank you Nico for your work!