SearchMetaData
interface SearchMetaData (View source)
Interface for retrieving metadata such as error counts and metrics generated during search queries.
Methods
Returns the number of pindexes successfully queried
Returns the number of errors messages reported by individual pindexes
Returns the time taken to complete the query
Returns the total number of matches for this result
Returns the highest score of all documents for this search query.
Returns the metrics generated during execution of this search query.
Details
int|null
successCount()
Returns the number of pindexes successfully queried
int|null
errorCount()
Returns the number of errors messages reported by individual pindexes
int|null
took()
Returns the time taken to complete the query
int|null
totalHits()
Returns the total number of matches for this result
float|null
maxScore()
Returns the highest score of all documents for this search query.
array|null
metrics()
Returns the metrics generated during execution of this search query.