[v1.3] Display hits ranking scores
brunoocasali opened this issue · 0 comments
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:
- issue: meilisearch/meilisearch#3771
- discussion: meilisearch/product#594
- spec: meilisearch/specifications#252
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
:
- Create a new entry with this key
search_parameter_guide_show_ranking_score_1
containing a call to thesearch
method using the new behavior from the indexmovies
usingshowRankingScore=true
and aq
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 calledshowRankingScore
. - Add the ability handle the new
_rankingScore
key/value in the search hits' response. - Update the code-samples accordingly
- Add integration tests