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.


Parameter Type Default Notes
queryResult Required GenericResult
query Required IQuery
requestOptions Required IRequestOptions

Available requestOptions

Property Type Notes


Property Type Notes
matched boolean

Whether the result matched the query

query IQuery

Copy of query; Useful when doing bulk calls

reasons IFilterExplanation[]

Array of explanations for each filter

result GenericResult

Copy of result; Useful when doing bulk calls

summary IMatchReason[]

Summary of all reasons for the result matching the query

Function defined in common/src/search/explainQueryResult.ts:113