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