RankingInfo

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

RankingInfo

Value parameters

filters

This field is reserved for advanced usage.

firstMatchedWord

Position of the most important matched attribute in the attributes to index list.

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

Present and set to true if a Rule promoted the hit.

promotedByReRanking

Wether the record are promoted by the re-ranking strategy.

proximityDistance

When the query contains more than one word, the sum of the distances between matched words (in meters).

userScore

Custom ranking for the object, expressed as a single integer value.

words

Number of matched words, including prefixes and typos.

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