save rich content

Author: Jicheng Lu

src/Infrastructure/BotSharp.Abstraction/Loggers/Enums/ContentLogSource.cs

@@ -0,0 +1,9 @@
+namespace BotSharp.Abstraction.Loggers.Enums;
+
+public static class ContentLogSource
+{
+    public const string UserInput = "user input";
+    public const string Prompt = "prompt";
+    public const string FunctionCall = "function call";
+    public const string AgentResponse = "agent response";
+}

src/Infrastructure/BotSharp.Abstraction/Loggers/Models/ConversationContentLogModel.cs

@@ -4,13 +4,19 @@ public class ConversationContentLogModel
 {
     [JsonPropertyName("conversation_id")]
     public string ConversationId { get; set; }
+
     [JsonPropertyName("message_id")]
     public string MessageId { get; set; }
+
     [JsonPropertyName("name")]
     public string? Name { get; set; }
+
     [JsonPropertyName("role")]
     public string Role { get; set; }
 
+    [JsonPropertyName("source")]
+    public string Source { get; set; }
+
     [JsonPropertyName("content")]
     public string Content { get; set; }
 

src/Plugins/BotSharp.Plugin.ChatHub/Hooks/StreamingLogHook.cs

@@ -1,11 +1,11 @@
 using BotSharp.Abstraction.Agents.Models;
 using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Loggers;
+using BotSharp.Abstraction.Loggers.Enums;
 using BotSharp.Abstraction.Loggers.Models;
 using BotSharp.Abstraction.Repositories;
-using BotSharp.Abstraction.Repositories.Filters;
-using BotSharp.Abstraction.Routing.Settings;
 using Microsoft.AspNetCore.SignalR;
+using Serilog;
 
 namespace BotSharp.Plugin.ChatHub.Hooks;
 
@@ -37,11 +37,13 @@ public StreamingLogHook(
             AllowTrailingCommas = true
         };
     }
+
     public override async Task OnMessageReceived(RoleDialogModel message)
     {
         var conversationId = _state.GetConversationId();
         var log = $"MessageId: {message.MessageId} ==>\r\n{message.Role}: {message.Content}";
-        await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated", BuildContentLog(conversationId, _user.UserName, log, message));
+        await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated",
+            BuildContentLog(conversationId, _user.UserName, log, ContentLogSource.UserInput, message));
     }
 
     public async Task BeforeGenerating(Agent agent, List<RoleDialogModel> conversations)
@@ -62,7 +64,8 @@ public override async Task OnFunctionExecuted(RoleDialogModel message)
         var agent = await agentService.LoadAgent(message.CurrentAgentId);
         var log = $"[{agent?.Name}]: {message.FunctionName}({message.FunctionArgs}) => {message.Content}";
         log += $"\r\n<== MessageId: {message.MessageId}";
-        await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated", BuildContentLog(conversationId, agent?.Name, log, message));
+        await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated",
+            BuildContentLog(conversationId, agent?.Name, log, ContentLogSource.FunctionCall, message));
     }
 
     /// <summary>
@@ -78,30 +81,25 @@ public async Task AfterGenerated(RoleDialogModel message, TokenStatsModel tokenS
         var agentService = _services.GetRequiredService<IAgentService>();
         var conversationId = _state.GetConversationId();
         var agent = await agentService.LoadAgent(message.CurrentAgentId);
+        var logSource = string.Empty;
 
         // Log routing output
         try
         {
             var inst = message.Content.JsonContent<FunctionCallFromLlm>();
-            await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated", BuildContentLog(conversationId, agent?.Name, message.Content, message));
+            logSource = ContentLogSource.AgentResponse;
+            await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated",
+                BuildContentLog(conversationId, agent?.Name, message.Content, logSource, message));
         }
         catch
         {
             // ignore
         }
 
-        string log;
-        if (message.Role == AgentRole.Function)
-        {
-            log = $"[{agent?.Name}]: {message.FunctionName}({message.FunctionArgs}) => {message.Content}";
-            log += $"\r\n<== MessageId: {message.MessageId}";
-        }
-        else
-        {
-            log = tokenStats.Prompt;
-        }
-
-        await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated", BuildContentLog(conversationId, agent?.Name, log, message));
+        var log = tokenStats.Prompt;
+        logSource = ContentLogSource.Prompt;
+        await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated",
+            BuildContentLog(conversationId, agent?.Name, log, logSource, message));
     }
 
     /// <summary>
@@ -127,19 +125,21 @@ public override async Task OnResponseGenerated(RoleDialogModel message)
                 log += $"\r\n{richContent}";
             }
             log += $"\r\n<== MessageId: {message.MessageId}";
-            await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated", BuildContentLog(conv.ConversationId, agent?.Name, log, message));
+            await _chatHub.Clients.User(_user.Id).SendAsync("OnConversationContentLogGenerated",
+                BuildContentLog(conv.ConversationId, agent?.Name, log, ContentLogSource.AgentResponse, message));
         }
     }
 
-    private string BuildContentLog(string conversationId, string? name, string content, RoleDialogModel message)
+    private string BuildContentLog(string conversationId, string? name, string logContent, string logSource, RoleDialogModel message)
     {
         var log = new ConversationContentLogModel
         {
             ConversationId = conversationId,
             MessageId = message.MessageId,
             Name = name,
             Role = message.Role,
-            Content = content,
+            Content = logContent,
+            Source = logSource,
             CreateTime = DateTime.UtcNow
         };
 

src/Plugins/BotSharp.Plugin.MongoStorage/Collections/ConversationContentLogDocument.cs

@@ -6,6 +6,7 @@ public class ConversationContentLogDocument : MongoBase
     public string MessageId { get; set; }
     public string? Name { get; set; }
     public string Role { get; set; }
+    public string Source { get; set; }
     public string Content { get; set; }
     public DateTime CreateTime { get; set; }
 }

src/Plugins/BotSharp.Plugin.MongoStorage/Repository/MongoRepository.Log.cs

@@ -73,6 +73,7 @@ public void SaveConversationContentLog(ConversationContentLogModel log)
             MessageId = messageId,
             Name = log.Name,
             Role = log.Role,
+            Source = log.Source,
             Content = log.Content,
             CreateTime = log.CreateTime
         };
@@ -91,6 +92,7 @@ public List<ConversationContentLogModel> GetConversationContentLogs(string conve
                           MessageId = x.MessageId,
                           Name = x.Name,
                           Role = x.Role,
+                          Source = x.Source,
                           Content = x.Content,
                           CreateTime = x.CreateTime
                       })