{"id":18097,"date":"2019-01-28T06:44:05","date_gmt":"2019-01-28T06:44:05","guid":{"rendered":"https:\/\/developer.kore.ai\/v7-3\/?post_type=docs&p=15965"},"modified":"2021-03-26T08:37:46","modified_gmt":"2021-03-26T08:37:46","slug":"working-with-composite-entities","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v7-3\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-composite-entities\/","title":{"rendered":"Working with Composite Entities"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Composite Entities<\/b> help you capture multiple entity values in a user utterance. These multiple entity values can be optional and can come in any order in the user utterance.<\/span>
\n<\/b>
\nExample: Car Sales Bot: <\/b>Consider the sales inquiries to car sales. Typical queries can be of the form: \u2018I am interested in <\/em><\/span>Tesla Model S <\/span><\/em>2018 model<\/em>\u2019 or \u2018What would a red Tesla 2010 model cost<\/em>\u2019 or \u2018Tell me about <\/em><\/span>Tesla Model S<\/span><\/em>\u2019. 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 can 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> have to be used<\/span> to establish the relationship between the sub-entities. Subentities are included in the composite entity using the @ tag, i.e.,@subentity<\/code> in the composite entity pattern. These sub-entities need to be pre-defined and should not be part of the current dialog flow. The sub-entities can come from other Dialog Tasks, too. <\/span><\/p>\n

Various patterns like AND, OR etc. can be 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 subentities can be referenced as properties of that object, i.e. to access a subentity value you can use:<\/span>
\n {{context.entities.<<composite_entity>>.<<sub_entity>> }}<\/code><\/span>
\nEach of the sub-entities can be accessed using the structure they were defined, as they will be 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\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

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

Building a composite entity involves the following steps – creating sub-entities and establishing a relationship between these sub-entities.<\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

\r\n\t\t
\r\n\t\t\t

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

Since the Composite entity is a combination of other entities, you first need to build the individual entities in the Dialog task. To capture the Car Type from the above example, you first need to create the sub-entities that can capture the required details. For example, here\u2019s 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 should 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 should 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 should not be used 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\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

\r\n\t\t
\r\n\t\t\t

Define 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 do so, open the Properties Panel, and under the Composite Patterns section, add relevant patterns. The various patterns that can be 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, following are the sample utterances and the output:<\/span><\/p>\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 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 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 and Patterns as with any other Entity.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Limitations<\/span><\/span><\/h3>\n
    \n
  • Sub-entity Types of String, Description, Location and Date cannot be part of a composite entity.<\/span><\/li>\n
  • Make sure that the sub-entities are not part of the Dialog flow in the task using the composite entity.<\/span><\/li>\n
  • If the sub-entity allows multi-items, the parent composite entity will accept only one value for the sub-entity and not a list.<\/span><\/li>\n<\/ul>\n
    How it works<\/span><\/span><\/h3>\n
    When a composite entity is reached in the dialog flow:<\/span><\/p>\n
      \n
    • all the possible subentities from the defined composite entity patterns are identified;<\/span><\/li>\n
    • all possible instances of those subentities are located in the user utterance and the location recorded;<\/span><\/li>\n
    • the composite entity patterns are then evaluated to identify the specific pattern that matches the set of subentity instances captured. <\/span><\/li>\n<\/ul>\n
      What that means is that the composite entity pattern is not used to identify the subentities but to match the entire pattern.<\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Composite Entities help you capture multiple entity values in a user utterance. These multiple entity values can be optional and can come in any order in the user utterance. Example: Car Sales Bot: Consider the sales inquiries to car sales. Typical queries can be of the form: \u2018I am interested in Tesla Model S 2018...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[29],"tags":[],"class_list":["post-18097","post","type-post","status-publish","format-standard","hentry","category-dialog-task"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18097","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/comments?post=18097"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18097\/revisions"}],"predecessor-version":[{"id":22860,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18097\/revisions\/22860"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/media?parent=18097"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/categories?post=18097"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/tags?post=18097"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}