elasticsearch-api/lib/elasticsearch/api/actions/explain.rb
# Returns information about why a specific matches (or doesn't match) a query.
#
# @option arguments [String] :id The document ID
# @option arguments [String] :index The name of the index
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
# @option arguments [String] :analyzer The analyzer for the query string query
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
# @option arguments [String] :df The default field for query string query (default: _all)
# @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
# @option arguments [String] :q Query in the Lucene query string syntax
# @option arguments [String] :routing Specific routing value
# @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
# @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The query definition using the Query DSL
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html
#
Returns information about why a specific matches (or doesn't match) a query.
Returns information about why a specific matches ( or doesn ' t match ) a query .
def explain(arguments = {})
        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
        headers = arguments.delete(:headers) || {}
        body = arguments.delete(:body)
        arguments = arguments.clone
        _id = arguments.delete(:id)
        _index = arguments.delete(:index)
        method = if body
                   Elasticsearch::API::HTTP_POST
                 else
                   Elasticsearch::API::HTTP_GET
                 end
        path   = "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
        params = Utils.process_params(arguments)
        perform_request(method, path, params, body, headers).body
      end
def explain ( arguments = { } ) raise ArgumentError , "Required argument 'index' missing" unless arguments [ :index ] raise ArgumentError , "Required argument 'id' missing" unless arguments [ :id ] headers = arguments . delete ( :headers ) || { } body = arguments . delete ( :body ) arguments = arguments . clone _id = arguments . delete ( :id ) _index = arguments . delete ( :index ) method = if body Elasticsearch :: API :: HTTP_POST else Elasticsearch :: API :: HTTP_GET end path = "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}" params = Utils . process_params ( arguments ) perform_request ( method , path , params , body , headers ) . body end
Returns information about why a specific matches (or doesn't match) a query.
Returns information about why a specific matches ( or doesn ' t match ) a query .
arguments
:body The query definition using the Query DSL
: body The query definition using the Query DSL
see
None