Revisit error messages for readability (#430)

Use new error helpers to provide better error messages and reduce code,
compatibly with .NET Standard 2.0.
Change exceptions and messages used during validation.
Upgrade packages

Author: dluc

Directory.Packages.props

@@ -42,15 +42,15 @@
   </ItemGroup>
   <!-- Kernel Memory -->
   <ItemGroup>
-    <PackageVersion Include="Microsoft.KernelMemory.Abstractions" Version="0.36.240416.1" />
-    <PackageVersion Include="Microsoft.KernelMemory.Core" Version="0.36.240416.1" />
+    <PackageVersion Include="Microsoft.KernelMemory.Abstractions" Version="0.37.240423.2" />
+    <PackageVersion Include="Microsoft.KernelMemory.Core" Version="0.37.240420.2" />
     <PackageVersion Include="KernelMemory.MemoryStorage.SqlServer" Version="1.6.3" />
     <PackageVersion Include="FreeMindLabs.KernelMemory.Elasticsearch" Version="0.9.5" />
   </ItemGroup>
   <!-- Semantic Kernel -->
   <ItemGroup>
-    <PackageVersion Include="Microsoft.SemanticKernel.Abstractions" Version="1.7.1" />
-    <PackageVersion Include="Microsoft.SemanticKernel.Connectors.OpenAI" Version="1.7.1" />
+    <PackageVersion Include="Microsoft.SemanticKernel.Abstractions" Version="1.8.0" />
+    <PackageVersion Include="Microsoft.SemanticKernel.Connectors.OpenAI" Version="1.8.0" />
   </ItemGroup>
   <!-- Documentation -->
   <ItemGroup>
@@ -65,11 +65,11 @@
     </PackageVersion>
     <PackageVersion Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0" />
     <PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.9.28" />
-    <PackageVersion Include="Roslynator.CodeAnalysis.Analyzers" Version="4.12.1">
+    <PackageVersion Include="Roslynator.CodeAnalysis.Analyzers" Version="4.12.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageVersion>
-    <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.12.1">
+    <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.12.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageVersion>

clients/dotnet/WebClient/Internals/Verify.cs

@@ -24,10 +24,7 @@ static bool IsReservedIpAddress(string host)
                    host.StartsWith("255.255.255.255", StringComparison.Ordinal);
         }
 
-        if (string.IsNullOrEmpty(url))
-        {
-            throw new ArgumentException("The URL is empty");
-        }
+        ArgumentNullExceptionEx.ThrowIfNullOrEmpty(url, nameof(url), "The URL is empty");
 
         if (requireHttps && url.StartsWith("http://", StringComparison.OrdinalIgnoreCase))
         {

examples/002-dotnet-SemanticKernel-plugin/002-dotnet-SemanticKernel-plugin.csproj

@@ -9,7 +9,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.SemanticKernel" Version="1.7.1" />
+        <PackageReference Include="Microsoft.SemanticKernel" Version="1.8.0" />
         <PackageReference Include="Microsoft.KernelMemory.SemanticKernelPlugin" Version="0.37.240420.2" />
     </ItemGroup>
 

examples/106-dotnet-retrieve-synthetics/Program.cs

@@ -39,7 +39,7 @@ await memory.ImportDocumentAsync(new Document("doc1")
 // Fetch the list of summaries. The API returns one summary for each file.
 var results = await memory.SearchSummariesAsync(filter: MemoryFilters.ByDocument("doc1"));
 
-// Print the summaries!
+// Print the summaries
 foreach (var result in results)
 {
     Console.WriteLine($"== {result.SourceName} summary ==\n{result.Partitions.First().Text}\n");

extensions/AzureAIDocIntel/AzureAIDocIntelConfig.cs

@@ -30,17 +30,17 @@ public void Validate()
     {
         if (this.Auth == AuthTypes.APIKey && string.IsNullOrWhiteSpace(this.APIKey))
         {
-            throw new ArgumentOutOfRangeException(nameof(this.APIKey), "The API Key is empty");
+            throw new ConfigurationException($"Azure AI Document Intelligence: {nameof(this.APIKey)} is empty");
         }
 
         if (string.IsNullOrWhiteSpace(this.Endpoint))
         {
-            throw new ArgumentOutOfRangeException(nameof(this.Endpoint), "The endpoint value is empty");
+            throw new ConfigurationException($"Azure AI Document Intelligence: {nameof(this.Endpoint)} is empty");
         }
 
         if (!this.Endpoint.StartsWith("https://", StringComparison.OrdinalIgnoreCase))
         {
-            throw new ArgumentOutOfRangeException(nameof(this.Endpoint), "The endpoint value must start with https://");
+            throw new ConfigurationException($"Azure AI Document Intelligence: {nameof(this.Endpoint)} must start with https://");
         }
     }
 }

extensions/AzureAIDocIntel/AzureAIDocIntelEngine.cs

@@ -8,7 +8,6 @@
 using Azure.AI.FormRecognizer.DocumentAnalysis;
 using Azure.Identity;
 using Microsoft.Extensions.Logging;
-using Microsoft.KernelMemory.Configuration;
 using Microsoft.KernelMemory.Diagnostics;
 
 namespace Microsoft.KernelMemory.DataFormats.AzureAIDocIntel;

extensions/AzureAISearch/AzureAISearch.TestApplication/Program.cs

@@ -35,8 +35,8 @@ public static async Task Main()
             .AddJsonFile("appsettings.Development.json", optional: true)
             .Build();
 
-        var config = cfg.GetSection("KernelMemory:Services:AzureAISearch").Get<AzureAISearchConfig>()
-                     ?? throw new ArgumentNullException(message: "AzureAISearch config not found", null);
+        var config = cfg.GetSection("KernelMemory:Services:AzureAISearch").Get<AzureAISearchConfig>();
+        ArgumentNullExceptionEx.ThrowIfNull(config, nameof(config), "AzureAISearch config not found");
 
         // Azure AI Search service client
         s_adminClient = new SearchIndexClient(

extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

@@ -2,7 +2,6 @@
 
 using System.Text.Json.Serialization;
 using Azure.Core;
-using Microsoft.KernelMemory.Configuration;
 
 #pragma warning disable IDE0130 // reduce number of "using" statements
 // ReSharper disable once CheckNamespace - reduce number of "using" statements
@@ -35,6 +34,6 @@ public void SetCredential(TokenCredential credential)
     public TokenCredential GetTokenCredential()
     {
         return this._tokenCredential
-               ?? throw new ConfigurationException("TokenCredential not defined");
+               ?? throw new ConfigurationException($"Azure AI Search: {nameof(this._tokenCredential)} not defined");
     }
 }

extensions/AzureAISearch/AzureAISearch/AzureAISearchMemory.cs

@@ -16,7 +16,6 @@
 using Azure.Search.Documents.Models;
 using Microsoft.Extensions.Logging;
 using Microsoft.KernelMemory.AI;
-using Microsoft.KernelMemory.Configuration;
 using Microsoft.KernelMemory.ContentStorage;
 using Microsoft.KernelMemory.Diagnostics;
 using Microsoft.KernelMemory.MemoryStorage;
@@ -53,12 +52,12 @@ public AzureAISearchMemory(
         if (string.IsNullOrEmpty(config.Endpoint))
         {
             this._log.LogCritical("Azure AI Search Endpoint is empty");
-            throw new ConfigurationException("Azure AI Search Endpoint is empty");
+            throw new ConfigurationException($"Azure AI Search: {nameof(config.Endpoint)} is empty");
         }
 
         if (this._embeddingGenerator == null)
         {
-            throw new AzureAISearchMemoryException("Embedding generator not configured");
+            throw new ConfigurationException($"Azure AI Search: {nameof(this._embeddingGenerator)} is not configured");
         }
 
         switch (config.Auth)
@@ -74,7 +73,7 @@ public AzureAISearchMemory(
                 if (string.IsNullOrEmpty(config.APIKey))
                 {
                     this._log.LogCritical("Azure AI Search API key is empty");
-                    throw new ConfigurationException("Azure AI Search API key is empty");
+                    throw new ConfigurationException($"Azure AI Search: {nameof(config.APIKey)} is empty");
                 }
 
                 this._adminClient = new SearchIndexClient(
@@ -431,10 +430,7 @@ private static SearchClientOptions GetClientOptions()
     /// <returns>Normalized name</returns>
     private string NormalizeIndexName(string index)
     {
-        if (string.IsNullOrWhiteSpace(index))
-        {
-            throw new ArgumentNullException(nameof(index), "The index name is empty");
-        }
+        ArgumentNullExceptionEx.ThrowIfNullOrWhiteSpace(index, nameof(index), "The index name is empty");
 
         if (index.Length > 128)
         {

extensions/AzureBlobs/AzureBlobsConfig.cs

@@ -4,7 +4,6 @@
 using Azure;
 using Azure.Core;
 using Azure.Storage;
-using Microsoft.KernelMemory.Configuration;
 
 #pragma warning disable IDE0130 // reduce number of "using" statements
 // ReSharper disable once CheckNamespace - reduce number of "using" statements
@@ -57,18 +56,18 @@ public void SetCredential(TokenCredential credential)
     public StorageSharedKeyCredential GetStorageSharedKeyCredential()
     {
         return this._storageSharedKeyCredential
-               ?? throw new ConfigurationException("StorageSharedKeyCredential not defined");
+               ?? throw new ConfigurationException($"Azure Blobs: {nameof(this._storageSharedKeyCredential)} not defined");
     }
 
     public AzureSasCredential GetAzureSasCredential()
     {
         return this._azureSasCredential
-               ?? throw new ConfigurationException("AzureSasCredential not defined");
+               ?? throw new ConfigurationException($"Azure Blobs: {nameof(this._azureSasCredential)} not defined");
     }
 
     public TokenCredential GetTokenCredential()
     {
         return this._tokenCredential
-               ?? throw new ConfigurationException("TokenCredential not defined");
+               ?? throw new ConfigurationException($"Azure Blobs: {nameof(this._tokenCredential)} not defined");
     }
 }