{"id":18097,"date":"2019-01-28T06:44:05","date_gmt":"2019-01-28T06:44:05","guid":{"rendered":"https:\/\/developer.kore.ai\/?post_type=docs&p=15965"},"modified":"2020-12-28T09:04:55","modified_gmt":"2020-12-28T09:04:55","slug":"working-with-composite-entities","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/v9-0\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-composite-entities\/","title":{"rendered":"Composite Entities"},"content":{"rendered":"

Composite Entities<\/b> help you capture multiple entity values in a user utterance. These multiple entity values are optional and come in any order in the user utterance.<\/span><\/p>\n

<\/b>Let us consider the below example.<\/p>\n

Car Sales Bot<\/b>: Consider the sales inquiries to car sales. Typical queries can be of the form: I am interested in the <\/em><\/span>Tesla Model S <\/span><\/em>2018 model<\/em> or What would a red Tesla 2010 model cost<\/em> or Tell me about <\/em><\/span>Tesla Model S<\/span><\/em>. As you can see, the bot typically needs to process a combination of details like Make, Model, Year and Color to respond to those queries. <\/span><\/p>\n

Each of these multiple values or details come from different independent entities. Composite Entities enable you to combine these independent entities or sub-entities. <\/span>
\n<\/b><\/p>\n

Composite Entity Patterns<\/b>:\u00a0These patterns help you to establish the relationship between the sub-entities. Sub-entities are included in the composite entity using the @ tag, i.e.,@subentity<\/code> in the composite entity pattern. These sub-entities must be pre-defined and should not be part of the current dialog flow. The sub-entities come from other Dialog Tasks too. <\/span><\/p>\n

Various patterns like AND, OR, etc,. are built similar to the ones used in defining Entity Patterns (<\/span>refer here for more<\/span><\/a>).<\/span><\/p>\n

The Composite Entity values take the form of a JSON object wherein the sub-entities are referenced as properties of that object, i.e. to access a sub-entity value, you can use:<\/span>
\n {{context.entities.<<composite_entity>>.<<sub_entity>> }}<\/code><\/span>
\nYou can access each of the sub-entities using the structure they are defined, as they are accessed when used independently of the composite entity. For example, if the sub-entity is of the type Airport, then one can access the airport name thus: {{context.entities.<<composite_entity>>.<<sub_entity>>.AirportName }}<\/code><\/p>\n<\/div><\/div>

<\/div><\/div>

<\/span>Create a Composite Entity<\/span><\/span><\/h2>\n

Building a composite entity involves the following steps:<\/span><\/p>\n

    \n
  1. Create sub-entities<\/span><\/li>\n
  2. Establish a relationship between these sub-entities.<\/span>
    \n<\/div><\/div>
    <\/li>\n<\/ol>\n

    <\/span>Create Sub-Entities<\/span><\/span><\/h3>\n

    Since the Composite Entity is a combination of other entities, you need to build individual entities in the dialog task. To capture the Car Type from the above example, you must create sub-entities that capture the required details. For example, here is a sample mapping of sub-entities for the car entity:<\/span><\/p>\n\n\n\n\n\n\n\n\n
    Related Entity<\/th>\nEntity Type<\/th>\n<\/tr>\n<\/thead>\n
    Make<\/td>\nList of Items: To capture the name of the car brand from the user utterance. As a developer, you must build this list in the entity.<\/td>\n<\/tr>\n
    Model<\/td>\nList of Values: To capture the name of the model from the user utterance. As a developer, you must build this list in the entity.<\/td>\n<\/tr>\n
    Year of Make<\/td>\nNumber: To capture the year of manufacturing from the user utterance. Bots recognize numbers automatically.<\/td>\n<\/tr>\n
    Color<\/td>\nColor: To captures the color from the user utterance. Bots recognize colors automatically.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Note<\/b>: Sub-entities can only be combined into a composite entity and are recommended not to use for any other purpose in the dialog task. If you are creating sub-entities in the current dialog task, remove all transitions to these sub-entities, so that they are not a part of the dialog task flow.<\/span><\/p>\n<\/div><\/div>

    <\/span>Define a Composite Entity<\/span><\/span><\/h3>\n

    Add a Composite Entity after a relevant node in the dialog task. To make this entity capture multiple entity values, you need to create Composite Patterns. To create, follow the below steps:<\/span><\/p>\n

      \n
    1. On the Entity window, click the NLP Properties<\/strong> tab.<\/span><\/li>\n
    2. On the NLP Properties<\/strong> tab, under the Composite Patterns for Entity<\/strong> section, add relevant patterns. The various patterns built are similar to the ones used in defining Entity Patterns (<\/span>refer here for more<\/span><\/a>).<\/span>
      \n\"\"
      \nFor the above composite entity patterns, the following are the sample utterances and the output:<\/span><\/li>\n<\/ol>\n\n\n\n\n\n\n\n
      Sample Utterance<\/th>\nCorresponding Pattern<\/th>\nOutput<\/th>\n<\/tr>\n<\/thead>\n
      I want to buy a 2018 Tesla Model S<\/td>\n@year @make @model<\/td>\n\n
      \"Car\": {\r\n\"Year\": 2018,\r\n\"Make\": \"Tesla\",\r\n\"Model\": \"Model S\"\r\n}<\/pre>\n<\/td>\n<\/tr>\n
      Can you send me a quote for the 2018 Tesla Model S preferably Red?<\/td>\n@year @make @model preferably @color<\/td>\n\n
      \"Car\": {\r\n\"Year\": 2018,\r\n\"Make\": \"Tesla\",\r\n\"Model\": \"Model S\"\r\n\u201cColor\u201d: \u201cRed\u201d\r\n}<\/pre>\n<\/td>\n<\/tr>\n
      How are the ratings for Tesla Model S?<\/td>\n@Make @Model<\/td>\n\n
      \"Car\": {\r\n\"Make\": \"Tesla\",\r\n\"Model\": \"Model S\"\r\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
      You can also define the Synonyms <\/em>and Patterns <\/em>as with any other entity.<\/p>\n<\/div><\/div>
      <\/span>Limitations<\/span><\/span><\/h3>\n