Package com.algolia.model.search

Class RankingInfo

java.lang.Object
com.algolia.model.search.RankingInfo
public class RankingInfo extends Object
Object with detailed information about the record's ranking.

  • Constructor Details

    • RankingInfo

      public RankingInfo()

  • Method Details

    • setFilters

      public RankingInfo setFilters(Integer filters)

    • getFilters

      @Nullable public Integer getFilters()
      Whether a filter matched the query. minimum: 0

    • setFirstMatchedWord

      public RankingInfo setFirstMatchedWord(Integer firstMatchedWord)

    • getFirstMatchedWord

      @Nonnull public Integer getFirstMatchedWord()
      Position of the first matched word in the best matching attribute of the record. minimum: 0

    • setGeoDistance

      public RankingInfo setGeoDistance(Integer geoDistance)

    • getGeoDistance

      @Nonnull public Integer getGeoDistance()
      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). minimum: 0

    • setGeoPrecision

      public RankingInfo setGeoPrecision(Integer geoPrecision)

    • getGeoPrecision

      @Nullable public Integer getGeoPrecision()
      Precision used when computing the geo distance, in meters. minimum: 1

    • setMatchedGeoLocation

      public RankingInfo setMatchedGeoLocation(MatchedGeoLocation matchedGeoLocation)

    • getMatchedGeoLocation

      @Nullable public MatchedGeoLocation getMatchedGeoLocation()
      Get matchedGeoLocation

    • setPersonalization

      public RankingInfo setPersonalization(Personalization personalization)

    • getPersonalization

      @Nullable public Personalization getPersonalization()
      Get personalization

    • setNbExactWords

      public RankingInfo setNbExactWords(Integer nbExactWords)

    • getNbExactWords

      @Nonnull public Integer getNbExactWords()
      Number of exactly matched words. minimum: 0

    • setNbTypos

      public RankingInfo setNbTypos(Integer nbTypos)

    • getNbTypos

      @Nonnull public Integer getNbTypos()
      Number of typos encountered when matching the record. minimum: 0

    • setPromoted

      public RankingInfo setPromoted(Boolean promoted)

    • getPromoted

      @Nullable public Boolean getPromoted()
      Whether the record was promoted by a rule.

    • setProximityDistance

      public RankingInfo setProximityDistance(Integer proximityDistance)

    • getProximityDistance

      @Nullable public Integer getProximityDistance()
      Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0. minimum: 0

    • setUserScore

      public RankingInfo setUserScore(Integer userScore)

    • getUserScore

      @Nonnull public Integer getUserScore()
      Overall ranking of the record, expressed as a single integer. This attribute is internal.

    • setWords

      public RankingInfo setWords(Integer words)

    • getWords

      @Nullable public Integer getWords()
      Number of matched words. minimum: 1

    • setPromotedByReRanking

      public RankingInfo setPromotedByReRanking(Boolean promotedByReRanking)

    • getPromotedByReRanking

      @Nullable public Boolean getPromotedByReRanking()
      Whether the record is re-ranked.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object