如何使用 Elasticsearch 的 Explain API？

推荐答案

GET /<index>/_explain/<document_id>
{
  "query": {
    "match": {
      "<field>": "<value>"
    }
  }
}

• <index>: 替换为你要查询的索引名称。
• <document_id>: 替换为你要解释的文档ID。
• <field>: 替换为你要查询的字段名称。
• <value>: 替换为你要匹配的字段值。

本题详细解读

1. Explain API 的作用

Elasticsearch 的 Explain API 用于解释为什么某个文档匹配或不匹配某个查询。它返回详细的评分信息，帮助你理解 Elasticsearch 如何计算文档的相关性分数。

2. 请求参数

• index: 指定要查询的索引名称。
• document_id: 指定要解释的文档ID。
• query: 指定查询条件，通常是一个查询DSL。

3. 响应内容

Explain API 的响应包含以下关键信息：

• _index: 文档所在的索引。
• _type: 文档的类型（在 Elasticsearch 7.x 及更高版本中通常为 _doc）。
• _id: 文档的ID。
• matched: 文档是否匹配查询。
• explanation: 详细的评分解释，包括每个评分步骤的详细信息。

4. 示例

假设我们有一个索引 my_index，其中包含一个文档 1，字段 title 的值为 Elasticsearch。我们可以使用以下请求来解释为什么这个文档匹配查询 match：

GET /my_index/_explain/1
{
  "query": {
    "match": {
      "title": "Elasticsearch"
    }
  }
}

5. 响应示例

// www.javascriptcn.com code example
{
  "_index": "my_index",
  "_type": "_doc",
  "_id": "1",
  "matched": true,
  "explanation": {
    "value": 1.0,
    "description": "weight(title:elasticsearch in 0) [PerFieldSimilarity], result of:",
    "details": [
      {
        "value": 1.0,
        "description": "score(freq=1.0), computed as boost * idf * tf from:",
        "details": [
          {
            "value": 2.2,
            "description": "boost",
            "details": []
          },
          {
            "value": 1.3862944,
            "description": "idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:",
            "details": [
              {
                "value": 1,
                "description": "n, number of documents containing term",
                "details": []
              },
              {
                "value": 1,
                "description": "N, total number of documents with field",
                "details": []
              }
            ]
          },
          {
            "value": 0.30685282,
            "description": "tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:",
            "details": [
              {
                "value": 1.0,
                "description": "freq, occurrences of term within document",
                "details": []
              },
              {
                "value": 1.2,
                "description": "k1, term saturation parameter",
                "details": []
              },
              {
                "value": 0.75,
                "description": "b, length normalization parameter",
                "details": []
              },
              {
                "value": 1.0,
                "description": "dl, length of field",
                "details": []
              },
              {
                "value": 1.0,
                "description": "avgdl, average length of field",
                "details": []
              }
            ]
          }
        ]
      }
    ]
  }
}

6. 使用场景

• 调试查询: 当你发现某个文档没有按预期匹配查询时，可以使用 Explain API 来查看详细的评分过程。
• 优化查询: 通过分析评分细节，你可以调整查询参数或索引设置，以提高查询性能或相关性。

7. 注意事项

• Explain API 只能用于单个文档和单个查询的解释。
• 对于复杂的查询，解释信息可能会非常详细，需要仔细分析。