BaseSearchResponse

algoliasearch.composition.BaseSearchResponse
case class BaseSearchResponse(abTestID: Option[Int], abTestVariantID: Option[Int], aroundLatLng: Option[String], automaticRadius: Option[String], exhaustive: Option[Exhaustive], appliedRules: Option[Seq[Any]], exhaustiveFacetsCount: Option[Boolean], exhaustiveNbHits: Option[Boolean], exhaustiveTypo: Option[Boolean], facets: Option[Map[String, Map[String, Int]]], facetsStats: Option[Map[String, FacetStats]], index: Option[String], indexUsed: Option[String], message: Option[String], nbSortedHits: Option[Int], parsedQuery: Option[String], processingTimeMS: Int, processingTimingsMS: Option[Any], queryAfterRemoval: Option[String], redirect: Option[Redirect], renderingContent: Option[RenderingContent], serverTimeMS: Option[Int], serverUsed: Option[String], userData: Option[Any], queryID: Option[String], automaticInsights: Option[Boolean], additionalProperties: Option[List[JField]])

BaseSearchResponse

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.

appliedRules

Rules applied to the query.

aroundLatLng

Computed geographical location.

automaticInsights

Whether automatic events collection is enabled for the application.

automaticRadius

Distance from a central coordinate provided by aroundLatLng.

exhaustiveFacetsCount

See the facetsCount field of the exhaustive object in the response.

exhaustiveNbHits

See the nbHits field of the exhaustive object in the response.

exhaustiveTypo

See the typo field of the exhaustive object in the response.

facets

Facet counts.

facetsStats

Statistics for numerical facets.

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.

nbSortedHits

Number of hits selected and sorted by the relevant sort algorithm.

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.

queryAfterRemoval

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

queryID

Unique identifier for the query. This is used for click analytics.

serverTimeMS

Time the server took to process the request, in milliseconds.

serverUsed

Host name of the server that processed the request.

userData

An object with custom data. You can store up to 32kB as custom data.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product