SearchMetaData
in
Interface for retrieving metadata such as error counts and metrics generated during search queries.
Table of Contents
- errorCount() : int|null
- Returns the number of errors messages reported by individual pindexes
- maxScore() : float|null
- Returns the highest score of all documents for this search query.
- metrics() : array<string|int, mixed>|null
- Returns the metrics generated during execution of this search query.
- successCount() : int|null
- Returns the number of pindexes successfully queried
- took() : int|null
- Returns the time taken to complete the query
- totalHits() : int|null
- Returns the total number of matches for this result
Methods
errorCount()
Returns the number of errors messages reported by individual pindexes
public
errorCount() : int|null
Return values
int|null —maxScore()
Returns the highest score of all documents for this search query.
public
maxScore() : float|null
Return values
float|null —metrics()
Returns the metrics generated during execution of this search query.
public
metrics() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —successCount()
Returns the number of pindexes successfully queried
public
successCount() : int|null
Return values
int|null —took()
Returns the time taken to complete the query
public
took() : int|null
Return values
int|null —totalHits()
Returns the total number of matches for this result
public
totalHits() : int|null