Skip to content

Missing tests for display hits ranking scores feature #827

Description

@brunoocasali

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomersmaintenanceAnything related to maintenance (CI, tests, refactoring...)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions