Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v1.3] Display hits ranking scores #500

Closed
4 tasks
brunoocasali opened this issue Aug 8, 2023 · 0 comments · Fixed by #515
Closed
4 tasks

[v1.3] Display hits ranking scores #500

brunoocasali opened this issue Aug 8, 2023 · 0 comments · Fixed by #515
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@brunoocasali
Copy link
Member

brunoocasali commented Aug 8, 2023

⚠️ This issue is generated, it means the examples and the namings do not necessarily correspond to the language of this repository.
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 efficiently.

Ensure the SDKs can handle the new search parameter showRankingScore. Also, ensure the SDK can handle the _rankingScore attribute in the matched hits.

Code samples

Inside of this file: .code-samples.meilisearch.yml:

  1. Create a new entry with this key search_parameter_guide_show_ranking_score_1 containing a call to the search method using the new behavior from the index movies using showRankingScore=true and a q with 'dragon'.
    Add a new code sample to the .code-samples.meilisearch.yml file:

Use this as a reference if the previous description was not helpful:

search_parameter_guide_show_ranking_score_1: |-
  POST 'http://localhost:7700/indexes/movies/search' 
  with data: { 
    "q": "dragon", "showRankingScore": true
  }

TODO:

  • Add the ability receive a new param in the search method called showRankingScore.
  • Add the ability handle the new _rankingScore key/value in the search hits' response.
  • Update the code-samples accordingly
  • Add integration tests
@brunoocasali brunoocasali added good first issue Good for newcomers enhancement New feature or request labels Aug 8, 2023
@meili-bors meili-bors bot closed this as completed in da5f05d Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant