Support for composite entities with prebuilt children (#1117)

* Support for composite entities with prebuilt children

* Fixed test target

Co-authored-by: Emilio Munoz <[email protected]>

Author: axelsrz

packages/lu/src/parser/luis/luisGenBuilder.js

@@ -41,8 +41,8 @@ const buildVersion6 = function(luisApp) {
     try {
         result.intents = processIntents(luisApp.intents);
         result.closedLists = extractEntities(luisApp.closedLists);
-        [result.entities, result.composites] = extractEntitiesV6(luisApp.entities, result.closedLists);
         result.prebuiltEntities = extractEntities(luisApp.prebuiltEntities, true);
+        [result.entities, result.composites] = extractEntitiesV6(luisApp.entities, result.closedLists, result.prebuiltEntities);
         result.regex_entities = extractEntities(luisApp.regex_entities);
         result.patternAnyEntities = extractEntities(luisApp.patternAnyEntities);
     } catch (err) {
@@ -99,14 +99,16 @@ const extractEntities = function(entities, builtIn = false) {
     return result;
 }
 
-const extractEntitiesV6 = function(entities, closedLists) {
+const extractEntitiesV6 = function(entities, closedLists, prebuiltEntitiesList) {
     // This method provides a simplified topological sort to
     // solve potential instanceOf dependecies in the v6 entities
 
     const simpleEntitiesResult = [];
     const compositeEntitiesResult = [];
     const simpleEntitiesWithType = {};
 
+    const prebuiltEntitiesSet = new Set(prebuiltEntitiesList)
+
     // Add 'closedList' entities as valid types for instanceOf
     closedLists.forEach(listEntity => {
         simpleEntitiesWithType[listEntity] = 'list'
@@ -143,6 +145,14 @@ const extractEntitiesV6 = function(entities, closedLists) {
                 const last_type = simpleEntitiesWithType[entity.instanceOf] || entity.instanceOf;
                 simpleEntitiesWithType[entity.name] = last_type;
             }
+            // is simple with potential prebuilt
+            if (entity.features !== undefined && Array.isArray(entity.features) && entity.features.length >= 0) {
+                const prebuiltType = entity.features.find(element => element.isRequired && prebuiltEntitiesSet.has(element.modelName))
+                if (prebuiltType !== undefined) {
+                    // marking the entity type for processSimpleEntity check
+                    entity.instanceOf = prebuiltType
+                }
+            }
         } else {
             throw CLIError("Malformed JSON: entity.children should be an array");
         }

packages/luis/test/commands/luis/generate/cs.test.ts

@@ -174,4 +174,15 @@ describe('luis:generate:cs', () => {
     .it('Generates class based on V6 with entity instanceOf referencing a closedList', async () => {
       await compareSourceFiles('../../../fixtures/generate/V6AnyEntityAsInstanceOf.cs', '../../../fixtures/generate/results/V6AnyEntityAsInstanceOf.cs')
     })
+  
+  test
+    .stdout()
+    .command(['luis:generate:cs',
+      '--in',
+      `${path.join(__dirname, '../../../fixtures/generate/EntityPrebuiltType.json')}`,
+      '--out',
+      `${path.join(__dirname, '../../../fixtures/generate/results/EntityPrebuiltType.cs')}`])
+    .it('Generates class based on V6 with a composite entity with a prebuilt child', async () => {
+      await compareSourceFiles('../../../fixtures/generate/EntityPrebuiltType.cs', '../../../fixtures/generate/results/EntityPrebuiltType.cs')
+    })
 })

packages/luis/test/fixtures/generate/EntityPrebuiltType.cs

@@ -0,0 +1,107 @@
+// <auto-generated>
+// Code generated by luis:generate:cs
+// Tool github: https://github.com/microsoft/botframework-cli
+// Changes may cause incorrect behavior and will be lost if the code is
+// regenerated.
+// </auto-generated>
+using Newtonsoft.Json;
+using Newtonsoft.Json.Serialization;
+using System;
+using System.Collections.Generic;
+using Microsoft.Bot.Builder;
+using Microsoft.Bot.Builder.AI.Luis;
+namespace Luis
+{
+    public partial class : IRecognizerConvert
+    {
+        [JsonProperty("text")]
+        public string Text;
+
+        [JsonProperty("alteredText")]
+        public string AlteredText;
+
+        public enum Intent {
+        };
+        [JsonProperty("intents")]
+        public Dictionary<Intent, IntentScore> Intents;
+
+        public class _Entities
+        {
+            // Simple entities
+            public string[] MLTimeFrame;
+
+            // Built-in entities
+            public Money[] money;
+
+
+            // Composites
+            public class _InstanceHotel
+            {
+                public InstanceData[] HotelTimeFrame;
+                public InstanceData[] TotalAmount;
+            }
+            public class HotelClass
+            {
+                public string[] HotelTimeFrame;
+                public string[] TotalAmount;
+                [JsonProperty("$instance")]
+                public _InstanceHotel _instance;
+            }
+            public HotelClass[] Hotel;
+
+            // Instance
+            public class _Instance
+            {
+                public InstanceData[] Hotel;
+                public InstanceData[] HotelTimeFrame;
+                public InstanceData[] MLTimeFrame;
+                public InstanceData[] TotalAmount;
+                public InstanceData[] money;
+            }
+            [JsonProperty("$instance")]
+            public _Instance _instance;
+        }
+        [JsonProperty("entities")]
+        public _Entities Entities;
+
+        [JsonExtensionData(ReadData = true, WriteData = true)]
+        public IDictionary<string, object> Properties {get; set; }
+
+        public void Convert(dynamic result)
+        {
+            var app = JsonConvert.DeserializeObject<>(
+                JsonConvert.SerializeObject(
+                    result,
+                    new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore, Error = OnError }
+                )
+            );
+            Text = app.Text;
+            AlteredText = app.AlteredText;
+            Intents = app.Intents;
+            Entities = app.Entities;
+            Properties = app.Properties;
+        }
+
+        private static void OnError(object sender, ErrorEventArgs args)
+        {
+            // If needed, put your custom error logic here
+            Console.WriteLine(args.ErrorContext.Error.Message);
+            args.ErrorContext.Handled = true;
+        }
+
+        public (Intent intent, double score) TopIntent()
+        {
+            Intent maxIntent = Intent.None;
+            var max = 0.0;
+            foreach (var entry in Intents)
+            {
+                if (entry.Value.Score > max)
+                {
+                    maxIntent = entry.Key;
+                    max = entry.Value.Score.Value;
+                }
+            }
+            return (maxIntent, max);
+        }
+    }
+}

packages/luis/test/fixtures/generate/EntityPrebuiltType.json

@@ -0,0 +1,54 @@
+{
+    "intents": [],
+    "entities": [
+      {
+        "name": "MLTimeFrame",
+        "roles": []
+      },
+      {
+        "name": "Hotel",
+        "roles": [],
+        "children": [
+          {
+            "name": "HotelTimeFrame",
+            "children": [],
+            "features": [
+              {
+                "modelName": "MLTimeFrame",
+                "isRequired": false
+              }
+            ]
+          },
+          {
+            "name": "TotalAmount",
+            "children": [],
+            "features": [
+              {
+                "modelName": "money",
+                "isRequired": true
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "composites": [],
+    "closedLists": [],
+    "regex_entities": [],
+    "regex_features": [],
+    "utterances": [],
+    "patterns": [],
+    "patternAnyEntities": [],
+    "prebuiltEntities": [
+      {
+        "name": "money",
+        "roles": []
+      }
+    ],
+    "luis_schema_version": "7.0.0",
+    "versionId": "0.1",
+    "name": "",
+    "desc": "",
+    "culture": "en-us",
+    "phraselists": []
+  }