From ccadb2a74423ad022d8bb1a4dd325c019521d69c Mon Sep 17 00:00:00 2001
From: Yi-Wei <86753236+ywei390@users.noreply.github.com>
Date: Wed, 20 Nov 2024 09:22:28 +0800
Subject: [PATCH 1/5] feat: Add help text to enricher configuration page (#28)

---
 Packages.props                                |  5 ++-
 docs/4.0.2-release-notes.md                   |  4 ++
 .../Constants.cs                              | 38 ++++++++++---------
 3 files changed, 28 insertions(+), 19 deletions(-)
 create mode 100644 docs/4.0.2-release-notes.md

diff --git a/Packages.props b/Packages.props
index 65c7243..cab9361 100644
--- 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.0.2-release-notes.md b/docs/4.0.2-release-notes.md
new file mode 100644
index 0000000..360bf9a
--- /dev/null
+++ b/docs/4.0.2-release-notes.md
@@ -0,0 +1,4 @@
+# Features
+- Display help text on the Enricher Configuration page
+
+# Fixes
\ No newline at end of file
diff --git a/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs b/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
index f8d6ca4..e3d3df7 100644
--- a/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
+++ b/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
@@ -23,35 +23,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 = "input",
+                    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 = "input",
+                    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 = "input",
+                    IsRequired = false,
+                    Name = KeyName.WebsiteKey,
+                    Help = "The vocabulary key that contains the websites of companies you want to enrich (e.g., organization.website)."
                 }
             }
         };

From 8dc2aa79dc6f7a58660572ee84e8251e360c735d Mon Sep 17 00:00:00 2001
From: Yi-Wei <86753236+ywei390@users.noreply.github.com>
Date: Mon, 25 Nov 2024 14:03:50 +0800
Subject: [PATCH 2/5] feat: Add guidance note to enricher configuration page
 (#29)

---
 .../Constants.cs                              | 38 ++++++++++++++++++-
 ...rnalSearch.Providers.KnowledgeGraph.csproj |  3 ++
 2 files changed, 40 insertions(+), 1 deletion(-)

diff --git a/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs b/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
index e3d3df7..64c5c78 100644
--- 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";
@@ -72,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
index 1e96d84..b2b40db 100644
--- 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>
\ No newline at end of file

From 884cfa95985a95597c8740914af2fce069a92cbf Mon Sep 17 00:00:00 2001
From: Yi-Wei <86753236+ywei390@users.noreply.github.com>
Date: Tue, 26 Nov 2024 14:02:30 +0800
Subject: [PATCH 3/5] feat: Update enricher configuration page controls to
 selector (#30)

---
 docs/4.0.2-release-notes.md                              | 1 +
 src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/4.0.2-release-notes.md b/docs/4.0.2-release-notes.md
index 360bf9a..41268b3 100644
--- a/docs/4.0.2-release-notes.md
+++ b/docs/4.0.2-release-notes.md
@@ -1,4 +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
\ No newline at end of file
diff --git a/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs b/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
index 64c5c78..0ea486f 100644
--- a/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
+++ b/src/ExternalSearch.Providers.KnowledgeGraph/Constants.cs
@@ -69,7 +69,7 @@ public struct KeyName
                 new Control()
                 {
                     DisplayName = "Accepted Entity Type",
-                    Type = "input",
+                    Type = "entityTypeSelector",
                     IsRequired = true,
                     Name = KeyName.AcceptedEntityType,
                     Help = "The entity type that defines the golden records you want to enrich (e.g., /Organization)."
@@ -77,7 +77,7 @@ public struct KeyName
                 new Control()
                 {
                     DisplayName = "Organization Name Vocabulary Key",
-                    Type = "input",
+                    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)."
@@ -85,7 +85,7 @@ public struct KeyName
                 new Control()
                 {
                     DisplayName = "Website Vocabulary Key",
-                    Type = "input",
+                    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)."

From a905582e741146d0252e170af129f9bf18f461bb Mon Sep 17 00:00:00 2001
From: Andrew Hardy <aha@cluedin.com>
Date: Mon, 9 Dec 2024 19:23:51 +1000
Subject: [PATCH 4/5] chore: Cut release 4.4.0

---
 docs/{4.0.2-release-notes.md => 4.4.0-release-notes.md} | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename docs/{4.0.2-release-notes.md => 4.4.0-release-notes.md} (100%)

diff --git a/docs/4.0.2-release-notes.md b/docs/4.4.0-release-notes.md
similarity index 100%
rename from docs/4.0.2-release-notes.md
rename to docs/4.4.0-release-notes.md

From b20a311a4f9773c6e64de23a58574968f734f953 Mon Sep 17 00:00:00 2001
From: Nick Barlow <nicholasbarlow1@gmail.com>
Date: Thu, 12 Dec 2024 16:13:26 +0000
Subject: [PATCH 5/5] chore: Update CluedIn version to 4.4.0 (#32)

---
 Packages.props | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Packages.props b/Packages.props
index cab9361..7f5c9bb 100644
--- a/Packages.props
+++ b/Packages.props
@@ -2,7 +2,7 @@
   <PropertyGroup Label="Dependency Versions">
     <_ComponentHost>3.2.0</_ComponentHost>
     <_AutoFixture>4.11.0</_AutoFixture>
-    <_CluedIn>4.4.0-*</_CluedIn>
+    <_CluedIn>4.4.0</_CluedIn>
   </PropertyGroup>
   <ItemGroup>
     <!--