SearchResponse
SearchResponse
Value parameters
- abTestID
-
A/B test ID. This is only included in the response for indices that are part of an A/B test.
- abTestVariantID
-
Variant ID. This is only included in the response for indices that are part of an A/B test.
- aroundLatLng
-
Computed geographical location.
- automaticRadius
-
Automatically-computed radius.
- exhaustiveFacetsCount
-
See the
facetsCount
field of theexhaustive
object in the response. - exhaustiveNbHits
-
See the
nbHits
field of theexhaustive
object in the response. - exhaustiveTypo
-
See the
typo
field of theexhaustive
object in the response. - facets
-
Mapping of each facet name to the corresponding facet counts.
- facetsStats
-
Statistics for numerical facets.
- hitsPerPage
-
Number of hits per page.
- index
-
Index name used for the query.
- indexUsed
-
Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
- message
-
Warnings about the query.
- nbHits
-
Number of hits the search query matched.
- nbPages
-
Number of pages of results for the current query.
- nbSortedHits
-
Number of hits selected and sorted by the relevant sort algorithm.
- page
-
Page to retrieve (the first page is
0
, not1
). - params
-
URL-encoded string of all search parameters.
- parsedQuery
-
Post-normalization query string that will be searched.
- processingTimeMS
-
Time the server took to process the request, in milliseconds.
- processingTimingsMS
-
Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
- query
-
Text to search for in an index.
- queryAfterRemoval
-
Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
- serverTimeMS
-
Time the server took to process the request, in milliseconds.
- serverUsed
-
Host name of the server that processed the request.
- userData
-
Lets you store custom data in your indices.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SearchResultTraittrait SearchResultclass Objecttrait Matchableclass Any