🔀 Add system parameter to ERNIEBotChatCompletion (#76)

Add a new system parameter to the ERNIEBotChatCompletion class in order to enhance the chat completion functionality.
custouch · Nov 28, 2023 · 2342c77 · 2342c77
1 parent 17070d3
commit 2342c77
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 10 deletions.
diff --git a/samples/SK-ERNIE-Bot.Sample/Controllers/ApiController.cs b/samples/SK-ERNIE-Bot.Sample/Controllers/ApiController.cs
@@ -114,5 +114,25 @@ public async Task<IActionResult> SemanticPlugin([FromBody] UserInput input)
             var result = await _kernel.RunAsync(input.Text, translateFunc);
             return Ok(result.GetValue<string>());
         }
+
+        [HttpPost("chat_with_system")]
+        public async Task<IActionResult> ChatWithSystemAsync([FromBody] UserInput input, CancellationToken cancellationToken)
+        {
+            if (string.IsNullOrWhiteSpace(input.Text))
+            {
+                return NoContent();
+            }
+
+            var chat = _kernel.GetService<IChatCompletion>();
+
+            var history = chat.CreateNewChat($"你是一个友善的AI助手。你的名字叫做Alice，今天是{DateTime.Today}.");
+
+            history.AddUserMessage(input.Text);
+
+            var result = await chat.GetChatCompletionsAsync(history, null, cancellationToken);
+
+            var text = await result.First().GetChatMessageAsync();
+            return Ok(text.Content);
+        }
     }
 }
diff --git a/src/ERNIE-Bot.SDK/Models/ChatRequest.cs b/src/ERNIE-Bot.SDK/Models/ChatRequest.cs
@@ -4,6 +4,9 @@ namespace ERNIE_Bot.SDK.Models
 {
     public class ChatRequest
     {
+        [JsonPropertyName("system")]
+        public string? System { get; set; }
+
         [JsonPropertyName("messages")]
         public List<Message> Messages { get; set; } = new List<Message>();
 

diff --git a/src/ERNIE-Bot.SemanticKernel/ERNIEBotChatCompletion.cs b/src/ERNIE-Bot.SemanticKernel/ERNIEBotChatCompletion.cs
@@ -28,15 +28,15 @@ public ChatHistory CreateNewChat(string? instructions = null)
 
         if (instructions != null)
         {
-            history.AddAssistantMessage(instructions);
+            history.AddSystemMessage(instructions);
         }
 
         return history;
     }
 
     public async Task<IReadOnlyList<IChatResult>> GetChatCompletionsAsync(ChatHistory chat, AIRequestSettings? requestSettings = null, CancellationToken cancellationToken = default)
     {
-        var messages = ChatHistoryToMessages(chat);
+        var messages = ChatHistoryToMessages(chat, out var system);
         requestSettings ??= new AIRequestSettings();
 
         var settings = ERNIEBotAIRequestSettings.FromRequestSettings(requestSettings);
@@ -45,6 +45,7 @@ public async Task<IReadOnlyList<IChatResult>> GetChatCompletionsAsync(ChatHistor
                                                              settings.Temperature,
                                                              settings.TopP,
                                                              settings.PenaltyScore,
+                                                             system,
                                                              cancellationToken
                                                              );
         return new List<IChatResult>() { new ERNIEBotChatResult(result) };
@@ -61,6 +62,7 @@ public async Task<IReadOnlyList<ITextResult>> GetCompletionsAsync(string text, A
                                                     settings.Temperature,
                                                     settings.TopP,
                                                     settings.PenaltyScore,
+                                                    null,
                                                     cancellationToken
                                                     );
 
@@ -69,7 +71,8 @@ public async Task<IReadOnlyList<ITextResult>> GetCompletionsAsync(string text, A
 
     public async IAsyncEnumerable<IChatStreamingResult> GetStreamingChatCompletionsAsync(ChatHistory chat, AIRequestSettings? requestSettings = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
     {
-        var messages = ChatHistoryToMessages(chat);
+        var messages = ChatHistoryToMessages(chat, out var system);
+
         requestSettings ??= new AIRequestSettings();
 
         var settings = ERNIEBotAIRequestSettings.FromRequestSettings(requestSettings);
@@ -78,6 +81,7 @@ public async IAsyncEnumerable<IChatStreamingResult> GetStreamingChatCompletionsA
                                                      settings.Temperature,
                                                      settings.TopP,
                                                      settings.PenaltyScore,
+                                                     system,
                                                      cancellationToken
                                                     );
 
@@ -96,6 +100,7 @@ public async IAsyncEnumerable<ITextStreamingResult> GetStreamingCompletionsAsync
                                                      settings.Temperature,
                                                      settings.TopP,
                                                      settings.PenaltyScore,
+                                                     null,
                                                      cancellationToken
                                                      );
 
@@ -115,13 +120,23 @@ private List<Message> StringToMessages(string text)
         };
     }
 
-    private List<Message> ChatHistoryToMessages(ChatHistory chatHistory)
+    private List<Message> ChatHistoryToMessages(ChatHistory chatHistory, out string? system)
     {
-        return chatHistory.Select(m => new Message()
+        if (chatHistory.First().Role == AuthorRole.System)
+        {
+            system = chatHistory.First().Content;
+        }
+        else
         {
-            Role = AuthorRoleToMessageRole(m.Role),
-            Content = m.Content
-        }).ToList();
+            system = null;
+        }
+        return chatHistory
+            .Where(_ => _.Role != AuthorRole.System)
+            .Select(m => new Message()
+            {
+                Role = AuthorRoleToMessageRole(m.Role),
+                Content = m.Content
+            }).ToList();
     }
 
     private string AuthorRoleToMessageRole(AuthorRole role)
@@ -131,7 +146,7 @@ private string AuthorRoleToMessageRole(AuthorRole role)
         return MessageRole.User;
     }
 
-    protected virtual async Task<ChatResponse> InternalCompletionsAsync(List<Message> messages, float? temperature, float? topP, float? penaltyScore, CancellationToken cancellationToken)
+    protected virtual async Task<ChatResponse> InternalCompletionsAsync(List<Message> messages, float? temperature, float? topP, float? penaltyScore, string? system, CancellationToken cancellationToken)
     {
         try
         {
@@ -141,6 +156,7 @@ protected virtual async Task<ChatResponse> InternalCompletionsAsync(List<Message
                 Temperature = temperature,
                 TopP = topP,
                 PenaltyScore = penaltyScore,
+                System = system,
             }, _modelEndpoint, cancellationToken);
         }
         catch (ERNIEBotException ex)
@@ -149,7 +165,7 @@ protected virtual async Task<ChatResponse> InternalCompletionsAsync(List<Message
         }
     }
 
-    protected virtual IAsyncEnumerable<ChatResponse> InternalCompletionsStreamAsync(List<Message> messages, float? temperature, float? topP, float? penaltyScore, CancellationToken cancellationToken)
+    protected virtual IAsyncEnumerable<ChatResponse> InternalCompletionsStreamAsync(List<Message> messages, float? temperature, float? topP, float? penaltyScore, string? system, CancellationToken cancellationToken)
     {
         try
         {
@@ -159,6 +175,7 @@ protected virtual IAsyncEnumerable<ChatResponse> InternalCompletionsStreamAsync(
                 Temperature = temperature,
                 TopP = topP,
                 PenaltyScore = penaltyScore,
+                System = system,
             }, _modelEndpoint, cancellationToken);
         }
         catch (ERNIEBotException ex)