Merge branch 'release/4.4.0'

CluedIn-io · Dec 12, 2024 · 2b036ef · 2b036ef
2 parents 6097c17 + dcd79d7
commit 2b036ef
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 24 deletions.
diff --git a/Packages.props b/Packages.props
@@ -1,8 +1,8 @@
 <Project>
   <PropertyGroup Label="Dependency Versions">
-    <_ComponentHost>3.1.0</_ComponentHost>
+    <_ComponentHost>3.2.0</_ComponentHost>
     <_AutoFixture>4.11.0</_AutoFixture>
-    <_CluedIn>4.0.0</_CluedIn>
+    <_CluedIn>4.4.0</_CluedIn>
   </PropertyGroup>
   <ItemGroup>
     <!--

diff --git a/docs/4.4.0-release-notes.md b/docs/4.4.0-release-notes.md
@@ -0,0 +1,5 @@
+### Features
+- Display help text on the Enricher Configuration page
+- Enhanced the controls to support selecting accepted entity types and vocabulary keys from dropdown
+
+### Fix
diff --git a/src/ExternalSearch.Providers.libpostal/Constants.cs b/src/ExternalSearch.Providers.libpostal/Constants.cs
@@ -10,6 +10,31 @@ public static class Constants
         public const string ComponentName = "Libpostal";
         public const string ProviderName = "Libpostal";
         public static readonly Guid ProviderId = Guid.Parse("aba4e4cf-3c48-4828-9fdf-990b22e1a29c");
+        public const string Instruction = """
+            [
+              {
+                "type": "bulleted-list",
+                "children": [
+                  {
+                    "type": "list-item",
+                    "children": [
+                      {
+                        "text": "Add the entity type to specify the golden records you want to enrich. Only golden records belonging to that entity type will be enriched."
+                      }
+                    ]
+                  },
+                  {
+                    "type": "list-item",
+                    "children": [
+                      {
+                        "text": "Add the vocabulary keys to provide the input for the enricher to search for additional information. For example, if you provide the website vocabulary key for the Web enricher, it will use specific websites to look for information about companies. In some cases, vocabulary keys are not required. If you don't add them, the enricher will use default vocabulary keys."
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+            """;
         public struct KeyName
         {
             public const string AcceptedEntityType = "acceptedEntityType";
@@ -25,42 +50,47 @@ public struct KeyName
 
         public static AuthMethods AuthMethods { get; set; } = new AuthMethods
         {
-            token = new List<Control>()
+            Token = new List<Control>()
             {
                 new Control()
                 {
-                    displayName = "Accepted Entity Type",
-                    type = "input",
-                    isRequired = true,
-                    name = KeyName.AcceptedEntityType
+                    DisplayName = "Accepted Entity Type",
+                    Type = "entityTypeSelector",
+                    IsRequired = true,
+                    Name = KeyName.AcceptedEntityType,
+                    Help = "The entity type that defines the golden records you want to enrich (e.g., /Organization)."
                 },
                 new Control()
                 {
-                    displayName = "Person Address vocab key",
-                    type = "input",
-                    isRequired = false,
-                    name = KeyName.PersonAddress
+                    DisplayName = "Person Address Vocabulary Key",
+                    Type = "vocabularyKeySelector",
+                    IsRequired = false,
+                    Name = KeyName.PersonAddress,
+                    Help = "The vocabulary key that contains the addresses of persons you want to enrich (e.g., person.home.address.city)."
                 },
                 new Control()
                 {
-                    displayName = "Organization Address vocab key",
-                    type = "input",
-                    isRequired = false,
-                    name = KeyName.OrganizationAddress
+                    DisplayName = "Organization Address Vocabulary Key",
+                    Type = "vocabularyKeySelector",
+                    IsRequired = false,
+                    Name = KeyName.OrganizationAddress,
+                    Help = "The vocabulary key that contains the addresses of companies you want to enrich (e.g., organization.address)."
                 },
                 new Control()
                 {
-                    displayName = "User Address vocab key",
-                    type = "input",
-                    isRequired = false,
-                    name = KeyName.UserAddress
+                    DisplayName = "User Address Vocabulary Key",
+                    Type = "vocabularyKeySelector",
+                    IsRequired = false,
+                    Name = KeyName.UserAddress,
+                    Help = "The vocabulary key that contains the addresses of users you want to enrich (e.g., user.home.address)."
                 },
                 new Control()
                 {
-                    displayName = "Location Address vocab key",
-                    type = "input",
-                    isRequired = false,
-                    name = KeyName.LocationAddress
+                    DisplayName = "Location Address Vocabulary Key",
+                    Type = "vocabularyKeySelector",
+                    IsRequired = false,
+                    Name = KeyName.LocationAddress,
+                    Help = "The vocabulary key that contains the addresses of locations you want to enrich (e.g., location.fullAddress)."
                 },
             }
         };
@@ -77,7 +107,10 @@ public struct KeyName
             //}
         };
 
-        public static Guide Guide { get; set; } = null;
+        public static Guide Guide { get; set; } = new Guide
+        {
+            Instructions = Instruction
+        };
         public static IntegrationType IntegrationType { get; set; } = IntegrationType.Enrichment;
     }
 }
diff --git a/src/ExternalSearch.Providers.libpostal/ExternalSearch.Providers.libpostal.csproj b/src/ExternalSearch.Providers.libpostal/ExternalSearch.Providers.libpostal.csproj
@@ -9,4 +9,7 @@
     <PackageReference Include="CluedIn.Core" />
     <PackageReference Include="CluedIn.ExternalSearch" />
   </ItemGroup>
+  <PropertyGroup>
+    <LangVersion>preview</LangVersion>
+  </PropertyGroup>
 </Project>