Restructure project files

Add API key to functional tests
Update some dependencies

Author: dluc

KernelMemory.sln

@@ -6,7 +6,7 @@
 using System.Globalization;
 using System.Text.Json;
 
-namespace Microsoft.KernelMemory.Plugin;
+namespace Microsoft.KernelMemory.Plugin.Internals;
 
 [TypeConverter(typeof(TypeConverter))]
 public class TagCollectionWrapper : TagCollection

plugins/dotnet/Microsoft.KernelMemory.Plugin/TypeConverter.cs renamed to clients/dotnet/Plugin/Internals/TypeConverter.cs

@@ -6,7 +6,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
-using Microsoft.KernelMemory.Plugin;
+using Microsoft.KernelMemory.Plugin.Internals;
 using Microsoft.SemanticKernel;
 
 #pragma warning disable IDE0130 // reduce number of "using" statements
@@ -65,10 +65,9 @@ public class MemoryPlugin
     public const string MinRelevanceParam = "minRelevance";
 
     /// <summary>
-    /// Default document ID. When null, a new value is generated every time some information
-    /// is saved into memory.
+    /// Name of the input variable used to specify the maximum number of items to return.
     /// </summary>
-    private const string? DefaultDocumentId = null;
+    public const string LimitParam = "limit";
 
     /// <summary>
     /// Default index where to store and retrieve memory from. When null the service
@@ -100,7 +99,7 @@ public class MemoryPlugin
     /// <summary>
     /// Max time to wait for ingestion completion when <see cref="_waitForIngestionToComplete"/> is set to True.
     /// </summary>
-    private TimeSpan _maxIngestionWait = TimeSpan.FromSeconds(15);
+    private readonly TimeSpan _maxIngestionWait = TimeSpan.FromSeconds(15);
 
     /// <summary>
     /// Client to memory read/write. This is usually an instance of MemoryWebClient
@@ -135,6 +134,7 @@ public MemoryPlugin(
             defaultIngestionSteps,
             waitForIngestionToComplete)
     {
+        // TODO: add api key header name
     }
 
     /// <summary>
@@ -186,7 +186,7 @@ public MemoryPlugin(
     /// </summary>
     /// <example>
     /// SKContext.Variables["input"] = "the capital of France is Paris"
-    /// {{memory.importText $input }}
+    /// {{memory.save $input }}
     /// </example>
     /// <example>
     /// SKContext.Variables["input"] = "the capital of France is Paris"
@@ -199,10 +199,9 @@ public MemoryPlugin(
     /// {{memory.save $input }}
     /// </example>
     /// <returns>Document ID</returns>
-    [SKFunction, Description("Store in memory the information extracted from the given text")]
+    [SKFunction, Description("Store in memory the given text")]
     public async Task<string> SaveAsync(
-        [Description("The information to save")]
-        string input,
+        [Description("The text to save")] string input,
         [SKName(DocumentIdParam), Description("The document ID associated with the information to save"), DefaultValue(null)]
         string? documentId = null,
         [SKName(IndexParam), Description("Memories index associated with the information to save"), DefaultValue(null)]
@@ -214,6 +213,8 @@ public async Task<string> SaveAsync(
         ILoggerFactory? loggerFactory = null,
         CancellationToken cancellationToken = default)
     {
+        // TODO: check if one has to use "input" or "documentId"
+
         Task<string> Do(CancellationToken token)
         {
             return this._memory.ImportTextAsync(
@@ -228,16 +229,38 @@ Task<string> Do(CancellationToken token)
         if (this._waitForIngestionToComplete)
         {
             using var cs = new CancellationTokenSource(this._maxIngestionWait);
-            return await Do(cs.Token).ConfigureAwait(false);
+            string id = await Do(cs.Token).ConfigureAwait(false);
+            // TODO CHECK IF DOC HAS BEEN IMPORTED
+            return id;
         }
 
         return await Do(cancellationToken).ConfigureAwait(false);
     }
 
+    /// <summary>
+    /// Store a file content in long term memory.
+    ///
+    /// Usage from prompts: '{{memory.saveFile ...}}'
+    /// </summary>
+    /// <example>
+    /// SKContext.Variables["input"] = "C:\Documents\presentation.pptx"
+    /// {{memory.saveFile $input }}
+    /// </example>
+    /// <example>
+    /// SKContext.Variables["input"] = "C:\Documents\presentation.pptx"
+    /// SKContext.Variables[MemoryPlugin.IndexParam] = "work"
+    /// {{memory.saveFile $input }}
+    /// </example>
+    /// <example>
+    /// SKContext.Variables["input"] = "C:\Documents\presentation.pptx"
+    /// SKContext.Variables[MemoryPlugin.DocumentIdParam] = "presentation001"
+    /// {{memory.saveFile $input }}
+    /// </example>
+    /// <returns>Document ID</returns>
     [SKFunction, Description("Store in memory the information extracted from a file")]
     public async Task<string> SaveFileAsync(
         [Description("Path of the file to save in memory")]
-        string input,
+        string filePath,
         [SKName(DocumentIdParam), Description("The document ID associated with the information to save"), DefaultValue(null)]
         string? documentId = null,
         [SKName(IndexParam), Description("Memories index associated with the information to save"), DefaultValue(null)]
@@ -252,34 +275,75 @@ public async Task<string> SaveFileAsync(
         Task<string> Do(CancellationToken token)
         {
             return this._memory.ImportDocumentAsync(
-                filePath: input,
+                filePath: filePath,
                 documentId: documentId,
-                index: index ?? this._defaultIndex,
                 tags: tags ?? this._defaultIngestionTags,
+                index: index ?? this._defaultIndex,
                 steps: steps ?? this._defaultIngestionSteps,
                 cancellationToken: token);
         }
 
         if (this._waitForIngestionToComplete)
         {
             using var cs = new CancellationTokenSource(this._maxIngestionWait);
-            return await Do(cs.Token).ConfigureAwait(false);
+            string id = await Do(cs.Token).ConfigureAwait(false);
+            // TODO CHECK IF DOC HAS BEEN IMPORTED
+            return id;
         }
 
         return await Do(cancellationToken).ConfigureAwait(false);
     }
 
     [SKFunction, Description("Store in memory the information extracted from a web page")]
-    public async Task<string> SaveWebPageAsync()
+    public async Task<string> SaveWebPageAsync(
+        [Description("Complete URL of the web page to save")]
+        string url,
+        [SKName(DocumentIdParam), Description("The document ID associated with the information to save"), DefaultValue(null)]
+        string? documentId = null,
+        [SKName(IndexParam), Description("Memories index associated with the information to save"), DefaultValue(null)]
+        string? index = null,
+        [SKName(TagsParam), Description("Memories index associated with the information to save"), DefaultValue(null)]
+        TagCollectionWrapper? tags = null,
+        [SKName(StepsParam), Description("Steps to parse the information and store in memory"), DefaultValue(null)]
+        ListOfStringsWrapper? steps = null,
+        ILoggerFactory? loggerFactory = null,
+        CancellationToken cancellationToken = default)
     {
-        await Task.Delay(0).ConfigureAwait(false);
-        throw new NotImplementedException();
+        Task<string> Do(CancellationToken token)
+        {
+            return this._memory.ImportWebPageAsync(
+                url: url,
+                documentId: documentId,
+                tags: tags ?? this._defaultIngestionTags,
+                index: index ?? this._defaultIndex,
+                steps: steps ?? this._defaultIngestionSteps,
+                cancellationToken: token);
+        }
+
+        if (this._waitForIngestionToComplete)
+        {
+            using var cs = new CancellationTokenSource(this._maxIngestionWait);
+            string id = await Do(cs.Token).ConfigureAwait(false);
+            // TODO CHECK IF DOC HAS BEEN IMPORTED
+            return id;
+        }
+
+        return await Do(cancellationToken).ConfigureAwait(false);
     }
 
     [SKFunction, Description("Return up to N memories related to the input text")]
-    public async Task<string> SearchAsync()
+    public async Task<string> SearchAsync(
+        [Description("The text to search")] string query,
+        [SKName(IndexParam), Description("Memories index to search for information"), DefaultValue("")]
+        string? index = null,
+        [SKName(MinRelevanceParam), Description("Minimum relevance of the memories to return"), DefaultValue(0d)]
+        double minRelevance = 0,
+        [SKName(LimitParam), Description("Maximum number of memories to return"), DefaultValue(0d)]
+        int limit = 10,
+        CancellationToken cancellationToken = default)
     {
-        await Task.Delay(0).ConfigureAwait(false);
+        await Task.Delay(0, cancellationToken).ConfigureAwait(false);
+        // TODO check the old Semantic Memory
         throw new NotImplementedException();
     }
 
@@ -288,43 +352,43 @@ public async Task<string> SearchAsync()
     ///
     /// Usage from prompts: '{{memory.ask ...}}'
     /// </summary>
-    /// <param name="input">The question to answer</param>
     /// <returns>The answer returned by the memory.</returns>
     [SKFunction, Description("Use long term memory to answer a quesion")]
     public async Task<string> AskAsync(
         [Description("The question to answer")]
-        string input,
+        string question,
         [SKName(IndexParam), Description("Memories index to search for answers"), DefaultValue("")]
         string? index = null,
-        [SKName(MinRelevanceParam), Description("Memories index to search for answers"), DefaultValue(0d)]
+        [SKName(MinRelevanceParam), Description("Minimum relevance of the sources to consider"), DefaultValue(0d)]
         double minRelevance = 0,
         ILoggerFactory? loggerFactory = null,
         CancellationToken cancellationToken = default)
     {
-        Task<MemoryAnswer> Do(CancellationToken token)
-        {
-            return this._memory.AskAsync(question: input, cancellationToken: token);
-        }
-
-        MemoryAnswer? answer;
-        if (this._waitForIngestionToComplete)
-        {
-            // using var cs = new CancellationTokenSource(this._maxIngestionWait);
-            using var cs = new CancellationTokenSource(TimeSpan.FromMilliseconds(1));
-            answer = await Do(cs.Token).ConfigureAwait(false);
-        }
-        else
-        {
-            answer = await Do(cancellationToken).ConfigureAwait(false);
-        }
-
-        return answer?.Result ?? string.Empty;
+        // TODO: support filters
+        MemoryAnswer answer = await this._memory.AskAsync(
+            question: question,
+            index: index ?? this._defaultIndex,
+            minRelevance: minRelevance,
+            cancellationToken: cancellationToken).ConfigureAwait(false);
+        return answer.Result;
     }
 
-    [SKFunction, Description("Remobe from memory all the information extracted from the given document ID")]
-    public async Task<string> DeleteAsync()
+    /// <summary>
+    /// Remove from memory all the information extracted from the given document ID
+    ///
+    /// Usage from prompts: '{{memory.delete ...}}'
+    /// </summary>
+    [SKFunction, Description("Remove from memory all the information extracted from the given document ID")]
+    public Task DeleteAsync(
+        [Description("The document to delete")]
+        string documentId,
+        [SKName(IndexParam), Description("Memories index where the document is stored"), DefaultValue("")]
+        string? index = null,
+        CancellationToken cancellationToken = default)
     {
-        await Task.Delay(0).ConfigureAwait(false);
-        throw new NotImplementedException();
+        return this._memory.DeleteDocumentAsync(
+            documentId: documentId,
+            index: index ?? this._defaultIndex,
+            cancellationToken: cancellationToken);
     }
 }

plugins/dotnet/Microsoft.KernelMemory.Plugin/MemoryPlugin.cs renamed to clients/dotnet/Plugin/MemoryPlugin.cs

@@ -0,0 +1,25 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <Import Project="../../../service/Directory.Build.props"/>
+    <Import Project="../../../service/Directory.Packages.props"/>
+    <Import Project="../../../service/nuget-package.props"/>
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <AssemblyName>Microsoft.KernelMemory.Plugin</AssemblyName>
+        <RootNamespace>Microsoft.KernelMemory.Plugin</RootNamespace>
+        <IsPackable>true</IsPackable>
+        <PackageId>Microsoft.KernelMemory.Plugin</PackageId>
+        <NoWarn>CS1591</NoWarn>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\..\..\service\Abstractions\Abstractions.csproj"/>
+        <ProjectReference Include="..\WebClient\WebClient.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.SemanticKernel.Abstractions"/>
+    </ItemGroup>
+
+</Project>

clients/dotnet/Plugin/Plugin.csproj

@@ -2,7 +2,7 @@
 
 using System;
 
-namespace Microsoft.KernelMemory.Models;
+namespace Microsoft.KernelMemory.Internals;
 
 internal static class Verify
 {

dotnet/ClientLib/Models/Verify.cs renamed to clients/dotnet/WebClient/Internals/Verify.cs

@@ -10,8 +10,9 @@
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
-using Microsoft.KernelMemory.Models;
+using Microsoft.KernelMemory.Internals;
 
+#pragma warning disable IDE0130 // reduce number of "using" statements
 // ReSharper disable once CheckNamespace
 namespace Microsoft.KernelMemory;
 

dotnet/ClientLib/MemoryWebClient.cs renamed to clients/dotnet/WebClient/MemoryWebClient.cs

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <Import Project="../../../service/Directory.Build.props"/>
+    <Import Project="../../../service/Directory.Packages.props"/>
+    <Import Project="../../../service/nuget-package.props"/>
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <AssemblyName>Microsoft.KernelMemory.WebClient</AssemblyName>
+        <RootNamespace>Microsoft.KernelMemory</RootNamespace>
+        <IsPackable>true</IsPackable>
+        <PackageId>Microsoft.KernelMemory.WebClient</PackageId>
+        <NoWarn>CS1591</NoWarn>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\..\..\service\Abstractions\Abstractions.csproj"/>
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.SemanticKernel.Abstractions"/>
+    </ItemGroup>
+
+</Project>

clients/dotnet/WebClient/WebClient.csproj

@@ -6,17 +6,17 @@
         <ImplicitUsings>enable</ImplicitUsings>
         <AssemblyName/>
         <RootNamespace/>
+        <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
         <UserSecretsId>5ee045b0-aea3-4f08-8d31-32d1a6f8fed0</UserSecretsId>
         <NoWarn>CA1050,CA2000,CA1707,CA1303,CA2007,CA1724</NoWarn>
     </PropertyGroup>
 
     <ItemGroup>
-        <ProjectReference Include="..\..\dotnet\CoreLib\CoreLib.csproj"/>
-        <ProjectReference Include="..\..\dotnet\InteractiveSetup\InteractiveSetup.csproj"/>
+        <ProjectReference Include="..\..\service\Core\Core.csproj" />
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="System.Memory.Data"/>
+        <PackageReference Include="System.Memory.Data" Version="7.0.0"/>
     </ItemGroup>
 
     <ItemGroup>