# Explain API # Explain API（執行計劃API） 執行計劃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": "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, computed as log(1 + (docCount - docFreq + 0.5) / (docFreq + 0.5)) from:", "details": [ { "value": 1.0, "description": "docFreq", "details": [] }, { "value": 5.0, "description": "docCount", "details": [] } ] }, { "value": 1.1186441, "description": "tfNorm, computed as (freq * (k1 + 1)) / (freq + k1 * (1 - b + b * fieldLength / avgFieldLength)) 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": [] } ] } ] } ] } } ``` 還有一種通過`q`參數指定查詢的更簡單的方法。然后解析指定的`q`參數值，就像使用`query_string`查詢一樣。在 explain api 中使用q參數的示例： ``` GET /twitter/tweet/0/_explain?q=message:search ``` 這將產生與先前請求相同的結果。 所有參數： 參數名描述`_source`設置為`true`以提取文檔的`_source`。您還可以使用`_source_include`＆ `_source_exclude`檢索文檔的一部分（有關詳細信息，請參閱[Get API](../Document_APIs/Get_API.md)）`stored_fields`允許控制哪些存儲字段作為文檔的一部分返回。`routing`在創建索引期間使用路由的情況下控制路由。`parent`與設置路由參數相同的效果。`preference`控制執行解釋的分片。`source`允許請求的數據放在url的查詢字符串中。`q`查詢字符串（映射到`query_string`查詢）。`df`在查詢中未定義字段前綴時使用的默認字段。默認為`_all`字段。`analyzer`分析查詢字符串時使用的分析器名稱。默認為`_all`字段的分析器。`analyze_wildcard`應該分析通配符和前綴查詢。默認為`false`。`lenient`如果設置為`true`，將會導致基于格式的失敗（例如提供一個文本到數字字段）被忽略。默認為`false`。`default_operator`要使用的默認運算符可以是`AND`或`OR`。默認為`OR`。