elasticsearch-explain-response

Elasticsearch-explain-response

Parse Elasticsearch Explain Response and summarize it in a simple way. This gem is intended for developers working with Elasticsearch to debug search scores in a easier way. The current feature is very simple, but any suggestions or feature requests are welcomed.

Installation

Add this line to your application's Gemfile:

gem 'elasticsearch-explain-response'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elasticsearch-explain-response

Usage

Summarize the explanation in one line

require 'elasticsearch'
client = Elasticsearch::Client.new
result = client.explain index: "megacorp", type: "employee", id: "1", q: "last_name:Smith"
puts Elasticsearch::API::Response::ExplainResponse.new(result["explanation"]).render_in_line
#=>
1.0 = (1.0(termFreq=1.0)) x 1.0(idf(2/3)) x 1.0(fieldNorm)

Summarize the explanation in lines

require 'elasticsearch'
client = Elasticsearch::Client.new
result = client.explain index: "megacorp", type: "employee", id: "1", q: "last_name:Smith"
puts Elasticsearch::API::Response::ExplainResponse.new(result["explanation"]).render
#=>
1.0 = 1.0(fieldWeight)
  1.0 = 1.0(tf(1.0)) x 1.0(idf(2/3)) x 1.0(fieldNorm)
    1.0 = 1.0(termFreq=1.0)

Contributing

1. Fork it ( https://github.com/tomoya55/elasticsearch-explain-response/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request