Merge pull request #116 from hchen2020/master

v  Render router instruction by route record dynamically.

Author: Oceania2018

docs/llm/prompt.md

@@ -1,3 +1,3 @@
 # Prompt Engineering
 
-LLM uses prompt as input, and the model produces different outputs according to the input.
+LLM uses prompt as input, and the model produces different outputs according to the input.

docs/llm/template.md

@@ -1,3 +1,9 @@
 # Template
 
-We can define the prompt as a template, and the template can be changed according to variables, so that a instruction file can be used to generate a dynamic prompt.
+We can define the prompt as a template, and the template can be changed according to variables, so that a instruction file can be used to generate a dynamic prompt.
+`BotSharp` uses [liquid](https://shopify.github.io/liquid/) templates to support various complex dynamic prompt engineering.
+
+`ITemplateRender`
+```csharp
+bool Render(Agent agent, Dictionary<string, object> dict)
+```

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

@@ -4,4 +4,5 @@ public interface IAgentRouting
 {
     Task<Agent> LoadRouter();
     Task<Agent> LoadCurrentAgent();
+    RoutingRecord[] GetRoutingRecords();
 }

src/Infrastructure/BotSharp.Abstraction/Agents/Models/RoutingTable.cs renamed to src/Infrastructure/BotSharp.Abstraction/Agents/Models/RoutingRecord.cs

@@ -2,13 +2,16 @@
 
 namespace BotSharp.Abstraction.Agents.Models;
 
-public class RoutingTable
+public class RoutingRecord
 {
     [JsonPropertyName("agent_id")]
     public string AgentId { get; set; }
 
     [JsonPropertyName("name")]
-    public string AgentName { get; set; }
+    public string Name { get; set; }
+
+    [JsonPropertyName("description")]
+    public string Description { get; set; }
 
     [JsonPropertyName("required")]
     public List<string> RequiredFields { get; set; }
@@ -18,6 +21,6 @@ public class RoutingTable
 
     public override string ToString()
     {
-        return AgentName;
+        return Name;
     }
 }

src/Infrastructure/BotSharp.Abstraction/Templating/ITemplateRender.cs

@@ -0,0 +1,6 @@
+namespace BotSharp.Abstraction.Templating;
+
+public interface ITemplateRender
+{
+    bool Render(Agent agent, Dictionary<string, object> dict);
+}

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

@@ -1,19 +1,19 @@
 using BotSharp.Abstraction.Agents.Models;
-using Fluid;
 
 namespace BotSharp.Core.Agents.Services;
 
 public abstract class AgentHookBase : IAgentHook
 {
     protected Agent _agent;
     public Agent Agent => _agent;
-    private static readonly FluidParser _parser = new FluidParser();
 
-    private readonly IServiceProvider _services;
+    protected readonly IServiceProvider _services;
+    protected readonly AgentSettings _settings;
 
-    public AgentHookBase(IServiceProvider services)
+    public AgentHookBase(IServiceProvider services, AgentSettings settings)
     {
         _services = services;
+        _settings = settings;
     }
 
     public void SetAget(Agent agent)
@@ -28,27 +28,7 @@ public virtual bool OnAgentLoading(ref string id)
 
     public virtual bool OnInstructionLoaded(string template, Dictionary<string, object> dict)
     {
-        if (_parser.TryParse(template, out var t, out var error))
-        {
-            PopulateStateTokens(dict);
-            var context = new TemplateContext(dict);
-            _agent.Instruction = t.Render(context);
-            return true;
-        }
-        else
-        {
-            return false;
-        }
-    }
-
-    private void PopulateStateTokens(Dictionary<string, object> dict)
-    {
-        var stateService = _services.GetRequiredService<IConversationStateService>();
-        var state = stateService.Load();
-        foreach (var t in state)
-        {
-            dict[t.Key] = t.Value;
-        }
+        return true;
     }
 
     public virtual bool OnFunctionsLoaded(ref string functions)

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

@@ -1,5 +1,5 @@
-using BotSharp.Abstraction.Agents;
 using BotSharp.Abstraction.Agents.Models;
+using System.IO;
 
 namespace BotSharp.Core.Agents.Services;
 
@@ -42,4 +42,12 @@ public async Task<Agent> LoadCurrentAgent()
 
         return agent;
     }
+
+    public RoutingRecord[] GetRoutingRecords()
+    {
+        var agentSettings = _services.GetRequiredService<AgentSettings>();
+        var dbSettings = _services.GetRequiredService<MyDatabaseSettings>();
+        var filePath = Path.Combine(dbSettings.FileRepository, agentSettings.DataDir, agentSettings.RouterId, "route.json");
+        return JsonSerializer.Deserialize<RoutingRecord[]>(File.ReadAllText(filePath));
+    }
 }

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

@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Core.Templating;
 
 namespace BotSharp.Core.Agents.Services;
 
@@ -15,6 +16,8 @@ public async Task<Agent> LoadAgent(string id)
         }
 
         var agent = await GetAgent(id);
+        var templateDict = new Dictionary<string, object>();
+        PopulateState(templateDict);
 
         // After agent is loaded
         foreach (var hook in hooks)
@@ -23,7 +26,7 @@ public async Task<Agent> LoadAgent(string id)
 
             if (!string.IsNullOrEmpty(agent.Instruction))
             {
-                hook.OnInstructionLoaded(agent.Instruction, new Dictionary<string, object>());
+                hook.OnInstructionLoaded(agent.Instruction, templateDict);
             }
 
             if (!string.IsNullOrEmpty(agent.Functions))
@@ -41,8 +44,22 @@ public async Task<Agent> LoadAgent(string id)
             hook.OnAgentLoaded(agent);
         }
 
+        // render liquid template
+        var render = _services.GetRequiredService<TemplateRender>();
+        render.Render(agent, templateDict);
+
         _logger.LogInformation($"Loaded agent {agent}.");
 
         return agent;
     }
+
+    private void PopulateState(Dictionary<string, object> dict)
+    {
+        var stateService = _services.GetRequiredService<IConversationStateService>();
+        var state = stateService.Load();
+        foreach (var t in state)
+        {
+            dict[t.Key] = t.Value;
+        }
+    }
 }

src/Infrastructure/BotSharp.Core/BotSharpServiceCollectionExtensions.cs

@@ -1,5 +1,7 @@
 using BotSharp.Abstraction.Functions;
 using BotSharp.Core.Functions;
+using BotSharp.Core.Hooks;
+using BotSharp.Core.Templating;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.Configuration;
 
@@ -35,10 +37,18 @@ public static IServiceCollection AddBotSharp(this IServiceCollection services, I
 
         RegisterPlugins(services, config);
 
+        // Register template render
+        services.AddSingleton<TemplateRender>();
+
+        // Register router
         services.AddScoped<IAgentRouting, AgentRouter>();
 
+        // Register function callback
         services.AddScoped<IFunctionCallback, RouteToAgentFn>();
 
+        // Register Hooks
+        services.AddScoped<IAgentHook, AgentHook>();
+
         return services;
     }
 

src/Infrastructure/BotSharp.Core/Functions/RouteToAgentFn.cs

@@ -50,9 +50,9 @@ public async Task<bool> Execute(RoleDialogModel message)
     private bool HasMissingRequiredField(RoleDialogModel message, out string agentId)
     {
         var args = JsonSerializer.Deserialize<RoutingArgs>(message.FunctionArgs);
-
-        var routes = GetRoutingTable();
-        var routingRule = routes.FirstOrDefault(x => x.AgentName.ToLower() == args.AgentName.ToLower());
+        var router = _services.GetRequiredService<IAgentRouting>();
+        var records = router.GetRoutingRecords();
+        var routingRule = records.FirstOrDefault(x => x.Name.ToLower() == args.AgentName.ToLower());
 
         if (routingRule == null)
         {
@@ -93,12 +93,4 @@ private bool HasMissingRequiredField(RoleDialogModel message, out string agentId
 
         return hasMissingField;
     }
-
-    private RoutingTable[] GetRoutingTable()
-    {
-        var agentSettings = _services.GetRequiredService<AgentSettings>();
-        var dbSettings = _services.GetRequiredService<MyDatabaseSettings>();
-        var filePath = Path.Combine(dbSettings.FileRepository, agentSettings.DataDir, agentSettings.RouterId, "route.json");
-        return JsonSerializer.Deserialize<RoutingTable[]>(File.ReadAllText(filePath));
-    }
 }

src/Infrastructure/BotSharp.Core/Hooks/AgentHook.cs

@@ -0,0 +1,16 @@
+namespace BotSharp.Core.Hooks;
+
+public class AgentHook : AgentHookBase
+{
+    public AgentHook(IServiceProvider services, AgentSettings settings)
+        : base(services, settings)
+    {
+    }
+
+    public override bool OnInstructionLoaded(string template, Dictionary<string, object> dict)
+    {
+        var router = _services.GetRequiredService<IAgentRouting>();
+        dict["routing_records"] = router.GetRoutingRecords();
+        return true;
+    }
+}

src/Infrastructure/BotSharp.Core/Templating/TemplateRender.cs

@@ -0,0 +1,39 @@
+using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Abstraction.Templating;
+using Fluid;
+using Microsoft.Extensions.Options;
+
+namespace BotSharp.Core.Templating;
+
+public class TemplateRender : ITemplateRender
+{
+    private readonly IServiceProvider _services;
+    private readonly ILogger _logger;
+    private static readonly FluidParser _parser = new FluidParser();
+    private TemplateOptions _options;
+
+    public TemplateRender(IServiceProvider services, ILogger<TemplateRender> logger)
+    {
+        _services = services;
+        _logger = logger;
+        _options = new TemplateOptions();
+        _options.MemberAccessStrategy.MemberNameStrategy = MemberNameStrategies.CamelCase;
+        _options.MemberAccessStrategy.Register<RoutingRecord>();
+    }
+
+    public bool Render(Agent agent, Dictionary<string, object> dict)
+    {
+        var template = agent.Instruction;
+        if (_parser.TryParse(template, out var t, out var error))
+        {
+            var context = new TemplateContext(dict, _options);
+            agent.Instruction = t.Render(context);
+            return true;
+        }
+        else
+        {
+
+            return false;
+        }
+    }
+}