Uh oh! We couldn’t find any match.

Please try other search keywords.

Bixby Developer Center

Guides

Business (viv.business)

Many Bixby capsules need to model businesses of some kind, such as hotels or restaurants. The viv.business capsule provides a set of base models for businesses, including metadata for locations, categories, photos, and more. This capsule includes extensive vocabulary for kinds of businesses and amenities, but includes no training. Your capsule can extend viv.business and provide training for your specific use cases.

Models

Types are always in the viv.\* namespace, and in the viv.business.\* namespace unless another namespace is specified (e.g., viv.rating.\*). All properties have a cardinality of min (Optional), max (One) unless otherwise specified.

Business

The primary concept in this library capsule is viv.business.Business, a structure concept with the following properties.

PropertyTypeKindNotes
addressgeo.Addressstructure(1)
businessAmenityBusinessAmenityenumMany
businessUrlWebPagetextextends entity.EntityUrl
businessCategoryBusinessCategorynameMany
mapUrlMapUrltextextends entity.EntityUrl
nameBusinessNamenameextends geo.PlaceName
descriptionBusinessDescriptiontext
phonephone.PhoneNumbertextMany
thumbnailBusinessThumbnailstructurerole-of entity.PhotoInfo
photosBusinessPhotosstructurerole-of entity.ImageSet
ratingrating.Ratingstructure(2)
ratingCountrating.RatingCountstructure
priceRatingrating.priceRatingstructure
reviewrating.reviewstructure
reviewCountrating.reviewCountinteger
rankrating.rankinteger
hoursInformationopenHours.HoursInformationstructure(3)
  1. See viv.geo for details.
  2. See viv.rating for details.
  3. See viv.openHours for details.

BusinessThumbnail

This concept provides metadata for thumbnail images. See viv.image for more details.

PropertyTypeKindNotes
urlimage.UrltextRequired
sizeimage.Sizeinteger
dimensionsimage.Dimensionsstructure(1)
rotationmeasurement.AngleValuedecimal
captionimage.Captiontext 
  1. The dimensions structure contains two integer properties, height and width, indicating the image's size in pixels.

BusinessPhotos

The entity.ImageSet concept is used in image carousels and image galleries. The images property contains one or more image concepts with the same properties as BusinessThumbnail.

PropertyTypeKindNotes
imagesentity.PhotoInfostructureRequired, Many
titleTexttext
subtitleTexttext