Merge pull request #159 from hchen2020/master

Deep-Blue-2013 · web-flow · commit 8dbceb924556 · 2023-09-28T07:07:35.000-05:00
print functions in verbose.
diff --git a/src/Infrastructure/BotSharp.Abstraction/Agents/AgentHookBase.cs b/src/Infrastructure/BotSharp.Abstraction/Agents/AgentHookBase.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Settings;
+using BotSharp.Abstraction.Functions.Models;
 
 namespace BotSharp.Abstraction.Agents;
 
@@ -34,7 +35,7 @@ public virtual bool OnInstructionLoaded(string template, Dictionary<string, obje
         return true;
     }
 
-    public virtual bool OnFunctionsLoaded(ref List<string> functions)
+    public virtual bool OnFunctionsLoaded(ref List<FunctionDef> functions)
     {
         _agent.Functions = functions;
         return true;
diff --git a/src/Infrastructure/BotSharp.Abstraction/Agents/IAgentHook.cs b/src/Infrastructure/BotSharp.Abstraction/Agents/IAgentHook.cs
@@ -1,3 +1,5 @@
+using BotSharp.Abstraction.Functions.Models;
+
 namespace BotSharp.Abstraction.Agents;
 
 public interface IAgentHook
@@ -15,7 +17,7 @@ public interface IAgentHook
 
     bool OnInstructionLoaded(string template, Dictionary<string, object> dict);
 
-    bool OnFunctionsLoaded(ref List<string> functions);
+    bool OnFunctionsLoaded(ref List<FunctionDef> functions);
 
     bool OnSamplesLoaded(ref string samples);
 
diff --git a/src/Infrastructure/BotSharp.Abstraction/Agents/Models/Agent.cs b/src/Infrastructure/BotSharp.Abstraction/Agents/Models/Agent.cs
@@ -1,3 +1,4 @@
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Routing.Models;
 
 namespace BotSharp.Abstraction.Agents.Models;
@@ -32,7 +33,7 @@ public class Agent
     /// Functions
     /// </summary>
     [JsonIgnore]
-    public List<string> Functions { get; set; }
+    public List<FunctionDef> Functions { get; set; } = new List<FunctionDef>();
 
     /// <summary>
     /// Responses
@@ -102,9 +103,9 @@ public Agent SetTemplates(List<AgentTemplate> templates)
         return this;
     }
 
-    public Agent SetFunctions(List<string> functions)
+    public Agent SetFunctions(List<FunctionDef> functions)
     {
-        Functions = functions ?? new List<string>();
+        Functions = functions ?? new List<FunctionDef>();
         return this;
     }
 
diff --git a/src/Infrastructure/BotSharp.Abstraction/Functions/Models/FunctionDef.cs b/src/Infrastructure/BotSharp.Abstraction/Functions/Models/FunctionDef.cs
@@ -1,12 +1,10 @@
-using System.Text.Json;
-
 namespace BotSharp.Abstraction.Functions.Models;
 
 public class FunctionDef
 {
     public string Name { get; set; }
     public string Description { get; set; }
-    public JsonDocument Parameters { get; set; }
+    public FunctionParametersDef Parameters { get; set; } = new FunctionParametersDef();
 
     public override string ToString()
     {
diff --git a/src/Infrastructure/BotSharp.Abstraction/Functions/Models/FunctionParametersDef.cs b/src/Infrastructure/BotSharp.Abstraction/Functions/Models/FunctionParametersDef.cs
@@ -0,0 +1,21 @@
+using System.Text.Json;
+
+namespace BotSharp.Abstraction.Functions.Models;
+
+public class FunctionParametersDef
+{
+    [JsonPropertyName("type")]
+    public string Type { get; set; } = "object";
+
+    /// <summary>
+    /// ParameterPropertyDef
+    /// {
+    ///     "field_name": {}
+    /// }
+    /// </summary>
+    [JsonPropertyName("properties")]
+    public JsonDocument Properties { get; set; } = JsonSerializer.Deserialize<JsonDocument>("{}");
+
+    [JsonPropertyName("required")]
+    public List<string> Required {  get; set; } = new List<string>();
+}
diff --git a/src/Infrastructure/BotSharp.Abstraction/Functions/Models/ParameterPropertyDef.cs b/src/Infrastructure/BotSharp.Abstraction/Functions/Models/ParameterPropertyDef.cs
@@ -0,0 +1,7 @@
+namespace BotSharp.Abstraction.Functions.Models;
+
+public class ParameterPropertyDef
+{
+    public string Type { get; set; } = "string";
+    public string Description { get; set; }
+}
diff --git a/src/Infrastructure/BotSharp.Abstraction/Routing/IRoutingHandler.cs b/src/Infrastructure/BotSharp.Abstraction/Routing/IRoutingHandler.cs
@@ -3,6 +3,10 @@
 
 namespace BotSharp.Abstraction.Routing;
 
+/// <summary>
+/// The routing handler will be injected to Router's FUNCTIONS section of the system prompt
+/// So the handler will be invoked by LLM autonomously.
+/// </summary>
 public interface IRoutingHandler
 {
     string Name { get; }
diff --git a/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.CreateAgent.cs b/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.CreateAgent.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Repositories;
 using System.IO;
 
@@ -114,14 +115,13 @@ private List<AgentTemplate> FetchTemplatesFromFile(string fileDir)
         return templates;
     }
 
-    private List<string> FetchFunctionsFromFile(string fileDir)
+    private List<FunctionDef> FetchFunctionsFromFile(string fileDir)
     {
         var file = Path.Combine(fileDir, "functions.json");
-        if (!File.Exists(file)) return new List<string>();
+        if (!File.Exists(file)) return new List<FunctionDef>();
 
         var functionsJson = File.ReadAllText(file);
-        var functionDefs = JsonSerializer.Deserialize<List<Abstraction.Functions.Models.FunctionDef>>(functionsJson, _options);
-        var functions = functionDefs.Select(x => JsonSerializer.Serialize(x, _options)).ToList();
+        var functions = JsonSerializer.Deserialize<List<FunctionDef>>(functionsJson, _options);
         return functions;
     }
 
diff --git a/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.LoadAgent.cs b/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.LoadAgent.cs
@@ -1,6 +1,4 @@
 using BotSharp.Abstraction.Agents.Models;
-using BotSharp.Abstraction.Routing;
-using BotSharp.Abstraction.Routing.Settings;
 using BotSharp.Abstraction.Templating;
 
 namespace BotSharp.Core.Agents.Services;
@@ -34,7 +32,7 @@ public async Task<Agent> LoadAgent(string id)
                 hook.OnInstructionLoaded(agent.Instruction, templateDict);
             }
 
-            if (!agent.Functions.IsNullOrEmpty())
+            if (agent.Functions != null)
             {
                 var functions = agent.Functions;
                 hook.OnFunctionsLoaded(ref functions);
diff --git a/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.UpdateAgent.cs b/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.UpdateAgent.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Repositories;
 using BotSharp.Abstraction.Routing.Models;
 using System.IO;
@@ -22,7 +23,7 @@ public async Task UpdateAgent(Agent agent, AgentField updateField)
         record.Profiles = agent.Profiles ?? new List<string>();
         record.RoutingRules = agent.RoutingRules ?? new List<RoutingRule>();
         record.Instruction = agent.Instruction ?? string.Empty;
-        record.Functions = agent.Functions ?? new List<string>();
+        record.Functions = agent.Functions ?? new List<FunctionDef>();
         record.Templates = agent.Templates ?? new List<AgentTemplate>();
         record.Responses = agent.Responses ?? new List<AgentResponse>();
 
diff --git a/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.cs b/src/Infrastructure/BotSharp.Core/Agents/Services/AgentService.cs
@@ -27,7 +27,8 @@ public AgentService(IServiceProvider services,
         {
             PropertyNameCaseInsensitive = true,
             PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-            WriteIndented = true
+            WriteIndented = true,
+            AllowTrailingCommas = true
         };
     }
 
diff --git a/src/Infrastructure/BotSharp.Core/BotSharpServiceCollectionExtensions.cs b/src/Infrastructure/BotSharp.Core/BotSharpServiceCollectionExtensions.cs
@@ -9,7 +9,7 @@
 using BotSharp.Core.Instructs;
 using BotSharp.Abstraction.Instructs;
 using BotSharp.Abstraction.Routing;
-using System.Reflection;
+using BotSharp.Core.Routing.Hooks;
 
 namespace BotSharp.Core;
 
@@ -63,6 +63,8 @@ public static IServiceCollection AddBotSharp(this IServiceCollection services, I
         services.AddScoped<IInstructService, InstructService>();
         services.AddScoped<ITokenStatistics, TokenStatistics>();
 
+        services.AddScoped<IAgentHook, RoutingAgentHook>();
+
         return services;
     }
 
diff --git a/src/Infrastructure/BotSharp.Core/Conversations/Services/TokenStatistics.cs b/src/Infrastructure/BotSharp.Core/Conversations/Services/TokenStatistics.cs
@@ -51,7 +51,7 @@ public void AddToken(TokenStatsModel stats)
 
     public void PrintStatistics()
     {
-        var stats = $"Token Usage: {_promptTokenCount} prompt + {_completionTokenCount} completion = {Total} total tokens. One-Way cost: ${Cost:C4}, accumulated cost: ${AccumulatedCost:C4}. Model: {_model}";
+        var stats = $"Token Usage: {_promptTokenCount} prompt + {_completionTokenCount} completion = {Total} total tokens. One-Way cost: {Cost:C4}, accumulated cost: {AccumulatedCost:C4}. [{_model}]";
 #if DEBUG
         Console.WriteLine(stats, Color.DarkGray);
 #else
diff --git a/src/Infrastructure/BotSharp.Core/Repository/FileRepository.cs b/src/Infrastructure/BotSharp.Core/Repository/FileRepository.cs
@@ -372,7 +372,7 @@ private void UpdateAgentInstruction(string agentId, string instruction)
         File.WriteAllText(instructionFile, instruction);
     }
 
-    private void UpdateAgentFunctions(string agentId, List<string> inputFunctions)
+    private void UpdateAgentFunctions(string agentId, List<FunctionDef> inputFunctions)
     {
         if (inputFunctions.IsNullOrEmpty()) return;
 
@@ -385,8 +385,7 @@ private void UpdateAgentFunctions(string agentId, List<string> inputFunctions)
         var functions = new List<string>();
         foreach (var function in inputFunctions)
         {
-            var functionDef = JsonSerializer.Deserialize<FunctionDef>(function, _options);
-            functions.Add(JsonSerializer.Serialize(functionDef, _options));
+            functions.Add(JsonSerializer.Serialize(function, _options));
         }
 
         var functionText = JsonSerializer.Serialize(functions, _options);
@@ -730,14 +729,13 @@ private string FetchInstruction(string fileDir)
         return instruction;
     }
 
-    private List<string> FetchFunctions(string fileDir)
+    private List<FunctionDef> FetchFunctions(string fileDir)
     {
         var file = Path.Combine(fileDir, "functions.json");
-        if (!File.Exists(file)) return new List<string>();
+        if (!File.Exists(file)) return new List<FunctionDef>();
 
         var functionsJson = File.ReadAllText(file);
-        var functionDefs = JsonSerializer.Deserialize<List<FunctionDef>>(functionsJson, _options);
-        var functions = functionDefs.Select(x => JsonSerializer.Serialize(x, _options)).ToList();
+        var functions = JsonSerializer.Deserialize<List<FunctionDef>>(functionsJson, _options);
         return functions;
     }
 
diff --git a/src/Infrastructure/BotSharp.Core/Routing/Hooks/RoutingAgentHook.cs b/src/Infrastructure/BotSharp.Core/Routing/Hooks/RoutingAgentHook.cs
@@ -0,0 +1,21 @@
+using BotSharp.Abstraction.Functions.Models;
+
+namespace BotSharp.Core.Routing.Hooks;
+
+public class RoutingAgentHook : AgentHookBase
+{
+    public RoutingAgentHook(IServiceProvider services, AgentSettings settings) 
+        : base(services, settings)
+    {
+    }
+
+    public override bool OnFunctionsLoaded(ref List<FunctionDef> functions)
+    {
+        functions.Add(new FunctionDef
+        {
+            Name = "fallback_to_router",
+            Description = "If the user's request is beyond your capabilities, you can call this function for help."
+        });
+        return base.OnFunctionsLoaded(ref functions);
+    }
+}
diff --git a/src/Infrastructure/BotSharp.Core/Routing/RoutingService.InvokeAgent.cs b/src/Infrastructure/BotSharp.Core/Routing/RoutingService.InvokeAgent.cs
@@ -18,51 +18,48 @@ public async Task<RoleDialogModel> InvokeAgent(string agentId)
         var agent = await agentService.LoadAgent(agentId);
 
         var chatCompletion = CompletionProvider.GetChatCompletion(_services);
+        RoleDialogModel response = chatCompletion.GetChatCompletions(agent, Dialogs);
 
-        RoleDialogModel response = null;
-        await chatCompletion.GetChatCompletionsAsync(agent, Dialogs,
-            async msg =>
-            {
-                response = msg;
-            }, async fn =>
-            {
-                // execute function
-                // Save states
-                SaveStateByArgs(JsonSerializer.Deserialize<JsonDocument>(fn.FunctionArgs));
+        if (response.Role == AgentRole.Function)
+        {
+            var fn = response;
+            // execute function
+            // Save states
+            SaveStateByArgs(JsonSerializer.Deserialize<JsonDocument>(fn.FunctionArgs));
 
-                var conversationService = _services.GetRequiredService<IConversationService>();
-                // Call functions
-                await conversationService.CallFunctions(fn);
+            var conversationService = _services.GetRequiredService<IConversationService>();
+            // Call functions
+            await conversationService.CallFunctions(fn);
 
-                if (string.IsNullOrEmpty(fn.Content))
-                {
-                    fn.Content = fn.ExecutionResult;
-                }
+            if (string.IsNullOrEmpty(fn.Content))
+            {
+                fn.Content = fn.ExecutionResult;
+            }
 
-                Dialogs.Add(fn);
+            Dialogs.Add(fn);
 
-                if (!fn.StopCompletion)
+            if (!fn.StopCompletion)
+            {
+                // Find response template
+                var templateService = _services.GetRequiredService<IResponseTemplateService>();
+                var quickResponse = await templateService.RenderFunctionResponse(agent.Id, fn);
+                if (!string.IsNullOrEmpty(quickResponse))
                 {
-                    // Find response template
-                    var templateService = _services.GetRequiredService<IResponseTemplateService>();
-                    var quickResponse = await templateService.RenderFunctionResponse(agent.Id, fn);
-                    if (!string.IsNullOrEmpty(quickResponse))
-                    {
-                        response = new RoleDialogModel(AgentRole.Assistant, quickResponse)
-                        {
-                            CurrentAgentId = agent.Id
-                        };
-                    }
-                    else
+                    response = new RoleDialogModel(AgentRole.Assistant, quickResponse)
                     {
-                        response = await InvokeAgent(fn.CurrentAgentId);
-                    }
+                        CurrentAgentId = agent.Id
+                    };
                 }
                 else
                 {
-                    response = fn;
+                    response = await InvokeAgent(fn.CurrentAgentId);
                 }
-            });
+            }
+            else
+            {
+                response = fn;
+            }
+        }
 
         return response;
     }
diff --git a/src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentCreationModel.cs b/src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentCreationModel.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Routing.Models;
 
 namespace BotSharp.OpenAPI.ViewModels.Agents;
@@ -9,7 +10,7 @@ public class AgentCreationModel
     public string Description { get; set; }
     public string Instruction { get; set; }
     public List<AgentTemplate> Templates { get; set; }
-    public List<string> Functions { get; set; }
+    public List<FunctionDef> Functions { get; set; }
     public List<AgentResponse> Responses { get; set; }
     public bool IsPublic { get; set; }
     public bool AllowRouting { get; set; }
diff --git a/src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentUpdateModel.cs b/src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentUpdateModel.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Routing.Models;
 
 namespace BotSharp.OpenAPI.ViewModels.Agents;
@@ -26,7 +27,7 @@ public class AgentUpdateModel
     /// <summary>
     /// Functions
     /// </summary>
-    public List<string>? Functions { get; set; }
+    public List<FunctionDef>? Functions { get; set; }
 
     /// <summary>
     /// Routes
@@ -61,7 +62,7 @@ public Agent ToAgent()
                             .ToList() ?? new List<RoutingRule>(),
             Instruction = Instruction ?? string.Empty,
             Templates = Templates ?? new List<AgentTemplate>(),
-            Functions = Functions ?? new List<string>(),
+            Functions = Functions ?? new List<FunctionDef>(),
             Responses = Responses ?? new List<AgentResponse>()
         };
 
diff --git a/src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentViewModel.cs b/src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentViewModel.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Agents.Models;
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Routing.Models;
 
 namespace BotSharp.OpenAPI.ViewModels.Agents;
@@ -10,7 +11,7 @@ public class AgentViewModel
     public string Description { get; set; }
     public string Instruction { get; set; }
     public List<AgentTemplate> Templates { get; set; }
-    public List<string> Functions { get; set; }
+    public List<FunctionDef> Functions { get; set; }
     public List<AgentResponse> Responses { get; set; }
     public bool IsPublic { get; set; }
     public bool AllowRouting { get; set; }
diff --git a/src/Plugins/BotSharp.Plugin.AzureOpenAI/Providers/ChatCompletionProvider.cs b/src/Plugins/BotSharp.Plugin.AzureOpenAI/Providers/ChatCompletionProvider.cs
diff --git a/src/Plugins/BotSharp.Plugin.MongoStorage/Collections/AgentCollection.cs b/src/Plugins/BotSharp.Plugin.MongoStorage/Collections/AgentCollection.cs
diff --git a/src/Plugins/BotSharp.Plugin.MongoStorage/Repository/MongoRepository.cs b/src/Plugins/BotSharp.Plugin.MongoStorage/Repository/MongoRepository.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using BotSharp.Abstraction.Agents.Settings;`
	`2`	`+using BotSharp.Abstraction.Functions.Models;`
`2`	`3`
`3`	`4`	`namespace BotSharp.Abstraction.Agents;`
`4`	`5`
`@@ -34,7 +35,7 @@ public virtual bool OnInstructionLoaded(string template, Dictionary<string, obje`
`34`	`35`	`return true;`
`35`	`36`	`}`
`36`	`37`
`37`		`- public virtual bool OnFunctionsLoaded(ref List<string> functions)`
	`38`	`+ public virtual bool OnFunctionsLoaded(ref List<FunctionDef> functions)`
`38`	`39`	`{`
`39`	`40`	`_agent.Functions = functions;`
`40`	`41`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,10 @@`
`1`		`-using System.Text.Json;`
`2`		`-`
`3`	`1`	`namespace BotSharp.Abstraction.Functions.Models;`
`4`	`2`
`5`	`3`	`public class FunctionDef`
`6`	`4`	`{`
`7`	`5`	`public string Name { get; set; }`
`8`	`6`	`public string Description { get; set; }`
`9`		`- public JsonDocument Parameters { get; set; }`
	`7`	`+ public FunctionParametersDef Parameters { get; set; } = new FunctionParametersDef();`
`10`	`8`
`11`	`9`	`public override string ToString()`
`12`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,10 @@`
`3`	`3`
`4`	`4`	`namespace BotSharp.Abstraction.Routing;`
`5`	`5`
	`6`	`+/// <summary>`
	`7`	`+/// The routing handler will be injected to Router's FUNCTIONS section of the system prompt`
	`8`	`+/// So the handler will be invoked by LLM autonomously.`
	`9`	`+/// </summary>`
`6`	`10`	`public interface IRoutingHandler`
`7`	`11`	`{`
`8`	`12`	`string Name { get; }`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using BotSharp.Abstraction.Agents.Models;`
	`2`	`+using BotSharp.Abstraction.Functions.Models;`
`2`	`3`	`using BotSharp.Abstraction.Repositories;`
`3`	`4`	`using System.IO;`
`4`	`5`
`@@ -114,14 +115,13 @@ private List<AgentTemplate> FetchTemplatesFromFile(string fileDir)`
`114`	`115`	`return templates;`
`115`	`116`	`}`
`116`	`117`
`117`		`- private List<string> FetchFunctionsFromFile(string fileDir)`
	`118`	`+ private List<FunctionDef> FetchFunctionsFromFile(string fileDir)`
`118`	`119`	`{`
`119`	`120`	`var file = Path.Combine(fileDir, "functions.json");`
`120`		`- if (!File.Exists(file)) return new List<string>();`
	`121`	`+ if (!File.Exists(file)) return new List<FunctionDef>();`
`121`	`122`
`122`	`123`	`var functionsJson = File.ReadAllText(file);`
`123`		`- var functionDefs = JsonSerializer.Deserialize<List<Abstraction.Functions.Models.FunctionDef>>(functionsJson, _options);`
`124`		`- var functions = functionDefs.Select(x => JsonSerializer.Serialize(x, _options)).ToList();`
	`124`	`+ var functions = JsonSerializer.Deserialize<List<FunctionDef>>(functionsJson, _options);`
`125`	`125`	`return functions;`
`126`	`126`	`}`
`127`	`127`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,4 @@`
`1`	`1`	`using BotSharp.Abstraction.Agents.Models;`
`2`		`-using BotSharp.Abstraction.Routing;`
`3`		`-using BotSharp.Abstraction.Routing.Settings;`
`4`	`2`	`using BotSharp.Abstraction.Templating;`
`5`	`3`
`6`	`4`	`namespace BotSharp.Core.Agents.Services;`
`@@ -34,7 +32,7 @@ public async Task<Agent> LoadAgent(string id)`
`34`	`32`	`hook.OnInstructionLoaded(agent.Instruction, templateDict);`
`35`	`33`	`}`
`36`	`34`
`37`		`- if (!agent.Functions.IsNullOrEmpty())`
	`35`	`+ if (agent.Functions != null)`
`38`	`36`	`{`
`39`	`37`	`var functions = agent.Functions;`
`40`	`38`	`hook.OnFunctionsLoaded(ref functions);`