implement chat protocal (#299)

LittleLittleCloud · IEvangelist · web-flow · commit e193da464d60 · 2024-04-15T11:49:36.000-07:00
## Purpose  * ... This PR implements chat protocal (non-streaming) part. ## Does this introduce a breaking change?  ``` [ ] Yes [x] No ``` fix #254 Link to chat protocal: https://github.com/Azure-Samples/ai-chat-app-protocol ## Pull Request Type What kind of change does this Pull Request introduce?  ``` [ ] Bugfix [ ] Feature [ ] Code style update (formatting, local variables) [ ] Refactoring (no functional changes, no api changes) [ ] Documentation content changes [ ] Other... Please describe: ``` ## How to Test * Get the code ``` git clone [repo-address] cd [repo-name] git checkout [branch-name] npm install ``` * Test the code  ``` ``` ## What to Check Verify that the following are valid * ... ## Other Information  --------- Co-authored-by: David Pine <david.pine@microsoft.com>
diff --git a/app/Directory.Build.props b/app/Directory.Build.props
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <AzureFormRecognizerVersion>4.1.0</AzureFormRecognizerVersion>
-    <AzureIdentityVersion>1.10.1</AzureIdentityVersion>
+    <AzureIdentityVersion>1.11.0</AzureIdentityVersion>
     <AzureSearchDocumentsVersion>11.5.0-beta.4</AzureSearchDocumentsVersion>
     <AzureStorageBlobsVersion>12.17.0</AzureStorageBlobsVersion>
     <AzureOpenAIVersion>1.0.0-beta.7</AzureOpenAIVersion>
diff --git a/app/Directory.Packages.props b/app/Directory.Packages.props
@@ -7,7 +7,7 @@
     <PackageVersion Include="Azure.AI.FormRecognizer" Version="4.1.0" />
     <PackageVersion Include="Azure.AI.OpenAI" Version="1.0.0-beta.12" />
     <PackageVersion Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.3.0" />
-    <PackageVersion Include="Azure.Identity" Version="1.10.4" />
+    <PackageVersion Include="Azure.Identity" Version="1.11.0" />
     <PackageVersion Include="Azure.Search.Documents" Version="11.5.1" />
     <PackageVersion Include="Azure.Storage.Blobs" Version="12.19.1" />
     <PackageVersion Include="Azure.Storage.Files.Shares" Version="12.17.1" />
diff --git a/app/SharedWebComponents/Components/Answer.razor b/app/SharedWebComponents/Components/Answer.razor
@@ -46,20 +46,20 @@
             </MudTabPanel>
             <MudTabPanel Icon="@Icons.Material.Filled.Lightbulb" Text="Thought process" 
                          ToolTip="Show thought process."
-                         Disabled="@(Retort is { Thoughts: null })">
+                         Disabled="@(Retort is { Context.Thoughts: null } or { Context.Thoughts.Length: 0})">
                 <ChildContent>
                     <MudPaper Class="pa-6" Elevation="3">
                         <pre style="white-space: normal; font-size: 1.2em;">
-                            @(RemoveLeadingAndTrailingLineBreaks(Retort.Thoughts!))
+                                @(RemoveLeadingAndTrailingLineBreaks(Retort.Context.ThoughtsString))
                         </pre>
                     </MudPaper>
                 </ChildContent>
             </MudTabPanel>
             <MudTabPanel Icon="@Icons.Material.Filled.TextSnippet" Text="Supporting Content"
-                         ToolTip="Show the supporting content." Disabled="@(Retort is { DataPoints: null } or { DataPoints.Length: 0 })">
+                         ToolTip="Show the supporting content." Disabled="@(Retort is { Context.DataPoints.Text: null } or { Context.DataPoints.Text.Length: 0 })">
                 <ChildContent>
                     <MudPaper Class="pa-2" Elevation="3">
-                        <SupportingContent DataPoints="Retort.DataPoints" Images="Retort.Images ?? []" />
+                        <SupportingContent DataPoints="Retort.Context.DataPointsContent" Images="Retort.Context.DataPointsImages ?? []" />
                     </MudPaper>
                 </ChildContent>
             </MudTabPanel>
diff --git a/app/SharedWebComponents/Components/Answer.razor.cs b/app/SharedWebComponents/Components/Answer.razor.cs
@@ -4,7 +4,7 @@ namespace SharedWebComponents.Components;
 
 public sealed partial class Answer
 {
-    [Parameter, EditorRequired] public required ApproachResponse Retort { get; set; }
+    [Parameter, EditorRequired] public required ResponseChoice Retort { get; set; }
     [Parameter, EditorRequired] public required EventCallback<string> FollowupQuestionClicked { get; set; }
 
     [Inject] public required IPdfViewer PdfViewer { get; set; }
@@ -14,7 +14,7 @@ public sealed partial class Answer
     protected override void OnParametersSet()
     {
         _parsedAnswer = ParseAnswerToHtml(
-            Retort.Answer, Retort.CitationBaseUrl);
+            Retort.Message.Content, Retort.CitationBaseUrl);
 
         base.OnParametersSet();
     }
diff --git a/app/SharedWebComponents/Components/AnswerError.razor b/app/SharedWebComponents/Components/AnswerError.razor
@@ -2,10 +2,10 @@
     <MudStack Spacing="4" Class="full-width">
         <MudIcon Icon="@Icons.Material.Filled.Error" Color="Color.Error" Size="Size.Large" />
         <MudText Typo="Typo.subtitle2">
-            @Error.Answer
+            @Error.Error
         </MudText>
         <MudText Typo="Typo.body1">
-            @Error.Error
+            Unable to retrieve valid response from the server.
         </MudText>
         <div>
             <MudButton Variant="Variant.Filled" Size="Size.Small" Color="Color.Info"
diff --git a/app/SharedWebComponents/Components/AnswerError.razor.cs b/app/SharedWebComponents/Components/AnswerError.razor.cs
@@ -5,7 +5,7 @@ namespace SharedWebComponents.Components;
 public sealed partial class AnswerError
 {
     [Parameter, EditorRequired] public required string Question { get; set; }
-    [Parameter, EditorRequired] public required ApproachResponse Error { get; set; }
+    [Parameter, EditorRequired] public required ChatAppResponseOrError Error { get; set; }
     [Parameter, EditorRequired] public required EventCallback<string> OnRetryClicked { get; set; }
 
     private async Task OnRetryClickedAsync()
diff --git a/app/SharedWebComponents/Models/AnswerResult.cs b/app/SharedWebComponents/Models/AnswerResult.cs
@@ -4,6 +4,6 @@ namespace SharedWebComponents.Models;
 
 public readonly record struct AnswerResult<TRequest>(
     bool IsSuccessful,
-    ApproachResponse? Response,
+    ChatAppResponseOrError? Response,
     Approach Approach,
     TRequest Request) where TRequest : ApproachRequest;
diff --git a/app/SharedWebComponents/Pages/Chat.razor b/app/SharedWebComponents/Pages/Chat.razor
@@ -52,7 +52,7 @@
                                 <MudBadge Origin="Origin.TopLeft" Overlap="true" Color="Color.Secondary"
                                           Icon="@Icons.Material.Filled.AutoAwesome"
                                           Style="display:inherit">
-                                    <Answer Retort="@answer" FollowupQuestionClicked="@OnAskQuestionAsync" />
+                                    <Answer Retort="@answer.Choices[0]" FollowupQuestionClicked="@OnAskQuestionAsync" />
                                 </MudBadge>
                             }
                         </div>
diff --git a/app/SharedWebComponents/Pages/Chat.razor.cs b/app/SharedWebComponents/Pages/Chat.razor.cs
@@ -9,7 +9,7 @@ public sealed partial class Chat
     private string _lastReferenceQuestion = "";
     private bool _isReceivingResponse = false;
 
-    private readonly Dictionary<UserQuestion, ApproachResponse?> _questionAndAnswerMap = [];
+    private readonly Dictionary<UserQuestion, ChatAppResponseOrError?> _questionAndAnswerMap = [];
 
     [Inject] public required ISessionStorageService SessionStorage { get; set; }
 
@@ -42,13 +42,13 @@ private async Task OnAskClickedAsync()
         try
         {
             var history = _questionAndAnswerMap
-                .Where(x => x.Value is not null)
-                .Select(x => new ChatTurn(x.Key.Question, x.Value!.Answer))
+                .Where(x => x.Value?.Choices is { Length: > 0})
+                .SelectMany(x => new ChatMessage[] { new ChatMessage("user", x.Key.Question), new ChatMessage("assistant", x.Value!.Choices[0].Message.Content) })
                 .ToList();
 
-            history.Add(new ChatTurn(_userQuestion));
+            history.Add(new ChatMessage("user", _userQuestion));
 
-            var request = new ChatRequest([.. history], Settings.Approach, Settings.Overrides);
+            var request = new ChatRequest([.. history], Settings.Overrides);
             var result = await ApiClient.ChatConversationAsync(request);
 
             _questionAndAnswerMap[_currentQuestion] = result.Response;
diff --git a/app/SharedWebComponents/Services/ApiClient.cs b/app/SharedWebComponents/Services/ApiClient.cs
@@ -112,21 +112,19 @@ private async Task<AnswerResult<TRequest>> PostRequestAsync<TRequest>(
 
         if (response.IsSuccessStatusCode)
         {
-            var answer = await response.Content.ReadFromJsonAsync<ApproachResponse>();
+            var answer = await response.Content.ReadFromJsonAsync<ChatAppResponseOrError>();
             return result with
             {
                 IsSuccessful = answer is not null,
-                Response = answer
+                Response = answer,
             };
         }
         else
         {
-            var answer = new ApproachResponse(
-                $"HTTP {(int)response.StatusCode} : {response.ReasonPhrase ?? "☹️ Unknown error..."}",
-                null,
-                [],
-                null,
-                "Unable to retrieve valid response from the server.");
+            var errorTitle = $"HTTP {(int)response.StatusCode} : {response.ReasonPhrase ?? "☹️ Unknown error..."}";
+            var answer = new ChatAppResponseOrError(
+                Array.Empty<ResponseChoice>(),
+                errorTitle);
 
             return result with
             {
diff --git a/app/backend/Extensions/ChatTurnExtensions.cs b/app/backend/Extensions/ChatTurnExtensions.cs
@@ -4,33 +4,33 @@ namespace MinimalApi.Extensions;
 
 internal static class ChatTurnExtensions
 {
-    internal static string GetChatHistoryAsText(
-        this ChatTurn[] history, bool includeLastTurn = true, int approximateMaxTokens = 1_000)
-    {
-        var historyTextResult = string.Empty;
-        var skip = includeLastTurn ? 0 : 1;
+    //internal static string GetChatHistoryAsText(
+    //    this ChatMessage[] history, bool includeLastTurn = true, int approximateMaxTokens = 1_000)
+    //{
+    //    var historyTextResult = string.Empty;
+    //    var skip = includeLastTurn ? 0 : 1;
 
-        foreach (var turn in history.SkipLast(skip).Reverse())
-        {
-            var historyText = $"user: {turn.User}";
+    //    foreach (var turn in history.SkipLast(skip).Reverse())
+    //    {
+    //        var historyText = $"user: {turn.User}";
 
-            if (turn.Bot is not null)
-            {
-                historyText += $"""
-                    <|im_start|>assistant
-                    {turn.Bot}
-                    <|im_end|>
-                    """;
-            }
+    //        if (turn.Content is not null)
+    //        {
+    //            historyText += $"""
+    //                <|im_start|>assistant
+    //                {turn.Content}
+    //                <|im_end|>
+    //                """;
+    //        }
 
-            historyTextResult = historyText + historyTextResult;
+    //        historyTextResult = historyText + historyTextResult;
 
-            if (historyTextResult.Length > approximateMaxTokens * 4)
-            {
-                return historyTextResult;
-            }
-        }
+    //        if (historyTextResult.Length > approximateMaxTokens * 4)
+    //        {
+    //            return historyTextResult;
+    //        }
+    //    }
 
-        return historyTextResult;
-    }
+    //    return historyTextResult;
+    //}
 }
diff --git a/app/backend/Properties/launchSettings.json b/app/backend/Properties/launchSettings.json
@@ -16,7 +16,7 @@
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "dotnetRunMessages": true,
-      "applicationUrl": "https://localhost:7181;http://localhost:5167"
+      "applicationUrl": "https://localhost:7181"
     },
     "Docker": {
       "commandName": "Docker",
diff --git a/app/backend/Services/ReadRetrieveReadChatService.cs b/app/backend/Services/ReadRetrieveReadChatService.cs
@@ -56,8 +56,8 @@ public ReadRetrieveReadChatService(
         _tokenCredential = tokenCredential;
     }
 
-    public async Task<ApproachResponse> ReplyAsync(
-        ChatTurn[] history,
+    public async Task<ChatAppResponse> ReplyAsync(
+        ChatMessage[] history,
         RequestOverrides? overrides,
         CancellationToken cancellationToken = default)
     {
@@ -69,9 +69,11 @@ public async Task<ApproachResponse> ReplyAsync(
         var chat = _kernel.GetRequiredService<IChatCompletionService>();
         var embedding = _kernel.GetRequiredService<ITextEmbeddingGenerationService>();
         float[]? embeddings = null;
-        var question = history.LastOrDefault()?.User is { } userQuestion
+        var question = history.LastOrDefault(m => m.IsUser)?.Content is { } userQuestion
             ? userQuestion
             : throw new InvalidOperationException("Use question is null");
+
+        string[]? followUpQuestionList = null;
         if (overrides?.RetrievalMode != RetrievalMode.Text && embedding is not null)
         {
             embeddings = (await embedding.GenerateEmbeddingAsync(question, cancellationToken: cancellationToken)).ToArray();
@@ -126,12 +128,15 @@ standard plan AND dental AND employee benefit.
             "You are a system assistant who helps the company employees with their questions. Be brief in your answers");
 
         // add chat history
-        foreach (var turn in history)
+        foreach (var message in history)
         {
-            answerChat.AddUserMessage(turn.User);
-            if (turn.Bot is { } botMessage)
+            if (message.IsUser)
+            {
+                answerChat.AddUserMessage(message.Content);
+            }
+            else
             {
-                answerChat.AddAssistantMessage(botMessage);
+                answerChat.AddAssistantMessage(message.Content);
             }
         }
 
@@ -215,17 +220,28 @@ You answer needs to be a json object with the following format.
 
             var followUpQuestionsJson = followUpQuestions.Content ?? throw new InvalidOperationException("Failed to get search query");
             var followUpQuestionsObject = JsonSerializer.Deserialize<JsonElement>(followUpQuestionsJson);
-            var followUpQuestionsList = followUpQuestionsObject.EnumerateArray().Select(x => x.GetString()).ToList();
+            var followUpQuestionsList = followUpQuestionsObject.EnumerateArray().Select(x => x.GetString()!).ToList();
             foreach (var followUpQuestion in followUpQuestionsList)
             {
                 ans += $" <<{followUpQuestion}>> ";
             }
+
+            followUpQuestionList = followUpQuestionsList.ToArray();
         }
-        return new ApproachResponse(
-            DataPoints: documentContentList,
-            Images: images,
-            Answer: ans,
-            Thoughts: thoughts,
+
+        var responseMessage = new ResponseMessage("assistant", ans);
+        var responseContext = new ResponseContext(
+            DataPointsContent: documentContentList.Select(x => new SupportingContentRecord(x.Title, x.Content)).ToArray(),
+            DataPointsImages: images?.Select(x => new SupportingImageRecord(x.Title, x.Url)).ToArray(),
+            FollowupQuestions: followUpQuestionList ?? Array.Empty<string>(),
+            Thoughts: new[] { new Thoughts("Thoughts", thoughts) });
+
+        var choice = new ResponseChoice(
+            Index: 0,
+            Message: responseMessage,
+            Context: responseContext,
             CitationBaseUrl: _configuration.ToCitationBaseUrl());
+
+        return new ChatAppResponse(new[] { choice });
     }
 }
diff --git a/app/shared/Shared/Models/Approach.cs b/app/shared/Shared/Models/Approach.cs
@@ -6,5 +6,5 @@ public enum Approach
 {
     RetrieveThenRead,
     ReadRetrieveRead,
-    ReadDecomposeAsk
+    ReadDecomposeAsk,
 };
diff --git a/app/shared/Shared/Models/ApproachResponse.cs b/app/shared/Shared/Models/ApproachResponse.cs
diff --git a/app/shared/Shared/Models/ChatMessage.cs b/app/shared/Shared/Models/ChatMessage.cs
@@ -0,0 +1,12 @@
+﻿// Copyright (c) Microsoft. All rights reserved.
+
+using System.Text.Json.Serialization;
+
+namespace Shared.Models;
+
+public record ChatMessage(
+    [property:JsonPropertyName("role")] string Role,
+    [property: JsonPropertyName("content")] string Content)
+{
+    public bool IsUser => Role == "user";
+}
diff --git a/app/shared/Shared/Models/ChatRequest.cs b/app/shared/Shared/Models/ChatRequest.cs
@@ -1,11 +1,13 @@
 ﻿// Copyright (c) Microsoft. All rights reserved.
 
+using System.Text.Json.Serialization;
+
 namespace Shared.Models;
 
 public record class ChatRequest(
-    ChatTurn[] History,
-    Approach Approach,
-    RequestOverrides? Overrides = null) : ApproachRequest(Approach)
+    [property: JsonPropertyName("messages")] ChatMessage[] History,
+    [property: JsonPropertyName("overrides")] RequestOverrides? Overrides
+    ) : ApproachRequest(Approach.RetrieveThenRead)
 {
-    public string? LastUserQuestion => History?.LastOrDefault()?.User;
+    public string? LastUserQuestion => History?.Last(m => m.Role == "user")?.Content;
 }
diff --git a/app/shared/Shared/Models/ChatTurn.cs b/app/shared/Shared/Models/ChatTurn.cs
diff --git a/app/shared/Shared/Models/RequestOverrides.cs b/app/shared/Shared/Models/RequestOverrides.cs
diff --git a/app/shared/Shared/Models/ResponseChoice.cs b/app/shared/Shared/Models/ResponseChoice.cs
diff --git a/app/shared/Shared/Models/RetrievalMode.cs b/app/shared/Shared/Models/RetrievalMode.cs
diff --git a/app/tests/MinimalApi.Tests/ReadRetrieveReadChatServiceTest.cs b/app/tests/MinimalApi.Tests/ReadRetrieveReadChatServiceTest.cs

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ namespace SharedWebComponents.Components;`
`4`	`4`
`5`	`5`	`public sealed partial class Answer`
`6`	`6`	`{`
`7`		`- [Parameter, EditorRequired] public required ApproachResponse Retort { get; set; }`
	`7`	`+ [Parameter, EditorRequired] public required ResponseChoice Retort { get; set; }`
`8`	`8`	`[Parameter, EditorRequired] public required EventCallback<string> FollowupQuestionClicked { get; set; }`
`9`	`9`
`10`	`10`	`[Inject] public required IPdfViewer PdfViewer { get; set; }`
`@@ -14,7 +14,7 @@ public sealed partial class Answer`
`14`	`14`	`protected override void OnParametersSet()`
`15`	`15`	`{`
`16`	`16`	`_parsedAnswer = ParseAnswerToHtml(`
`17`		`- Retort.Answer, Retort.CitationBaseUrl);`
	`17`	`+ Retort.Message.Content, Retort.CitationBaseUrl);`
`18`	`18`
`19`	`19`	`base.OnParametersSet();`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace SharedWebComponents.Components;`
`5`	`5`	`public sealed partial class AnswerError`
`6`	`6`	`{`
`7`	`7`	`[Parameter, EditorRequired] public required string Question { get; set; }`
`8`		`- [Parameter, EditorRequired] public required ApproachResponse Error { get; set; }`
	`8`	`+ [Parameter, EditorRequired] public required ChatAppResponseOrError Error { get; set; }`
`9`	`9`	`[Parameter, EditorRequired] public required EventCallback<string> OnRetryClicked { get; set; }`
`10`	`10`
`11`	`11`	`private async Task OnRetryClickedAsync()`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@`
`52`	`52`	`<MudBadge Origin="Origin.TopLeft" Overlap="true" Color="Color.Secondary"`
`53`	`53`	`Icon="@Icons.Material.Filled.AutoAwesome"`
`54`	`54`	`Style="display:inherit">`
`55`		`- <Answer Retort="@answer" FollowupQuestionClicked="@OnAskQuestionAsync" />`
	`55`	`+ <Answer Retort="@answer.Choices[0]" FollowupQuestionClicked="@OnAskQuestionAsync" />`
`56`	`56`	`</MudBadge>`
`57`	`57`	`}`
`58`	`58`	`</div>`
Original file line number	Diff line number	Diff line change
`@@ -112,21 +112,19 @@ private async Task<AnswerResult<TRequest>> PostRequestAsync<TRequest>(`
`112`	`112`
`113`	`113`	`if (response.IsSuccessStatusCode)`
`114`	`114`	`{`
`115`		`- var answer = await response.Content.ReadFromJsonAsync<ApproachResponse>();`
	`115`	`+ var answer = await response.Content.ReadFromJsonAsync<ChatAppResponseOrError>();`
`116`	`116`	`return result with`
`117`	`117`	`{`
`118`	`118`	`IsSuccessful = answer is not null,`
`119`		`- Response = answer`
	`119`	`+ Response = answer,`
`120`	`120`	`};`
`121`	`121`	`}`
`122`	`122`	`else`
`123`	`123`	`{`
`124`		`- var answer = new ApproachResponse(`
`125`		`- $"HTTP {(int)response.StatusCode} : {response.ReasonPhrase ?? "☹️ Unknown error..."}",`
`126`		`- null,`
`127`		`- [],`
`128`		`- null,`
`129`		`- "Unable to retrieve valid response from the server.");`
	`124`	`+ var errorTitle = $"HTTP {(int)response.StatusCode} : {response.ReasonPhrase ?? "☹️ Unknown error..."}";`
	`125`	`+ var answer = new ChatAppResponseOrError(`
	`126`	`+ Array.Empty<ResponseChoice>(),`
	`127`	`+ errorTitle);`
`130`	`128`
`131`	`129`	`return result with`
`132`	`130`	`{`