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

Missing tests for display hits ranking scores feature #827

Open
3 of 4 tasks
brunoocasali opened this issue Aug 8, 2023 · 3 comments
Open
3 of 4 tasks

Missing tests for display hits ranking scores feature #827

brunoocasali opened this issue Aug 8, 2023 · 3 comments
Labels
good first issue Good for newcomers maintenance Anything related to maintenance (CI, tests, refactoring...)

Comments

@brunoocasali
Copy link
Member

brunoocasali commented Aug 8, 2023

New implementation - Done ✅

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 - Done ✅

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
  }

Integration tests - TODO

Add integration tests in the test suite to test the "display hits ranking scores" feature, so the usage of the showRankingScore search parameter

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

Related to meilisearch/integration-guides#280

@brunoocasali brunoocasali added good first issue Good for newcomers enhancement New feature or request labels Aug 8, 2023
@sanders41
Copy link
Collaborator

sanders41 commented Aug 8, 2023

The search method accepts and returns a dictioinary meaning it can already handle showRankingScore and return the _rankingScore so we just need tests and code samples added for this.

@curquiza
Copy link
Member

Code sample has been added in this PR: #847

@curquiza curquiza changed the title [v1.3] Display hits ranking scores Missing tests for display hits ranking scores feature Sep 21, 2023
@curquiza
Copy link
Member

I updated the issue a little bit to make contributors understand there is only tests to do (and also to increase the readability in the issue list, because when I read the old title I thought a feature was missing for v1.3 which is not true😂)

@curquiza curquiza added maintenance Anything related to maintenance (CI, tests, refactoring...) and removed enhancement New feature or request labels Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers maintenance Anything related to maintenance (CI, tests, refactoring...)
Projects
None yet
Development

No branches or pull requests

3 participants