Merge #965

965: Add tests and docs about showRankingScoreDetails r=sanders41 a=the-sinner

# Pull Request

## Related issue
Fixes #939 

## What does this PR do?
- Add tests and docs about showRankingScoreDetails

## 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: Shalabh Agarwal <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -360,6 +360,10 @@ search_parameter_guide_show_ranking_score_1: |-
   client.index('movies').search('dragon', {
     'showRankingScore': true
   })
+search_parameter_guide_show_ranking_score_details_1: |-
+  client.index('movies').search('dragon', {
+    'showRankingScoreDetails': True
+  })
 search_parameter_guide_attributes_to_search_on_1: |-
   client.index('movies').search('adventure', {
     'attributesToSearchOn': ['overview']

tests/index/test_index_search_meilisearch.py

@@ -459,6 +459,20 @@ def test_attributes_to_search_on_search_no_match(index_with_documents):
     assert response["hits"] == []
 
 
+def test_show_ranking_score_details(index_with_documents):
+    """Tests search with show ranking score details"""
+    response = index_with_documents().search(
+        "man loves",
+        {"showRankingScoreDetails": True},
+    )
+
+    assert isinstance(response, dict)
+    assert len(response["hits"]) > 1
+    assert response["hits"][0]["_rankingScoreDetails"] is not None
+    assert response["hits"][0]["_rankingScoreDetails"]["words"] is not None
+    assert response["hits"][0]["_rankingScoreDetails"]["words"]["score"] == 1
+
+
 @pytest.mark.usefixtures("enable_vector_search")
 def test_vector_search(index_with_documents_and_vectors):
     response = index_with_documents_and_vectors().search(