Merge pull request #54 from Encamina/@rliberoff/improvements_on_ephem…

…aral_memory_handler

Update Memory Manager

CHANGELOG.md

@@ -23,7 +23,7 @@ Previous classification is not required if changes are simple or all belong to t
 - Removed visibility modifiers in `IMemoryManager` interface.
 - Signature of `UpsertMemoryAsync` method has changed in `IMemoryManager` interface.
 - Signature of `BatchUpsertMemoriesAsync` method has changed in `IMemoryManager` interface.
-- Dependency with `Kernel` has been replace with dependency to `ITextEmbeddingGenerationService` in `MemoryManager` class. Also, added dependency with `ILogger`.
+- Dependency with `Kernel` has been removed in `MemoryManager` class. Also, added dependency with `ILogger`.
 
 ### Major change
 - Method `GetDocumentConnector` in `DocumentContentExtractorBase` is now `public` instead of `protected`.
@@ -36,6 +36,7 @@ Previous classification is not required if changes are simple or all belong to t
 - In `EphemeralMemoryStoreHandler`, property `CollectionNamePrefix` has the value `ephemeral-` fixed.
 - Fixed some typos and grammatical errors (mostly on code comments).
 - Added new extension method `AddDefaultDocumentConnectorProvider` in `Encamina.Enmarcha.SemanticKernel.Connectors.Document` to get access to a default implementation of a `IDocumentConnector`.
+- Updated sample projects with latest changes.
 
 ## [8.1.1]
 

Directory.Build.props

@@ -17,7 +17,7 @@
 
   <PropertyGroup>
     <VersionPrefix>8.1.2</VersionPrefix>
-    <VersionSuffix>preview-7</VersionSuffix>
+    <VersionSuffix>preview-8</VersionSuffix>
   </PropertyGroup>
 
   <!--

samples/SemanticKernel/Encamina.Enmarcha.Samples.SemanticKernel.QuestionAnswering/ExampleQuestionAnsweringFromMemory..cs

@@ -57,13 +57,15 @@ public static async Task RunAsync()
 
         var host = hostBuilder.Build();
 
+        var kernel = host.Services.GetRequiredService<Kernel>();
+
         // Initialize mock memory
         var mockMemoryInformation = new MockMemoryInformation(host.Services.GetRequiredService<IMemoryManager>(), host.Services.GetRequiredService<IMemoryStore>());
         await mockMemoryInformation.CreateCollection();
-        await mockMemoryInformation.SaveDataMockAsync();
+        await mockMemoryInformation.SaveDataMockAsync(kernel);
 
         // Initialize Q&A from Memory
-        var testQuestionAnswering = new TestQuestionAnswering(host.Services.GetService<Kernel>());
+        var testQuestionAnswering = new TestQuestionAnswering(kernel);
         var result = await testQuestionAnswering.TestQuestionAnsweringFromMemoryAsync();
 
         Console.WriteLine($@"RESULT: {result}");

samples/SemanticKernel/Encamina.Enmarcha.Samples.SemanticKernel.QuestionAnswering/MockMemoryInformation.cs

@@ -1,5 +1,6 @@
 using Encamina.Enmarcha.SemanticKernel.Abstractions;
 
+using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.Memory;
 
 namespace Encamina.Enmarcha.Samples.SemanticKernel.QuestionAnswering;
@@ -20,7 +21,7 @@ public async Task CreateCollection()
         await memoryStore.CreateCollectionAsync(collectionName: "my-collection", CancellationToken.None);
     }
 
-    public async Task SaveDataMockAsync()
+    public async Task SaveDataMockAsync(Kernel kernel)
     {
         var memoryId = Guid.NewGuid().ToString();
 
@@ -33,6 +34,6 @@ public async Task SaveDataMockAsync()
         Console.WriteLine($"# Second chunk: {secondChunkText}  \n");
         Console.WriteLine($"# Third chunk: {thirdChunkText}   \n");
 
-        await memoryManager.UpsertMemoryAsync(memoryId: memoryId, collectionName: "my-collection", chunks: new List<string> { firstChunkText, secondChunkText, thirdChunkText }, cancellationToken: CancellationToken.None);
+        await memoryManager.UpsertMemoryAsync(memoryId: memoryId, collectionName: "my-collection", chunks: new List<string> { firstChunkText, secondChunkText, thirdChunkText }, kernel, cancellationToken: CancellationToken.None);
     }
 }

src/Encamina.Enmarcha.SemanticKernel.Abstractions/IMemoryManager.cs

@@ -24,7 +24,7 @@ public interface IMemoryManager
     /// <param name="cancellationToken">Cancellation token to cancel the operation.</param>
     /// <param name="metadata">Metadata of the memory.</param>
     /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
-    Task UpsertMemoryAsync(string memoryId, string collectionName, IEnumerable<string> chunks, IDictionary<string, string> metadata = null, Kernel kernel = null, CancellationToken cancellationToken = default);
+    Task UpsertMemoryAsync(string memoryId, string collectionName, IEnumerable<string> chunks, Kernel kernel, IDictionary<string, string> metadata = null, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Deletes the memory content from a collection.
@@ -55,5 +55,5 @@ public interface IMemoryManager
     /// </param>
     /// <param name="cancellationToken">Cancellation token to cancel the operation.</param>
     /// <returns>The unique identifiers for the memory records (not necessarily the same as the unique identifier of the memory content).</returns>
-    IAsyncEnumerable<string> BatchUpsertMemoriesAsync(string collectionName, IDictionary<string, MemoryContent> memoryContents, Kernel kernel = null, CancellationToken cancellationToken = default);
+    IAsyncEnumerable<string> BatchUpsertMemoriesAsync(string collectionName, IDictionary<string, MemoryContent> memoryContents, Kernel kernel, CancellationToken cancellationToken);
 }

src/Encamina.Enmarcha.SemanticKernel/EphemeralMemoryStoreHandler.cs

@@ -4,8 +4,6 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 
-using Microsoft.SemanticKernel.Memory;
-
 namespace Encamina.Enmarcha.SemanticKernel;
 
 /// <summary>

src/Encamina.Enmarcha.SemanticKernel/MemoryManager.cs

@@ -22,28 +22,21 @@ public class MemoryManager : IMemoryManager
 
     private readonly ILogger logger;
 
-    private readonly ITextEmbeddingGenerationService textEmbeddingGenerationService;
-
     /// <summary>
     /// Initializes a new instance of the <see cref="MemoryManager"/> class.
     /// </summary>
-    /// <param name="kernel">
-    /// A valid instance of <see cref="Kernel"/>, used to get the configured text embeddings generation service (<see cref="ITextEmbeddingGenerationService"/>) required by this manager.
-    /// </param>
     /// <param name="memoryStore">A valid instance of a <see cref="IMemoryStore"/> to manage.</param>
-    public MemoryManager(IMemoryStore memoryStore, ITextEmbeddingGenerationService textEmbeddingGenerationService, ILogger<MemoryManager> logger)
+    public MemoryManager(IMemoryStore memoryStore, ILogger<MemoryManager> logger)
     {
         this.logger = logger;
         MemoryStore = memoryStore;
-
-        this.textEmbeddingGenerationService = textEmbeddingGenerationService;
     }
 
     /// <inheritdoc/>
     public IMemoryStore MemoryStore { get; init; }
 
     /// <inheritdoc/>
-    public virtual async Task UpsertMemoryAsync(string memoryId, string collectionName, IEnumerable<string> chunks, IDictionary<string, string> metadata = null, Kernel kernel = null, CancellationToken cancellationToken = default)
+    public virtual async Task UpsertMemoryAsync(string memoryId, string collectionName, IEnumerable<string> chunks, Kernel kernel, IDictionary<string, string> metadata = null, CancellationToken cancellationToken = default)
     {
         var memoryChunkSize = await GetChunkSize(memoryId, collectionName, cancellationToken);
 
@@ -87,7 +80,7 @@ public virtual async Task<MemoryContent> GetMemoryAsync(string memoryId, string
     }
 
     /// <inheritdoc/>
-    public virtual async IAsyncEnumerable<string> BatchUpsertMemoriesAsync(string collectionName, IDictionary<string, MemoryContent> memoryContents, Kernel kernel = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public virtual async IAsyncEnumerable<string> BatchUpsertMemoriesAsync(string collectionName, IDictionary<string, MemoryContent> memoryContents, Kernel kernel, [EnumeratorCancellation] CancellationToken cancellationToken)
     {
         var memoryRecords = new Collection<MemoryRecord>();
 
@@ -104,7 +97,7 @@ public virtual async IAsyncEnumerable<string> BatchUpsertMemoriesAsync(string co
                 for (var i = 0; i < totalChunks; i++)
                 {
                     var chunk = memoryContent.Chunks.ElementAt(i);
-                    var embedding = await textEmbeddingGenerationService.GenerateEmbeddingAsync(chunk, kernel, cancellationToken);
+                    var embedding = await kernel.GetRequiredService<ITextEmbeddingGenerationService>().GenerateEmbeddingAsync(chunk, kernel, cancellationToken);
                     memoryRecords.Add(MemoryRecord.LocalRecord($@"{memoryContentId}-{i}", chunk, null, embedding, JsonSerializer.Serialize(memoryContent.Metadata)));
                 }
             }
@@ -140,7 +133,7 @@ private async Task DeleteMemoryAsync(string memoryId, string collectionName, int
         await MemoryStore.RemoveBatchAsync(collectionName, Enumerable.Range(0, chunkSize).Select(i => BuildMemoryIdentifier(memoryId, i)), cancellationToken);
     }
 
-    private async Task SaveChunks(string memoryid, string collectionName, IEnumerable<string> chunks, IDictionary<string, string> metadata, Kernel kernel = null, CancellationToken cancellationToken = default)
+    private async Task SaveChunks(string memoryid, string collectionName, IEnumerable<string> chunks, IDictionary<string, string> metadata, Kernel kernel, CancellationToken cancellationToken)
     {
         metadata ??= new Dictionary<string, string>();
 
@@ -155,7 +148,7 @@ private async Task SaveChunks(string memoryid, string collectionName, IEnumerabl
         for (var i = 0; i < chunksCount; i++)
         {
             var chunk = chunks.ElementAt(i);
-            var embedding = await textEmbeddingGenerationService.GenerateEmbeddingAsync(chunk, kernel, cancellationToken);
+            var embedding = await kernel.GetRequiredService<ITextEmbeddingGenerationService>().GenerateEmbeddingAsync(chunk, kernel, cancellationToken);
             memoryRecords.Add(MemoryRecord.LocalRecord(BuildMemoryIdentifier(memoryid, i), chunk, null, embedding, metadataJson));
         }