Upgrade CC to use SK 1.0 Beta 5 (microsoft#586)

### Motivation and Context In anticipation of SK 1.0, we need to make some changes to CC. ### Description - Upgraded SK to 1.0 Beta 5 - Upgraded other NuGets to higher versions - Changed references to Semantic Memory to be to Kernel Memory instead - Switched from using BasicPromptTemplateEngine to BasicPromptTemplateFactory - Changed some "Copilot Chat" strings to "Chat Copilot" in the frontend ### Contribution Checklist - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [Contribution Guidelines](https://github.com/microsoft/chat-copilot/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/chat-copilot/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄
pennsignals · Nov 8, 2023 · 609edcd · 609edcd
1 parent 10ed612
commit 609edcd
Show file tree

Hide file tree

Showing 27 changed files with 71 additions and 79 deletions.
diff --git a/integration-tests/ChatCopilotIntegrationTests.csproj b/integration-tests/ChatCopilotIntegrationTests.csproj
@@ -14,9 +14,9 @@
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="7.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
-    <PackageReference Include="xunit" Version="2.5.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="xunit" Version="2.6.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

diff --git a/memorypipeline/CopilotChatMemoryPipeline.csproj b/memorypipeline/CopilotChatMemoryPipeline.csproj
@@ -15,8 +15,8 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.21.0" />
-    <PackageReference Include="Microsoft.KernelMemory.Core" Version="0.7.231106.1-preview" />
-    <PackageReference Include="Microsoft.SemanticKernel" Version="1.0.0-beta4" />
+    <PackageReference Include="Microsoft.KernelMemory.Core" Version="0.8.231108.1-preview" />
+    <PackageReference Include="Microsoft.SemanticKernel" Version="1.0.0-beta5" />
   </ItemGroup>
 
 </Project>
diff --git a/memorypipeline/README.md b/memorypipeline/README.md
@@ -18,7 +18,7 @@ Importing documents enables Copilot Chat to have up-to-date knowledge of specifi
 
 ### Memory pipeline in Chat Copilot
 
-Chat copilot integrates [Semantic Memory](https://github.com/microsoft/semantic-memory) as the memory solution provider. The memory pipeline is designed to be run as an asynchronous service. If you are expecting to import big documents that can require minutes to process or planning to carry long conversations with the bot, then you can deploy the memory pipeline as a separate service along with the [chat copilot webapi](https://github.com/microsoft/chat-copilot/tree/main/webapi).
+Chat copilot integrates [Kernel Memory](https://github.com/microsoft/kernel-memory) as the memory solution provider. The memory pipeline is designed to be run as an asynchronous service. If you are expecting to import big documents that can require minutes to process or planning to carry long conversations with the bot, then you can deploy the memory pipeline as a separate service along with the [chat copilot webapi](https://github.com/microsoft/chat-copilot/tree/main/webapi).
 
 ### Configuration
 

diff --git a/memorypipeline/appsettings.json b/memorypipeline/appsettings.json
@@ -47,7 +47,7 @@
       "EmbeddingGeneratorType": "AzureOpenAIEmbedding"
     },
     //
-    // Configuration for the various services used by semantic memory and semantic kernel.
+    // Configuration for the various services used by kernel memory and semantic kernel.
     // Section names correspond to type specified in SemanticMemory section.  All supported
     // sections are listed below for reference.  Only referenced sections are required.
     //

diff --git a/plugins/web-searcher/WebSearcher.csproj b/plugins/web-searcher/WebSearcher.csproj
@@ -8,10 +8,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.0.13" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.1.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.OpenApi" Version="1.5.1" />
-    <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.13.0" />
-    <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.18.0" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.16.0" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.19.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/shared/CopilotChatShared.csproj b/shared/CopilotChatShared.csproj
@@ -9,7 +9,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.KernelMemory.Core" Version="0.7.231106.1-preview" />
+    <PackageReference Include="Microsoft.KernelMemory.Core" Version="0.8.231108.1-preview" />
     <PackageReference Include="Tesseract" Version="5.2.0" />
   </ItemGroup>
 

diff --git a/shared/MemoryClientBuilderExtensions.cs b/shared/MemoryClientBuilderExtensions.cs
@@ -6,7 +6,7 @@
 namespace CopilotChat.Shared;
 
 /// <summary>
-/// Dependency injection for semantic-memory using custom OCR configuration defined in appsettings.json
+/// Dependency injection for kernel memory using custom OCR configuration defined in appsettings.json
 /// </summary>
 public static class MemoryClientBuilderExtensions
 {

diff --git a/shared/MemoryConfiguration.cs b/shared/MemoryConfiguration.cs
@@ -2,7 +2,7 @@
 namespace CopilotChat.Shared;
 
 /// <summary>
-/// Configuration constants for semantic-memory.
+/// Configuration constants for kernel memory.
 /// </summary>
 public static class MemoryConfiguration
 {

diff --git a/shared/Ocr/ConfigurationExtensions.cs b/shared/Ocr/ConfigurationExtensions.cs
@@ -9,7 +9,7 @@
 namespace CopilotChat.Shared.Ocr;
 
 /// <summary>
-/// Dependency injection for semantic-memory using configuration defined in appsettings.json
+/// Dependency injection for kernel memory using configuration defined in appsettings.json
 /// </summary>
 public static class ConfigurationExtensions
 {

diff --git a/tools/importdocument/ImportDocument.csproj b/tools/importdocument/ImportDocument.csproj
@@ -18,7 +18,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.0-preview.3.23174.8" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0-preview.3.23174.8" />
-    <PackageReference Include="Microsoft.Identity.Client" Version="4.54.1" />
+    <PackageReference Include="Microsoft.Identity.Client" Version="4.57.0" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
   </ItemGroup>
 

diff --git a/webapi/Controllers/ChatMemoryController.cs b/webapi/Controllers/ChatMemoryController.cs
@@ -19,7 +19,7 @@
 namespace CopilotChat.WebApi.Controllers;
 
 /// <summary>
-/// Controller for retrieving semantic memory data of chat sessions.
+/// Controller for retrieving kernel memory data of chat sessions.
 /// </summary>
 [ApiController]
 public class ChatMemoryController : ControllerBase
@@ -47,7 +47,7 @@ public ChatMemoryController(
     }
 
     /// <summary>
-    /// Gets the semantic memory for the chat session.
+    /// Gets the kernel memory for the chat session.
     /// </summary>
     /// <param name="semanticTextMemory">The semantic text memory instance.</param>
     /// <param name="chatId">The chat id.</param>
@@ -81,7 +81,7 @@ public async Task<IActionResult> GetSemanticMemoriesAsync(
             return this.BadRequest($"Chat session: {sanitizedChatId} does not exist.");
         }
 
-        // Gather the requested semantic memory.
+        // Gather the requested kernel memory.
         // Will use a dummy query since we don't care about relevance.
         // minRelevanceScore is set to 0.0 to return all memories.
         List<string> memories = new();
@@ -91,7 +91,6 @@ public async Task<IActionResult> GetSemanticMemoriesAsync(
             var filter = new MemoryFilter();
             filter.ByTag("chatid", chatId);
             filter.ByTag("memory", memoryContainerName);
-            filter.MinRelevance = 0;
 
             var searchResult =
                 await memoryClient.SearchMemoryAsync(

diff --git a/webapi/Controllers/DocumentController.cs b/webapi/Controllers/DocumentController.cs
@@ -28,7 +28,7 @@ namespace CopilotChat.WebApi.Controllers;
 /// Controller for importing documents.
 /// </summary>
 /// <remarks>
-/// This controller is responsible for contracts that are not possible to fulfill by semantic-memory components.
+/// This controller is responsible for contracts that are not possible to fulfill by kernel memory components.
 /// </remarks>
 [ApiController]
 public class DocumentController : ControllerBase

diff --git a/webapi/CopilotChatWebApi.csproj b/webapi/CopilotChatWebApi.csproj
@@ -17,22 +17,22 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.2.2" />
+    <PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.3.0" />
     <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.21.0" />
     <PackageReference Include="Microsoft.Azure.Cosmos" Version="3.36.0" />
     <PackageReference Include="Microsoft.Identity.Web" Version="2.15.3" />
-    <PackageReference Include="Microsoft.KernelMemory.Core" Version="0.7.231106.1-preview" />
-    <PackageReference Include="Microsoft.SemanticKernel" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Abstractions" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Connectors.AI.OpenAI" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Connectors.Memory.AzureCognitiveSearch" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Connectors.Memory.Qdrant" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Functions.OpenAPI" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Planners.Core" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Plugins.Core" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Plugins.MsGraph" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.Plugins.Web" Version="1.0.0-beta4" />
-    <PackageReference Include="Microsoft.SemanticKernel.TemplateEngine.Basic" Version="1.0.0-beta4" />
+    <PackageReference Include="Microsoft.KernelMemory.Core" Version="0.8.231108.1-preview" />
+    <PackageReference Include="Microsoft.SemanticKernel" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Abstractions" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Connectors.AI.OpenAI" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Connectors.Memory.AzureCognitiveSearch" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Connectors.Memory.Qdrant" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Functions.OpenAPI" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Planners.Core" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Plugins.Core" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Plugins.MsGraph" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.Plugins.Web" Version="1.0.0-beta5" />
+    <PackageReference Include="Microsoft.SemanticKernel.TemplateEngine.Basic" Version="1.0.0-beta5" />
     <PackageReference Include="SharpToken" Version="1.2.12" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
   </ItemGroup>

diff --git a/webapi/Extensions/ISemanticMemoryClientExtensions.cs b/webapi/Extensions/ISemanticMemoryClientExtensions.cs
@@ -81,11 +81,7 @@ public static async Task<SearchResult> SearchMemoryAsync(
         string? memoryName = null,
         CancellationToken cancellationToken = default)
     {
-        var filter =
-            new MemoryFilter
-            {
-                MinRelevance = relevanceThreshold,
-            };
+        var filter = new MemoryFilter();
 
         filter.ByTag(MemoryTags.TagChatId, chatId);
 
@@ -100,6 +96,7 @@ await memoryClient.SearchAsync(
                 indexName,
                 filter,
                 null,
+                0,
                 resultCount,
                 cancellationToken);
 

diff --git a/webapi/Models/Storage/CitationSource.cs b/webapi/Models/Storage/CitationSource.cs
@@ -6,8 +6,8 @@ namespace CopilotChat.WebApi.Models.Storage;
 
 /// <summary>
 /// Information about a citation source.
-/// This is a replica of the <see cref="Citation"/> class in Semantic Memory.
-/// Creating a replica here is to avoid taking a direct dependency on Semantic Memory in our data model.
+/// This is a replica of the <see cref="Citation"/> class in Kernel Memory.
+/// Creating a replica here is to avoid taking a direct dependency on Kernel Memory in our data model.
 /// </summary>
 public class CitationSource
 {

diff --git a/webapi/Models/Storage/MemoryTags.cs b/webapi/Models/Storage/MemoryTags.cs
@@ -3,7 +3,7 @@
 namespace CopilotChat.WebApi.Models.Storage;
 
 /// <summary>
-/// Tag names for semantic memory.
+/// Tag names for kernel memory.
 /// </summary>
 internal static class MemoryTags
 {

diff --git a/webapi/Options/PromptsOptions.cs b/webapi/Options/PromptsOptions.cs
@@ -38,13 +38,13 @@ public class PromptsOptions
     internal double ExternalInformationContextWeight { get; } = 0.3;
 
     /// <summary>
-    /// Upper bound of the relevancy score of a semantic memory to be included in the final prompt.
+    /// Upper bound of the relevancy score of a kernel memory to be included in the final prompt.
     /// The actual relevancy score is determined by the memory balance.
     /// </summary>
     internal float SemanticMemoryRelevanceUpper { get; } = 0.9F;
 
     /// <summary>
-    /// Lower bound of the relevancy score of a semantic memory to be included in the final prompt.
+    /// Lower bound of the relevancy score of a kernel memory to be included in the final prompt.
     /// The actual relevancy score is determined by the memory balance.
     /// </summary>
     internal float SemanticMemoryRelevanceLower { get; } = 0.6F;

diff --git a/webapi/README.md b/webapi/README.md
@@ -29,9 +29,9 @@ The following material is under development and may not be complete or accurate.
    - **Azure Form Recognizer** we have included the [Azure.AI.FormRecognizer](https://www.nuget.org/packages/Azure.AI.FormRecognizer) nuget package.
      - You will need to obtain an [Azure Form Recognizer](https://azure.microsoft.com/en-us/services/form-recognizer/) resource and add the `SemanticMemory:Services:AzureFormRecognizer:Endpoint` and `SemanticMemory:Services:AzureFormRecognizer:Key` values to the `./appsettings.json` file.
 
-## Running [Memory Service](https://github.com/microsoft/semantic-memory)
+## Running [Memory Service](https://github.com/microsoft/kernel-memory)
 
-The memory service handles the creation and querying of semantic memory, including cognitive memory and documents.
+The memory service handles the creation and querying of kernel memory, including cognitive memory and documents.
 
 ### InProcess Processing (Default)
 

diff --git a/webapi/Services/MemoryMigration/IChatMemoryMigrationService.cs b/webapi/Services/MemoryMigration/IChatMemoryMigrationService.cs
@@ -11,7 +11,7 @@ namespace CopilotChat.WebApi.Services.MemoryMigration;
 public interface IChatMemoryMigrationService
 {
     /// <summary>
-    /// Migrates all non-document memory to the semantic-memory index.
+    /// Migrates all non-document memory to the kernel memory index.
     /// Subsequent/redunant migration is non-destructive/no-impact to migrated index.
     /// </summary>
     Task MigrateAsync(CancellationToken cancellationToken = default);

diff --git a/webapi/Services/SemanticKernelProvider.cs b/webapi/Services/SemanticKernelProvider.cs
@@ -48,7 +48,7 @@ public SemanticKernelProvider(IServiceProvider serviceProvider, IConfiguration c
     public IKernel GetPlannerKernel() => this._builderPlanner.Build();
 
     /// <summary>
-    /// Produce semantic-kernel with semantic-memory.
+    /// Produce semantic-kernel with kernel memory.
     /// </summary>
     public ISemanticTextMemory GetMigrationMemory() => this._builderMemory.Build();
 

diff --git a/webapi/Skills/ChatSkills/ChatSkill.cs b/webapi/Skills/ChatSkills/ChatSkill.cs
@@ -28,6 +28,7 @@
 using Microsoft.SemanticKernel.Diagnostics;
 using Microsoft.SemanticKernel.Orchestration;
 using Microsoft.SemanticKernel.Planning;
+using Microsoft.SemanticKernel.TemplateEngine;
 using Microsoft.SemanticKernel.TemplateEngine.Basic;
 using ChatCompletionContextMessages = Microsoft.SemanticKernel.AI.ChatCompletion.ChatHistory;
 
@@ -46,7 +47,7 @@ public class ChatSkill
     private readonly IKernel _kernel;
 
     /// <summary>
-    /// Client for the semantic-memory service.
+    /// Client for the kernel memory service.
     /// </summary>
     private readonly IKernelMemory _memoryClient;
 
@@ -76,7 +77,7 @@ public class ChatSkill
     private readonly PromptsOptions _promptOptions;
 
     /// <summary>
-    /// A semantic memory retriever instance to query semantic memories.
+    /// A kernel memory retriever instance to query semantic memories.
     /// </summary>
     private readonly SemanticMemoryRetriever _semanticMemoryRetriever;
 
@@ -436,11 +437,9 @@ await this.SaveNewResponseAsync(
 
             // Add bot message proposal as prompt context message
             chatContext.Variables.Set("planFunctions", this._externalInformationSkill.FormattedFunctionsString(deserializedPlan.Plan));
-            var promptRenderer = new BasicPromptTemplateEngine();
-            var proposedPlanBotMessage = await promptRenderer.RenderAsync(
-               this._promptOptions.ProposedPlanBotMessage,
-                chatContext,
-                cancellationToken);
+            var promptTemplateFactory = new BasicPromptTemplateFactory();
+            var proposedPlanTemplate = promptTemplateFactory.Create(this._promptOptions.ProposedPlanBotMessage, new PromptTemplateConfig());
+            var proposedPlanBotMessage = await proposedPlanTemplate.RenderAsync(chatContext, cancellationToken);
             promptTemplate.AddAssistantMessage(proposedPlanBotMessage);
             chatHistoryString += "\n" + PromptUtils.FormatChatHistoryMessage(ChatMessage.AuthorRoles.Bot, proposedPlanBotMessage);
 
@@ -453,10 +452,8 @@ await this.SaveNewResponseAsync(
             promptTemplate.AddSystemMessage(deserializedPlan.UserIntent);
 
             // Render system supplement to help guide model in using data.
-            var promptSupplement = await promptRenderer.RenderAsync(
-                this._promptOptions.PlanResultsDescription,
-                chatContext,
-                cancellationToken);
+            var promptSupplementTemplate = promptTemplateFactory.Create(this._promptOptions.PlanResultsDescription, new PromptTemplateConfig());
+            var promptSupplement = await promptSupplementTemplate.RenderAsync(chatContext, cancellationToken);
 
             // Calculate remaining token budget and execute plan
             await this.UpdateBotResponseStatusOnClientAsync(chatId, "Executing plan", cancellationToken);
@@ -627,11 +624,11 @@ private async Task<string> RenderSystemInstructions(string chatId, SKContext con
     {
         // Render system instruction components
         await this.UpdateBotResponseStatusOnClientAsync(chatId, "Initializing prompt", cancellationToken);
-        var promptRenderer = new BasicPromptTemplateEngine();
-        return await promptRenderer.RenderAsync(
-            this._promptOptions.SystemPersona,
-            context,
-            cancellationToken);
+
+        var promptTemplateFactory = new BasicPromptTemplateFactory();
+        var template = promptTemplateFactory.Create(this._promptOptions.SystemPersona, new PromptTemplateConfig());
+
+        return await template.RenderAsync(context, cancellationToken);
     }
 
     /// <summary>

diff --git a/webapi/Skills/ChatSkills/ExternalInformationSkill.cs b/webapi/Skills/ChatSkills/ExternalInformationSkill.cs
@@ -20,6 +20,7 @@
 using Microsoft.SemanticKernel.Orchestration;
 using Microsoft.SemanticKernel.Planners;
 using Microsoft.SemanticKernel.Planning;
+using Microsoft.SemanticKernel.TemplateEngine;
 using Microsoft.SemanticKernel.TemplateEngine.Basic;
 
 namespace CopilotChat.WebApi.Skills.ChatSkills;
@@ -252,11 +253,9 @@ private async Task<string> RunStepwisePlannerAsync(string goal, SKContext contex
         }
 
         // Render the supplement to guide the model in using the result.
-        var promptRenderer = new BasicPromptTemplateEngine();
-        var resultSupplement = await promptRenderer.RenderAsync(
-            this._promptOptions.StepwisePlannerSupplement,
-            plannerContext,
-            cancellationToken);
+        var promptTemplateFactory = new BasicPromptTemplateFactory();
+        var promptTemplate = promptTemplateFactory.Create(this._promptOptions.StepwisePlannerSupplement, new PromptTemplateConfig());
+        var resultSupplement = await promptTemplate.RenderAsync(plannerContext, cancellationToken);
 
         return $"{resultSupplement}\n\nResult:\n\"{plannerResult}\"";
     }