ExplainDetail

One score step in the explanation tree.

Example

{
  "matched": true,
  "score": 8.42,
  "description": "weight(name:spring) [BM25], result of:",
  "clause": "query[0]",
  "clauseType": "text",
  "field": "name",
  "usage": "matching"
}

Properties

matchedboolean

Whether this step was satisfied. A non-matching step contributes nothing to the parent score, and its children describe the reason.

scorenumber

Score contributed by this step to its parent step. Returns 0 if the step did not match.

Format

float

descriptionstring

Human-readable explanation of the step.

Example

"weight(title:bok) [BM25], result of:"

clausestring

Path to the clause in the request body that produced this step. Omitted when the step is not an individual clause.

Example

"query[0].clauses[2]"

clauseTypestring

Clause type matching request syntax in type. Omitted when clause is omitted.

Example

"text"

fieldstring

Index definition field name evaluated by the step. Omitted when the step reads no fields or multiple fields.

Example

"title"

usagestring

Field usage mode evaluated by the step (such as matching or filter). Omitted when field is omitted.

Example

"matching"

localestring

BCP 47 tag of the variant this step reads. Omitted for a field that holds one variant for every language.

Example

"sv"

childrenExplainDetail[]

Child score steps that compose this step. Empty for leaf steps.

Example

{
  "matched": true,
  "score": 8.42,
  "description": "weight(name:spring) [BM25], result of:",
  "clause": "query[0]",
  "clauseType": "text",
  "field": "name",
  "usage": "matching"
}

Endpoints

Endpoints where the request or responses uses this type.

• POSTExplain how one hit scores/v1alpha1/indexes/{name}/search/actions/explain