Added display hits ranking scores

.code-samples.meilisearch.yaml

@@ -335,6 +335,10 @@ search_parameter_guide_matching_strategy_2: |-
   client.index('movies').search('big fat liar', {
     matching_strategy: 'all'
   })
+search_parameter_guide_show_ranking_score_1: |-
+  client.index('movies').search('winter feast', {
+    show_ranking_score: true
+  })
 add_movies_json_1: |-
   require 'json'
 

lib/meilisearch/index.rb

@@ -220,6 +220,8 @@ def delete_all_documents!
 
     ### SEARCH
 
+    # options: A Hash
+    #   showRankingScore - To see the ranking scores for returned documents
     def search(query, options = {})
       parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
 

spec/meilisearch/index/search/show_ranking_score_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe 'MeiliSearch::Index - Search with ranking score' do
+  include_context 'search books with genre'
+
+  it 'shows the ranking score when showRankingScore is true' do
+    response = index.search('hobbit', { showRankingScore: true })
+    expect(response['hits'][0]).to have_key('_rankingScore')
+  end
+
+  it 'hides the ranking score when showRankingScore is false' do
+    response = index.search('hobbit', { showRankingScore: false })
+    expect(response['hits'][0]).not_to have_key('_rankingScore')
+  end
+
+  it 'hides the ranking score when showRankingScore is not set' do
+    response = index.search('hobbit')
+    expect(response['hits'][0]).not_to have_key('_rankingScore')
+  end
+end