viv.rating capsule provides a set of abstract concepts for storing user-generated ratings and reviews of other entities, such as businesses or movies.
This reference lists out several of the models available in this library capsule. Some sections contain tables listing information about those concepts or actions.
Types are always in the
viv.* namespace, and in the
viv.rating.* namespace unless another namespace is specified (e.g.,
viv.geo.*). All properties have a cardinality of
max (One) unless otherwise specified.
This is a typical quality rating, generally expressed as stars (e.g., "4 stars") or as a fraction (e.g., "8 out of 10").
MaxScoreis the score denominator, i.e., the highest possible score:
5.0for a 1–5 star rating;
10.0for a 10-point rating scale.
MinScoreis the lowest possible score. This will generally be
NormalizedScoreis a decimal fraction between
1.0. It will be computed for you based on
discretizedScorewill be calculated for you, and set to one of
FiveStars. This is intended to assist in preference learning.
The default sort ordering for
Rating is descending by
normalizedScore, then descending by
PriceRating model is used for entities that might have separate ratings for their prices, such as hotels or restaurants, that might be marked with 1–4 currency signs, e.g., "$$$$" for "very expensive." It has the same properties as
Rating, with the following exceptions:
discretizedScoreis of type
DiscreteDollars, and its enumerated symbols are
MinScoreshould be set to
MaxScoreshould be set to
normalizedScore(i.e., least expensive to mot expensive).
The capsule includes vocabulary for sorting (e.g., requesting "affordable" prices will sort from lowest to highest, while requesting "premium" prices will sort from highest to lowest).
|created||ReviewCreatedDate||structure||role-of time.DateTime (1)|
This model is used to rank items arbitrarily within a group.
The default sort ordering is ascending by
RatingCount is a named primitive concept, an integer representing the total number of ratings for an item. This is not used in other structure concepts in
Rating but can be used by your capsules.