Entities

Entities dictates exactly how data from an end-user expression is extracted.

STR Pro provides predefined default entities that can match many common types of data. For example, there are system entities for matching dates, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store.

Entity terminology #

The term entity is used in this documentation and in the STR Pro to describe the general concept of entities. When discussing entity details, it’s important to understand more specific terms:

  • Entity type: Defines the type of information you want to extract from user input. For example, vegetable could be the name of an entity type.
  • Entity entry: For each entity type, there are many entity entries. Each entity entry provides a set of words or phrases that are considered equivalent. For example, if vegetable is an entity type, you could define these three entity entries:
    • carrot
    • scallion, green onion
    • bell pepper, sweet pepper

There are two types of entities in STR pro addon.
1. Default Entities.
2. Custom Entities.


Default Entities #

Default entities are predefined entities comes with the STR pro addon. See the following default entities are below:

  • @name It will collect the name from the user response.
  • @age : It will collect the user age from the user response.
  • @number : It will collect any number from the user response.
  • @date : It will collect the date from the user response.
  • @date-of-birth : It will collect the date of birth from the user response.
  • @place : It will collect the place name from the user response. STR will use openstreetmap place api to identify the place.
  • @day : It will collect the day from the user response. Like Monday, Wednesday etc.
  • @email : It will collect the email address from the user response. Like [email protected] etc.
  • @color : It will collect the color name from the user response. Like red, green etc.

Custom Entities #

You can also able to create your own custom entities from Manage Entities page.