Explanation of why a result matched a query


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

Interface defined in common/src/search/explainQueryResult.ts:10