WARNING: Version 2.4 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› ›

Explain API

edit

Explain API

edit

The explain api computes a score explanation for a query and a specific document. This can give useful feedback whether a document matches or didn’t match a specific query.

The index and type parameters expect a single index and a single type respectively.

Usage

edit

Full query example:

curl -XGET 'localhost:9200/twitter/tweet/1/_explain' -d '{
      "query" : {
        "term" : { "message" : "search" }
      }
}'

This will yield the following result:

{
  "matches" : true,
  "explanation" : {
    "value" : 0.15342641,
    "description" : "fieldWeight(message:search in 0), product of:",
    "details" : [ {
      "value" : 1.0,
      "description" : "tf(termFreq(message:search)=1)"
    }, {
      "value" : 0.30685282,
      "description" : "idf(docFreq=1, maxDocs=1)"
    }, {
      "value" : 0.5,
      "description" : "fieldNorm(field=message, doc=0)"
    } ]
  }
}

There is also a simpler way of specifying the query via the q parameter. The specified q parameter value is then parsed as if the query_string query was used. Example usage of the q parameter in the explain api:

curl -XGET 'localhost:9200/twitter/tweet/1/_explain?q=message:search'

This will yield the same result as the previous request.

All parameters:

edit

`_source`	Set to `true` to retrieve the `_source` of the document explained. You can also retrieve part of the document by using `_source_include` & `_source_exclude` (see Get API for more details)
`fields`	Allows to control which stored fields to return as part of the document explained.
`routing`	Controls the routing in the case the routing was used during indexing.
`parent`	Same effect as setting the routing parameter.
`preference`	Controls on which shard the explain is executed.
`source`	Allows the data of the request to be put in the query string of the url.
`q`	The query string (maps to the query_string query).
`df`	The default field to use when no field prefix is defined within the query. Defaults to _all field.
`analyzer`	The analyzer name to be used when analyzing the query string. Defaults to the analyzer of the _all field.
`analyze_wildcard`	Should wildcard and prefix queries be analyzed or not. Defaults to false.
`lowercase_expanded_terms`	Should terms be automatically lowercased or not. Defaults to true.
`lenient`	If set to true will cause format based failures (like providing text to a numeric field) to be ignored. Defaults to false.
`default_operator`	The default operator to be used, can be AND or OR. Defaults to OR.

« Validate API Profile API »