RankingInfo

algoliasearch.search.RankingInfo
case class RankingInfo(filters: Option[Int], firstMatchedWord: Int, geoDistance: Int, geoPrecision: Option[Int], matchedGeoLocation: Option[MatchedGeoLocation], personalization: Option[Personalization], nbExactWords: Int, nbTypos: Int, promoted: Option[Boolean], proximityDistance: Option[Int], userScore: Int, words: Option[Int], promotedByReRanking: Option[Boolean])

Object with detailed information about the record's ranking.

Value parameters

filters

Whether a filter matched the query.

firstMatchedWord

Position of the first matched word in the best matching attribute of the record.

geoDistance

Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).

geoPrecision

Precision used when computing the geo distance, in meters.

nbExactWords

Number of exactly matched words.

nbTypos

Number of typos encountered when matching the record.

promoted

Whether the record was promoted by a rule.

promotedByReRanking

Whether the record is re-ranked.

proximityDistance

Number of words between multiple matches in the query plus 1. For single word queries, proximityDistance is 0.

userScore

Overall ranking of the record, expressed as a single integer. This attribute is internal.

words

Number of matched words.

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