Merge #528

528: Add new search param showRankingScoreDetails r=curquiza a=Tommy-42

# Pull Request

## Related issue
Fixes #518

## What does this PR do?
- Add the search parameter `showRankingScoreDetails` introduced in [`Meilisearch v1.7.0`](https://github.com/meilisearch/meilisearch/releases/tag/v1.7.0) 

## 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: Tommy PAGEARD <tommy.pageard@gmail.com>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -440,6 +440,10 @@ search_parameter_guide_show_ranking_score_1: |-
   resp, err := client.Index("movies").Search("dragon", &meilisearch.SearchRequest{
     showRankingScore:    true,
   })
+search_parameter_guide_show_ranking_score_details_1: |-
+  resp, err := client.Index("movies").Search("dragon", &meilisearch.SearchRequest{
+    showRankingScoreDetails:    true,
+  })
 search_parameter_guide_matching_strategy_1: |-
   resp, err := client.Index("movies").Search("big fat liar", &meilisearch.SearchRequest{
     MatchingStrategy:    "last",

index_search.go

@@ -96,6 +96,9 @@ func searchPostRequestParams(query string, request *SearchRequest) map[string]in
 	if request.ShowRankingScore {
 		params["showRankingScore"] = request.ShowRankingScore
 	}
+	if request.ShowRankingScoreDetails {
+		params["showRankingScoreDetails"] = request.ShowRankingScoreDetails
+	}
 	if request.Filter != nil {
 		params["filter"] = request.Filter
 	}
@@ -141,11 +144,9 @@ func searchPostRequestParams(query string, request *SearchRequest) map[string]in
 	if len(request.Sort) != 0 {
 		params["sort"] = request.Sort
 	}
-
 	if request.Vector != nil && len(request.Vector) > 0 {
 		params["vector"] = request.Vector
 	}
-
 	if request.Hybrid != nil {
 		hybrid := make(map[string]interface{}, 2)
 		hybrid["embedder"] = request.Hybrid.Embedder

index_search_test.go

@@ -1599,6 +1599,32 @@ func TestIndex_SearchWithShowRankingScore(t *testing.T) {
 	require.NotNil(t, got.Hits[0].(map[string]interface{})["_rankingScore"])
 }
 
+func TestIndex_SearchWithShowRankingScoreDetails(t *testing.T) {
+	type args struct {
+		UID        string
+		PrimaryKey string
+		client     *Client
+		query      string
+		request    SearchRequest
+	}
+	testArg := args{
+		UID:    "indexUID",
+		client: defaultClient,
+		query:  "and",
+		request: SearchRequest{
+			ShowRankingScoreDetails: true,
+		},
+	}
+	SetUpIndexForFaceting()
+	c := testArg.client
+	i := c.Index(testArg.UID)
+	t.Cleanup(cleanup(c))
+
+	got, err := i.Search(testArg.query, &testArg.request)
+	require.NoError(t, err)
+	require.NotNil(t, got.Hits[0].(map[string]interface{})["_rankingScoreDetails"])
+}
+
 func TestIndex_SearchWithVectorStore(t *testing.T) {
 	type args struct {
 		UID        string

types.go

@@ -337,29 +337,30 @@ type CreateIndexRequest struct {
 //
 // Documentation: https://www.meilisearch.com/docs/reference/api/search#search-parameters
 type SearchRequest struct {
-	Offset                int64
-	Limit                 int64
-	AttributesToRetrieve  []string
-	AttributesToSearchOn  []string
-	AttributesToCrop      []string
-	CropLength            int64
-	CropMarker            string
-	AttributesToHighlight []string
-	HighlightPreTag       string
-	HighlightPostTag      string
-	MatchingStrategy      string
-	Filter                interface{}
-	ShowMatchesPosition   bool
-	ShowRankingScore      bool
-	Facets                []string
-	PlaceholderSearch     bool
-	Sort                  []string
-	Vector                []float32
-	HitsPerPage           int64
-	Page                  int64
-	IndexUID              string
-	Query                 string
-	Hybrid                *SearchRequestHybrid
+	Offset                  int64
+	Limit                   int64
+	AttributesToRetrieve    []string
+	AttributesToSearchOn    []string
+	AttributesToCrop        []string
+	CropLength              int64
+	CropMarker              string
+	AttributesToHighlight   []string
+	HighlightPreTag         string
+	HighlightPostTag        string
+	MatchingStrategy        string
+	Filter                  interface{}
+	ShowMatchesPosition     bool
+	ShowRankingScore        bool
+	ShowRankingScoreDetails bool
+	Facets                  []string
+	PlaceholderSearch       bool
+	Sort                    []string
+	Vector                  []float32
+	HitsPerPage             int64
+	Page                    int64
+	IndexUID                string
+	Query                   string
+	Hybrid                  *SearchRequestHybrid
 }
 
 type SearchRequestHybrid struct {