[v1.3] [EXPERIMENTAL] Display ranking details at search #501
Labels
Comments
brunoocasali
added
good first issue
3 tasks
meili-bors bot
added a commit
that referenced
this issue
Sep 12, 2023
509: Add total field to get-tasks route r=irevoire a=hmacr # Pull Request ## Related issue Fixes #504 ## What does this PR do? - Adds `total` field to `get-tasks` route ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! 516: Implement client for experimental-features API r=irevoire a=hmacr # Pull Request ## Related issue Needed for #498 & #501, since these issues involve updating the experimental-feature as a pre-requisite ## What does this PR do? - Introduces the experimental-features client in the SDK - Implements the `get` and `patch` endpoint. - Adds code-samples and tests. ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: hmacr <hmac.devo@gmail.com>
meili-bors bot
added a commit
that referenced
this issue
Sep 12, 2023
509: Add total field to get-tasks route r=curquiza a=hmacr # Pull Request ## Related issue Fixes #504 ## What does this PR do? - Adds `total` field to `get-tasks` route ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! 516: Implement client for experimental-features API r=curquiza a=hmacr # Pull Request ## Related issue Needed for #498 & #501, since these issues involve updating the experimental-feature as a pre-requisite ## What does this PR do? - Introduces the experimental-features client in the SDK - Implements the `get` and `patch` endpoint. - Adds code-samples and tests. ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: hmacr <hmac.devo@gmail.com> Co-authored-by: Clémentine U. - curqui <clementine@meilisearch.com>
meili-bors bot
added a commit
that referenced
this issue
Sep 12, 2023
516: Implement client for experimental-features API r=curquiza a=hmacr # Pull Request ## Related issue Needed for #498 & #501, since these issues involve updating the experimental-feature as a pre-requisite ## What does this PR do? - Introduces the experimental-features client in the SDK - Implements the `get` and `patch` endpoint. - Adds code-samples and tests. ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: hmacr <hmac.devo@gmail.com> Co-authored-by: Clémentine U. - curqui <clementine@meilisearch.com>
|
Replaced by #556 because the feature has been stabilized in Meilisearch v1.7.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Also, if you are a maintainer, please add any clarification and instructions about this issue.
Sorry if this is already wholly/partially implemented. Feel free to let me know about the state of this issue in the repo.
Related to meilisearch/integration-guides#280
This issue is divided into two sections, first, you need to make the implementation, and second, you must update the code-samples (no one likes outdated docs, right?).
New implementation
Related to:
This feature aims to return ranking details for each document to understand and tweak the score of the documents more easily.
Ensure the SDKs can handle the new search parameter
showRankingScoreDetails. Also ensure the SDK can handle the_rankingScoreDetailsattributes in the matchedhits.PATCH /experimental-featureswith{ "scoreDetails": true }Extra: Add inline documentation for the method, explaining the availability of this feature only for Meilisearch v1.3 and newer. And that is also an experimental feature that must be manually opt-in using the
/experimental-featuresmeilisearch/meilisearch#3857 endpoint.TODO:
searchmethod calledshowRankingScoreDetails._rankingScoreDetailskey/value in the search hits' response.The text was updated successfully, but these errors were encountered: