explainQueryResult
Explain why a specific result was included in a Query.
NOTE: This only works for entityType: "item" queries and does not cover all possible permutations.
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
| queryResult Required | GenericResult | ||
| query Required | IQuery | ||
| requestOptions Required | IRequestOptions |
Available requestOptions
| Property | Type | Notes |
|---|
Returns
| Property | Type | Notes |
|---|---|---|
| boolean |
Whether the result matched the query |
|
| IQuery |
Copy of query; Useful when doing bulk calls |
|
| IFilterExplanation[] |
Array of explanations for each filter |
|
| GenericResult |
Copy of result; Useful when doing bulk calls |
|
| IMatchReason[] |
Summary of all reasons for the result matching the query |
Function defined in common/src/search/explainQueryResult.ts:113