Explain API · Elasticsearch 5.4 中文文檔

# Explain API 原文鏈接 :?[https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html) 譯文鏈接 :?[http://apache.wiki/display/Elasticsearch/Explain+API](http://apache.wiki/display/Elasticsearch/Explain+API) 貢獻者 : @琴劍藍天 **Explain API** 計算查詢和特定文檔的分數說明。這可以提供有用的反饋，無論文檔是否匹配特定查詢。? index 和 type 參數分別期望單個索引和單個類型。 ### 用法完整查詢示例： ``` GET /twitter/tweet/0/_explain { "query" : { "match" : { "message" : "elasticsearch" } } } ``` 這將產生以下結果： ``` { "_index" : "twitter", "_type" : "tweet", "_id" : "0", "matched" : true, "explanation" : { "value" : 1.55077, "description" : "sum of:", "details" : [ { "value" : 1.55077, "description" : "weight(message:elasticsearch in 0) [PerFieldSimilarity], result of:", "details" : [ { "value" : 1.55077, "description" : "score(doc=0,freq=1.0 = termFreq=1.0\n), product of:", "details" : [ { "value" : 1.3862944, "description" : "idf(docFreq=1, docCount=5)", "details" : [ ] }, { "value" : 1.1186441, "description" : "tfNorm, computed from:", "details" : [ { "value" : 1.0, "description" : "termFreq=1.0", "details" : [ ] }, { "value" : 1.2, "description" : "parameter k1", "details" : [ ] }, { "value" : 0.75, "description" : "parameter b", "details" : [ ] }, { "value" : 5.4, "description" : "avgFieldLength", "details" : [ ] }, { "value" : 4.0, "description" : "fieldLength", "details" : [ ] } ] } ] } ] }, { "value" : 0.0, "description" : "match on required clause, product of:", "details" : [ { "value" : 0.0, "description" : "# clause", "details" : [ ] }, { "value" : 1.0, "description" : "_type:tweet, product of:", "details" : [ { "value" : 1.0, "description" : "boost", "details" : [ ] }, { "value" : 1.0, "description" : "queryNorm", "details" : [ ] } ] } ] } ] } } ``` 還有一種更簡單的通過 q 參數指定查詢的方法。然后解析指定的 q 參數值，就像使用 query_string 查詢一樣。在api中的 q 參數的用法示例： ``` GET /twitter/tweet/0/_explain?q=message:search ``` 這將產生與先前請求相同的結果。 ### 所有的參數 | Name | Description | | --- | --- | | `_source` | 設置為true以檢索所解釋的文檔的_source。您還可以使用_source_include＆_source_exclude檢索文檔的一部分（有關更多詳細信息，請參閱Get API） | | `stored_fields` | 允許控制哪些存儲字段作為文檔說明的一部分返回。 | | `routing` | 在索引期間使用路由的情況下控制路由。 | | `parent` | 與設置 `routing` 參數的效果相同。 | | `preference` | 控制執行解釋的分片。 | | `source` | 允許請求的數據放在url的查詢字符串中。 | | `q` | 查詢字符串（映射到 query_string 查詢）。 | | `df` | 在查詢中未定義字段前綴時使用的默認字段。默認為_all字段。 | | `analyzer` | 分析查詢字符串時使用的分析器名稱。默認為_all字段的分析器。 | | `analyze_wildcard` | 是否分析通配符和前綴查詢。默認為false。 | | `lowercase_expanded_terms` | 術語是否自動小寫，默認為 **true** 。 | | `lenient` | 如果設置為 **true** 將導致基于格式的失敗（例如向數字字段提供文本）被忽略。默認為 **false**。 | | `default_operator` | 要使用的默認運算符，可以是 **AND** 或 **OR**。默認為 **OR**。 |