SearchRequestSummary

data class SearchRequestSummary(    val numResults: Int,     val offset: Int,     val totalResults: Int,     val query: String = "",     val geoBias: GeoCoordinate? = null,     val queryTime: Duration? = null,     @IntRange(from = 1, to = 4) val fuzzyLevel: Int)

The summary of a Search API call.

Parameters

numResults

The number of results returned in this batch.

offset

The offset of the results in the collection of all results.

totalResults

The total number of results.

query

The query that resulted in this response.

geoBias

The position used to bias the results.

queryTime

The time it took to process this query.

fuzzyLevel

The fuzzy level in Fuzzy Search.

Constructors

Link copied to clipboard
fun SearchRequestSummary(    numResults: Int,     offset: Int,     totalResults: Int,     query: String = "",     geoBias: GeoCoordinate? = null,     queryTime: Duration? = null,     @IntRange(from = 1, to = 4) fuzzyLevel: Int)

Properties

Link copied to clipboard
val fuzzyLevel: Int
Link copied to clipboard
val geoBias: GeoCoordinate? = null
Link copied to clipboard
val numResults: Int
Link copied to clipboard
val offset: Int
Link copied to clipboard
val query: String
Link copied to clipboard
val queryTime: Duration? = null
Link copied to clipboard
val totalResults: Int