Merge branch 'release/4.4.0'

CluedIn-io · Dec 12, 2024 · 7ac190b · 7ac190b
2 parents 2658bea + b20a311
commit 7ac190b
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 20 deletions.
diff --git a/Packages.props b/Packages.props
@@ -1,7 +1,8 @@
 <Project>
   <PropertyGroup Label="Dependency Versions">
+    <_ComponentHost>3.2.0</_ComponentHost>
     <_AutoFixture>4.11.0</_AutoFixture>
-    <_CluedIn>4.0.0</_CluedIn>
+    <_CluedIn>4.4.0</_CluedIn>
   </PropertyGroup>
   <ItemGroup>
     <!--
@@ -30,7 +31,7 @@
     <PackageReference Update="CluedIn.Core" Version="$(_CluedIn)" />
     <PackageReference Update="CluedIn.ExternalSearch" Version="$(_CluedIn)" />
     <PackageReference Update="CluedIn.Crawling.Acceptance" Version="$(_CluedIn)" />
-    <PackageReference Update="ComponentHost" Version="3.1.0" />
+    <PackageReference Update="ComponentHost" Version="$(_ComponentHost)" />
   </ItemGroup>
   <ItemGroup Label="Global tools">
     <!--

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
+
+# Fixes
diff --git a/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs b/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
@@ -10,6 +10,39 @@ public static class Constants
         public const string ComponentName = "KnowledgeGraph";
         public const string ProviderName = "Knowledge Graph";
         public static readonly Guid ProviderId = Core.Constants.ExternalSearchProviders.GoogleKnowledgeGraphId;
+        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."
+                      }
+                    ]
+                  },
+                  {
+                    "type": "list-item",
+                    "children": [
+                      {
+                        "text": "Add the API key to enable the enricher to retrieve information from a specific API. For example, the Vatlayer enricher requires an access key to authenticate with the Vatlayer API."
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+            """;
         public struct KeyName
         {
             public const string ApiKey = "apiKey";
@@ -23,35 +56,39 @@ public struct KeyName
 
         public static AuthMethods AuthMethods { get; set; } = new AuthMethods
         {
-            token = new List<Control>()
+            Token = new List<Control>()
             {
                 new Control()
                 {
-                    displayName = "Key",
-                    type = "input",
-                    isRequired = true,
-                    name = KeyName.ApiKey
+                    DisplayName = "Key",
+                    Type = "input",
+                    IsRequired = true,
+                    Name = KeyName.ApiKey,
+                    Help = "The key to authenticate access to the Google's Knowledge Graph API."
                 },
                 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 = "Organization Name vocab key",
-                    type = "input",
-                    isRequired = false,
-                    name = KeyName.OrganizationNameKey
+                    DisplayName = "Organization Name Vocabulary Key",
+                    Type = "vocabularyKeySelector",
+                    IsRequired = false,
+                    Name = KeyName.OrganizationNameKey,
+                    Help = "The vocabulary key that contains the names of companies you want to enrich (e.g., organization.name)."
                 },
                 new Control()
                 {
-                    displayName = "Website vocab key",
-                    type = "input",
-                    isRequired = false,
-                    name = KeyName.WebsiteKey
+                    DisplayName = "Website Vocabulary Key",
+                    Type = "vocabularyKeySelector",
+                    IsRequired = false,
+                    Name = KeyName.WebsiteKey,
+                    Help = "The vocabulary key that contains the websites of companies you want to enrich (e.g., organization.website)."
                 }
             }
         };
@@ -68,7 +105,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.KnowledgeGraph/ExternalSearch.Providers.KnowledgeGraph.csproj b/src/ExternalSearch.Providers.KnowledgeGraph/ExternalSearch.Providers.KnowledgeGraph.csproj
@@ -8,4 +8,7 @@
   <ItemGroup>
     <PackageReference Include="CluedIn.ExternalSearch" />
   </ItemGroup>
+  <PropertyGroup>
+    <LangVersion>preview</LangVersion>
+  </PropertyGroup>
 </Project>