Merge branch 'master' of https://github.com/hchen2020/BotSharp

Author: hchen2020

README.md

@@ -15,9 +15,7 @@
 
 It's written in C# running on .Net Core that is full cross-platform framework, the plug-in and pipeline flow execution design is adopted to completely decouple the plug-ins. C# is a enterprise grade programming language which is widely used to code business logic in information management related system. More friendly to corporate developers. BotSharp adopts machine learning algrithm in C# directly. That will facilitate the feature of the typed language C#, and be more easier when refactoring code in system scope. 
 
-Why we do this? Because we all know Python is not friendly programming language for enterprise developers, it's not only because it's low performance but also it's a type weak language, it will be a disaster if you use Python to build your bussiness system.
-
-BotSharp is in accordance with components principle strictly, decouples every part that is needed in the platform builder. So you can choose different UI/UX, or pick up a different NLP Tagger, or select a more advanced algorithm to do NER task. They are all modulized based on unified interfaces.
+**BotSharp** is in accordance with components principle strictly, decouples every part that is needed in the platform builder. So you can choose different UI/UX, or pick up a different LLM providers. They are all modulized based on unified interfaces. **BotSharp** provides an advanced Agent abstraction layer to efficiently manage complex application scenarios in enterprises, allowing enterprise developers to efficiently integrate AI into business systems.
 
 ### Some Features
 

src/Infrastructure/BotSharp.Abstraction/Agents/Enums/AgentField.cs

@@ -0,0 +1,13 @@
+namespace BotSharp.Abstraction.Agents.Enums;
+
+public enum AgentField
+{
+    All = 1,
+    Name,
+    Description,
+    IsPublic,
+    Instruction,
+    Function,
+    Template,
+    Response
+}

src/Infrastructure/BotSharp.Abstraction/Agents/IAgentService.cs

@@ -17,7 +17,7 @@ public interface IAgentService
 
     Task<Agent> GetAgent(string id);
     Task<bool> DeleteAgent(string id);
-    Task UpdateAgent(Agent agent);
+    Task UpdateAgent(Agent agent, AgentField updateField);
     Task UpdateAgentFromFile(string id);
     string GetDataDir();
     string GetAgentDataDir(string agentId);

src/Infrastructure/BotSharp.Abstraction/Repositories/IBotSharpRepository.cs

@@ -1,3 +1,4 @@
+using BotSharp.Abstraction.Agents.Enums;
 using BotSharp.Abstraction.Routing.Models;
 using BotSharp.Abstraction.Users.Models;
 
@@ -15,27 +16,32 @@ public interface IBotSharpRepository
     int Transaction<TTableInterface>(Action action);
     void Add<TTableInterface>(object entity);
 
+    #region User
     User GetUserByEmail(string email);
     void CreateUser(User user);
-    void UpdateAgent(Agent agent);
-
-    List<RoutingItem> CreateRoutingItems(List<RoutingItem> routingItems);
-    List<RoutingProfile> CreateRoutingProfiles(List<RoutingProfile> profiles);
-    void DeleteRoutingItems();
-    void DeleteRoutingProfiles();
+    #endregion
 
+    #region Agent
+    void UpdateAgent(Agent agent, AgentField field);
     Agent GetAgent(string agentId);
     List<string> GetAgentResponses(string agentId, string prefix, string intent);
+    string GetAgentTemplate(string agentId, string templateName);
+    #endregion
 
+    #region Conversation
     void CreateNewConversation(Conversation conversation);
     string GetConversationDialog(string conversationId);
     void UpdateConversationDialog(string conversationId, string dialogs);
-
     List<StateKeyValue> GetConversationStates(string conversationId);
     void UpdateConversationStates(string conversationId, List<StateKeyValue> states);
-
     Conversation GetConversation(string conversationId);
     List<Conversation> GetConversations(string userId);
+    #endregion
 
-    string GetAgentTemplate(string agentId, string templateName);
+    #region Routing
+    List<RoutingItem> CreateRoutingItems(List<RoutingItem> routingItems);
+    List<RoutingProfile> CreateRoutingProfiles(List<RoutingProfile> profiles);
+    void DeleteRoutingItems();
+    void DeleteRoutingProfiles();
+    #endregion    
 }

src/Infrastructure/BotSharp.Abstraction/Using.cs

@@ -5,4 +5,5 @@
 global using System.Threading.Tasks;
 global using System.ComponentModel.DataAnnotations;
 global using BotSharp.Abstraction.Agents.Models;
-global using BotSharp.Abstraction.Conversations.Models;
+global using BotSharp.Abstraction.Conversations.Models;
+global using BotSharp.Abstraction.Agents.Enums;

src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.CreateAgent.cs

@@ -8,11 +8,9 @@ public partial class AgentService
 {
     public async Task<Agent> CreateAgent(Agent agent)
     {
-        var db = _services.GetRequiredService<IBotSharpRepository>();
-
-        var agentRecord = (from a in db.Agents
-                     join ua in db.UserAgents on a.Id equals ua.AgentId
-                     join u in db.Users on ua.UserId equals u.Id
+        var agentRecord = (from a in _db.Agents
+                     join ua in _db.UserAgents on a.Id equals ua.AgentId
+                     join u in _db.Users on ua.UserId equals u.Id
                      where u.ExternalId == _user.Id && a.Name == agent.Name
                      select a).FirstOrDefault();
 
@@ -43,7 +41,7 @@ join u in db.Users on ua.UserId equals u.Id
                        .SetResponses(foundAgent.Responses);
         }
 
-        var user = db.Users.FirstOrDefault(x => x.ExternalId == _user.Id);
+        var user = _db.Users.FirstOrDefault(x => x.ExternalId == _user.Id);
         var userAgentRecord = new UserAgent
         {
             Id = Guid.NewGuid().ToString(),
@@ -53,10 +51,10 @@ join u in db.Users on ua.UserId equals u.Id
             UpdatedTime = DateTime.UtcNow
         };
 
-        db.Transaction<IBotSharpTable>(delegate
+        _db.Transaction<IBotSharpTable>(delegate
         {
-            db.Add<IBotSharpTable>(agentRecord);
-            db.Add<IBotSharpTable>(userAgentRecord);
+            _db.Add<IBotSharpTable>(agentRecord);
+            _db.Add<IBotSharpTable>(userAgentRecord);
         });
 
         return agentRecord;
@@ -86,7 +84,7 @@ private Agent FetchAgentFileByName(string agentName, string filePath)
 
     private string FetchInstructionFromFile(string fileDir)
     {
-        var file = Path.Combine(fileDir, "instruction.liquid");
+        var file = Path.Combine(fileDir, $"instruction.{_agentSettings.TemplateFormat}");
         if (!File.Exists(file)) return null;
 
         var instruction = File.ReadAllText(file);
@@ -102,7 +100,7 @@ private List<AgentTemplate> FetchTemplatesFromFile(string fileDir)
             var splits = fileName.ToLower().Split('.');
             var name = splits[0];
             var extension = splits[1];
-            if (name != "instruction" && extension == "liquid")
+            if (name != "instruction" && extension == _agentSettings.TemplateFormat)
             {
                 var content = File.ReadAllText(file);
                 templates.Add(new AgentTemplate(name, content));

src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.GetAgents.cs

@@ -7,10 +7,9 @@ public partial class AgentService
 {
     public async Task<List<Agent>> GetAgents()
     {
-        var db = _services.GetRequiredService<IBotSharpRepository>();
-        var query = from a in db.Agents
-                    join ua in db.UserAgents on a.Id equals ua.AgentId
-                    join u in db.Users on ua.UserId equals u.Id
+        var query = from a in _db.Agents
+                    join ua in _db.UserAgents on a.Id equals ua.AgentId
+                    join u in _db.Users on ua.UserId equals u.Id
                     where ua.UserId == _user.Id || u.ExternalId == _user.Id || a.IsPublic
                     select a;
         return query.ToList();
@@ -21,8 +20,7 @@ join u in db.Users on ua.UserId equals u.Id
 #endif
     public async Task<Agent> GetAgent(string id)
     {
-        var db = _services.GetRequiredService<IBotSharpRepository>();
-        var profile = db.GetAgent(id);
+        var profile = _db.GetAgent(id);
 
         var instructionFile = profile?.Instruction;
         if (instructionFile != null)

src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.UpdateAgent.cs

@@ -6,44 +6,38 @@ namespace BotSharp.Core.Agents.Services;
 
 public partial class AgentService
 {
-    public async Task UpdateAgent(Agent agent)
+    public async Task UpdateAgent(Agent agent, AgentField updateField)
     {
-        var db = _services.GetRequiredService<IBotSharpRepository>();
-
-        var record = (from a in db.Agents
-                      join ua in db.UserAgents on a.Id equals ua.AgentId
-                      join u in db.Users on ua.UserId equals u.Id
-                      where (ua.UserId == _user.Id || u.ExternalId == _user.Id) &&
-                        a.Id == agent.Id
-                      select a).FirstOrDefault();
+        if (agent == null || string.IsNullOrEmpty(agent.Id)) return;
 
+        var record = FindAgent(agent.Id);
         if (record == null) return;
 
-        record.Name = agent.Name;
-
-        if (!string.IsNullOrEmpty(agent.Description))
-            record.Description = agent.Description;
-
-        if (!string.IsNullOrEmpty(agent.Instruction))
-            record.Instruction = agent.Instruction;
-
-        if (!agent.Templates.IsNullOrEmpty())
-            record.Templates = agent.Templates;
-
-        if (!agent.Functions.IsNullOrEmpty())
-            record.Functions = agent.Functions;
+        record.Name = agent.Name ?? string.Empty;
+        record.Description = agent.Description ?? string.Empty;
+        record.Instruction = agent.Instruction ?? string.Empty;
+        record.Functions = agent.Functions ?? new List<string>();
+        record.Templates = agent.Templates ?? new List<AgentTemplate>();
+        record.Responses = agent.Responses ?? new List<AgentResponse>();
 
-        if (!agent.Responses.IsNullOrEmpty())
-            record.Responses = agent.Responses;
-
-        db.UpdateAgent(record);
+        _db.UpdateAgent(record, updateField);
         await Task.CompletedTask;
     }
 
+    private Agent FindAgent(string agentId)
+    {
+        var record = (from a in _db.Agents
+                      join ua in _db.UserAgents on a.Id equals ua.AgentId
+                      join u in _db.Users on ua.UserId equals u.Id
+                      where (ua.UserId == _user.Id || u.ExternalId == _user.Id) &&
+                        a.Id == agentId
+                      select a).FirstOrDefault();
+        return record;
+    }
+
     public async Task UpdateAgentFromFile(string id)
     {
-        var db = _services.GetRequiredService<IBotSharpRepository>();
-        var agent = db.Agents?.FirstOrDefault(x => x.Id == id);
+        var agent = _db.Agents?.FirstOrDefault(x => x.Id == id);
 
         if (agent == null) return;
 
@@ -64,10 +58,9 @@ public async Task UpdateAgentFromFile(string id)
                        .SetFunctions(foundAgent.Functions)
                        .SetResponses(foundAgent.Responses);
 
-            db.UpdateAgent(clonedAgent);
+            _db.UpdateAgent(clonedAgent, AgentField.All);
         }
 
-
         await Task.CompletedTask;
     }
 

src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.cs

@@ -1,26 +1,28 @@
 using BotSharp.Abstraction.Repositories;
-using Microsoft.Extensions.Logging;
 using System.IO;
 
 namespace BotSharp.Core.Agents.Services;
 
 public partial class AgentService : IAgentService
 {
     private readonly IServiceProvider _services;
+    private readonly IBotSharpRepository _db;
     private readonly ILogger _logger;
     private readonly IUserIdentity _user;
-    private readonly AgentSettings _settings;
+    private readonly AgentSettings _agentSettings;
     private readonly JsonSerializerOptions _options;
 
-    public AgentService(IServiceProvider services, 
+    public AgentService(IServiceProvider services,
+        IBotSharpRepository db,
         ILogger<AgentService> logger, 
         IUserIdentity user, 
-        AgentSettings settings)
+        AgentSettings agentSettings)
     {
         _services = services;
+        _db = db;
         _logger = logger;
         _user = user;
-        _settings = settings;
+        _agentSettings = agentSettings;
         _options = new JsonSerializerOptions
         {
             PropertyNameCaseInsensitive = true,
@@ -38,7 +40,7 @@ public string GetDataDir()
     public string GetAgentDataDir(string agentId)
     {
         var dbSettings = _services.GetRequiredService<BotSharpDatabaseSettings>();
-        var dir = Path.Combine(dbSettings.FileRepository, _settings.DataDir, agentId);
+        var dir = Path.Combine(dbSettings.FileRepository, _agentSettings.DataDir, agentId);
         if (!Directory.Exists(dir))
         {
             Directory.CreateDirectory(dir);