Merge pull request #314 from hchen2020/master

Oceania2018 · web-flow · commit d96542f56228 · 2024-02-21T17:26:17.000-06:00
Improve SQL Driver.
diff --git a/src/Plugins/BotSharp.Plugin.AzureOpenAI/Providers/ChatCompletionProvider.cs b/src/Plugins/BotSharp.Plugin.AzureOpenAI/Providers/ChatCompletionProvider.cs
@@ -231,6 +231,10 @@ public async Task<bool> GetChatCompletionsStreamingAsync(Agent agent, List<RoleD
         {
             if (message.Role == ChatRole.Function)
             {
+                chatCompletionsOptions.Messages.Add(new ChatRequestAssistantMessage(string.Empty)
+                {
+                    FunctionCall = new FunctionCall(message.FunctionName, message.FunctionArgs),
+                });
                 chatCompletionsOptions.Messages.Add(new ChatRequestFunctionMessage(message.FunctionName, message.Content));
             }
             else if (message.Role == ChatRole.User)
@@ -287,7 +291,7 @@ private string GetPrompt(ChatCompletionsOptions chatCompletionsOptions)
                     if (x.Role == ChatRole.Function)
                     {
                         var m = x as ChatRequestFunctionMessage;
-                        return $"{m.Role}: {m.Name} => {m.Content}";
+                        return $"{m.Role}: {m.Content}";
                     }
                     else if (x.Role == ChatRole.User)
                     {
@@ -299,7 +303,9 @@ private string GetPrompt(ChatCompletionsOptions chatCompletionsOptions)
                     else if (x.Role == ChatRole.Assistant)
                     {
                         var m = x as ChatRequestAssistantMessage;
-                        return $"{m.Role}: {m.Content}";
+                        return m.FunctionCall != null ?
+                            $"{m.Role}: Call function {m.FunctionCall.Name}({m.FunctionCall.Arguments})" :
+                            $"{m.Role}: {m.Content}";
                     }
                     else
                     {
diff --git a/src/Plugins/BotSharp.Plugin.ChatHub/Hooks/ChatHubConversationHook.cs b/src/Plugins/BotSharp.Plugin.ChatHub/Hooks/ChatHubConversationHook.cs
@@ -1,9 +1,7 @@
-using BotSharp.Abstraction.Loggers.Models;
 using BotSharp.Abstraction.Messaging;
 using BotSharp.Abstraction.Messaging.Enums;
 using BotSharp.Abstraction.Messaging.JsonConverters;
 using BotSharp.Abstraction.Messaging.Models.RichContent;
-using BotSharp.Abstraction.Repositories;
 using Microsoft.AspNetCore.SignalR;
 
 namespace BotSharp.Plugin.ChatHub.Hooks;
diff --git a/src/Plugins/BotSharp.Plugin.ChatHub/Hooks/StreamingLogHook.cs b/src/Plugins/BotSharp.Plugin.ChatHub/Hooks/StreamingLogHook.cs
@@ -1,14 +1,11 @@
-using BotSharp.Abstraction.Agents;
 using BotSharp.Abstraction.Agents.Models;
-using BotSharp.Abstraction.Conversations.Models;
+using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Loggers;
 using BotSharp.Abstraction.Loggers.Models;
-using BotSharp.Abstraction.Messaging.Models.RichContent;
-using BotSharp.Abstraction.Messaging;
 using BotSharp.Abstraction.Repositories;
-using BotSharp.Core.Agents.Services;
+using BotSharp.Abstraction.Repositories.Filters;
+using BotSharp.Abstraction.Routing.Settings;
 using Microsoft.AspNetCore.SignalR;
-using Microsoft.VisualBasic;
 
 namespace BotSharp.Plugin.ChatHub.Hooks;
 
@@ -82,6 +79,17 @@ public async Task AfterGenerated(RoleDialogModel message, TokenStatsModel tokenS
         var conversationId = _state.GetConversationId();
         var agent = await agentService.LoadAgent(message.CurrentAgentId);
 
+        // 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));
+        }
+        catch
+        {
+            // ignore
+        }
+
         string log;
         if (message.Role == AgentRole.Function)
         {
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Functions/GetTableColumnsFn.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Functions/GetTableColumnsFn.cs
@@ -17,10 +17,10 @@ public GetTableColumnsFn(IServiceProvider services)
     public async Task<bool> Execute(RoleDialogModel message)
     {
         var args = JsonSerializer.Deserialize<GetTableColumnsArgs>(message.FunctionArgs);
-        message.Content = $"Success. Columns of table '{args.Table}':\r\n\r\n";
+        message.Content = "";
 
         var dbSettings = _services.GetRequiredService<BotSharpDatabaseSettings>();
-        var dir = Path.Combine(dbSettings.FileRepository, "agents", "ec46f15b-8790-400f-a37f-1e7995b7d6e2", "schemas");
+        var dir = Path.Combine(dbSettings.FileRepository, "agents", "beda4c12-e1ec-4b4b-b328-3df4a6687c4f", "schemas");
 
         // Search related document by message.Content + args.Description
         var files = Directory.GetFiles(dir);
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Functions/SqlInsertFn.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Functions/SqlInsertFn.cs
@@ -16,13 +16,8 @@ public async Task<bool> Execute(RoleDialogModel message)
     {
         var args = JsonSerializer.Deserialize<SqlStatement>(message.FunctionArgs);
         var sqlDriver = _services.GetRequiredService<SqlDriverService>();
-        if (sqlDriver.Statements.Exists(x => x.Statement == args.Statement))
-        {
-            message.Content = "Skipped duplicated statement.";
-            return false;
-        }
         sqlDriver.Enqueue(args);
-        message.Content = $"Inserted new record {JsonSerializer.Serialize(args.Parameters)} successfully";
+        message.Content = $"Inserted new record successfully.";
         if (args.Return != null)
         {
             /*sqlDriver.Enqueue(new SqlStatement
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Functions/SqlSelect.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Functions/SqlSelect.cs
@@ -17,6 +17,8 @@ public SqlSelect(IServiceProvider services)
     public async Task<bool> Execute(RoleDialogModel message)
     {
         var args = JsonSerializer.Deserialize<SqlStatement>(message.FunctionArgs);
+        var sqlDriver = _services.GetRequiredService<SqlDriverService>();
+
         // check if need to instantely
         var execNow = !args.Parameters.Any(x => x.Value.StartsWith("@"));
         if (execNow)
@@ -28,24 +30,24 @@ public async Task<bool> Execute(RoleDialogModel message)
             {
                 dictionary["@" + p.Name] = p.Value;
             }
-            var result = connection.QueryFirst<string>(args.Statement, dictionary);
+            var result = connection.QueryFirstOrDefault(args.Statement, dictionary);
 
-            if (args.IsCheckExistence)
+            if (result == null)
             {
-                message.Content = result == null ?
-                    $"The record does not exist" :
-                    $"The record already exists";
+                message.Content = "Record not found";
             }
             else
             {
-                message.Content = $"Retrieved result is {result} ({args.Reason})";
+                message.Content = JsonSerializer.Serialize(result);
+                args.Return.Value = message.Content;
             }
+            
+            sqlDriver.Enqueue(args);
         }
         else
         {
-            var sqlDriver = _services.GetRequiredService<SqlDriverService>();
             sqlDriver.Enqueue(args);
-            message.Content = $"Success.";
+            message.Content = $"The {args.Return.Name} is saved to @{args.Return.Alias}";
         }
         
         return true;
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Hooks/SqlDriverContentGeneratingHook.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Hooks/SqlDriverContentGeneratingHook.cs
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Models/SqlParameter.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Models/SqlParameter.cs
@@ -2,7 +2,7 @@
 
 namespace BotSharp.Plugin.SqlDriver.Models;
 
-public class SqlParamater
+public class SqlParameter
 {
     [JsonPropertyName("name")]
     public string Name { get; set; }
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Models/SqlReturn.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Models/SqlReturn.cs
@@ -10,6 +10,8 @@ public class SqlReturn
     [JsonPropertyName("alias")]
     public string Alias { get; set; }
 
+    public string? Value { get; set; }
+
     public override string ToString()
     {
         return $"{Alias} - {Name}";
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Models/SqlStatement.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Models/SqlStatement.cs
@@ -13,11 +13,8 @@ public class SqlStatement
     [JsonPropertyName("table")]
     public string Table { get; set; }
 
-    [JsonPropertyName("is_check_existence")]
-    public bool IsCheckExistence { get; set; }
-
     [JsonPropertyName("parameters")]
-    public SqlParamater[] Parameters { get; set; } = new SqlParamater[0];
+    public SqlParameter[] Parameters { get; set; } = new SqlParameter[0];
 
     [JsonPropertyName("return_field")]
     public SqlReturn Return { get; set; }
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/Services/SqlDriverService.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/Services/SqlDriverService.cs
@@ -23,20 +23,24 @@ public void Enqueue(SqlStatement statement)
         {
             Console.WriteLine();
 
-            Console.Write($"Reason: ");
-            Console.WriteLine($"{sql.Reason}", Color.Green);
+            Console.WriteLine($"{sql.Reason}");
 
-            Console.Write($"Statement: ");
-            Console.WriteLine(sql.Statement, Color.Green);
+            Console.WriteLine(sql.Statement, Color.Yellow);
             foreach (var p in sql.Parameters)
             {
-                Console.Write($"@{p.Name}: ");
-                Console.WriteLine($"{p.Value}", Color.Green);
+                Console.WriteLine($"@{p.Name} = '{p.Value}'", Color.Green);
             }
             if (sql.Return != null)
             {
                 Console.Write($"Return: ");
-                Console.WriteLine($"{sql.Return.Name} as @{sql.Return.Alias}", Color.Green);
+                if (!string.IsNullOrEmpty(sql.Return.Value))
+                {
+                    Console.WriteLine($" {sql.Return.Value}", Color.Red);
+                }
+                else
+                {
+                    Console.WriteLine($"{sql.Return.Name} as @{sql.Return.Alias}", Color.Green);
+                }
             }
         }
     }
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/SqlDriverPlugin.cs b/src/Plugins/BotSharp.Plugin.SqlDriver/SqlDriverPlugin.cs
@@ -1,5 +1,3 @@
-using BotSharp.Abstraction.Loggers;
-
 namespace BotSharp.Plugin.SqlDriver;
 
 public class SqlDriverPlugin : IBotSharpPlugin
@@ -19,6 +17,5 @@ public void RegisterDI(IServiceCollection services, IConfiguration config)
 
         services.AddScoped<SqlDriverService>();
         services.AddScoped<IKnowledgeHook, SqlDriverKnowledgeHook>();
-        services.AddScoped<IContentGeneratingHook, SqlDriverContentGeneratingHook>();
     }
 }
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/data/agents/beda4c12-e1ec-4b4b-b328-3df4a6687c4f/functions.json b/src/Plugins/BotSharp.Plugin.SqlDriver/data/agents/beda4c12-e1ec-4b4b-b328-3df4a6687c4f/functions.json
@@ -1,4 +1,18 @@
 [
+  {
+    "name": "get_table_columns",
+    "description": "Get related table columns and foreign key informations",
+    "parameters": {
+      "type": "object",
+      "properties": {
+        "table": {
+          "type": "string",
+          "description": "table name"
+        }
+      },
+      "required": [ "table" ]
+    }
+  },
   {
     "name": "sql_insert",
     "description": "Insert query is generated if the record doesn't exist.",
@@ -13,12 +27,16 @@
           "type": "string",
           "description": "reason"
         },
+        "table": {
+          "type": "string",
+          "description": "related table"
+        },
         "parameters": {
           "type": "array",
-          "description": "parameters for the sql",
+          "description": "a list of parameters in the statement match with the variables",
           "items": {
             "type": "object",
-            "description": "the name and value for the parameter",
+            "description": "{name:'', value:''}",
             "properties": {
               "name": {
                 "type": "string",
@@ -28,7 +46,8 @@
                 "type": "string",
                 "description": "real value inferred by the context"
               }
-            }
+            },
+            "required": [ "name", "value" ]
           }
         },
         "return_field": {
@@ -43,10 +62,11 @@
               "type": "string",
               "description": "meaningful field alias"
             }
-          }
+          },
+          "required": [ "name", "alias" ]
         }
       },
-      "required": [ "sql_statement", "reason", "parameters", "return_field" ]
+      "required": [ "sql_statement", "reason", "table", "parameters", "return_field" ]
     }
   },
   {
@@ -63,9 +83,9 @@
           "type": "string",
           "description": "reason"
         },
-        "is_check_existence": {
-          "type": "boolean",
-          "description": "check record existence"
+        "table": {
+          "type": "string",
+          "description": "related table"
         },
         "parameters": {
           "type": "array",
@@ -82,7 +102,8 @@
                 "type": "string",
                 "description": "real value inferred by the context"
               }
-            }
+            },
+            "required": [ "name", "value" ]
           }
         },
         "return_field": {
@@ -97,10 +118,11 @@
               "type": "string",
               "description": "meaningful field alias"
             }
-          }
+          },
+          "required": [ "name", "value" ]
         }
       },
-      "required": [ "sql_statement", "reason", "is_check_existence", "parameters", "return_field" ]
+      "required": [ "sql_statement", "reason", "table", "parameters", "return_field" ]
     }
   }
 ]
diff --git a/src/Plugins/BotSharp.Plugin.SqlDriver/data/agents/beda4c12-e1ec-4b4b-b328-3df4a6687c4f/instruction.liquid b/src/Plugins/BotSharp.Plugin.SqlDriver/data/agents/beda4c12-e1ec-4b4b-b328-3df4a6687c4f/instruction.liquid
@@ -1,22 +1,11 @@
 You're a SQL driver who knows how to translate text into SQL query.
-Analyze the user requirement, think step by step, breakdown complex task into multiple steps.
+Think step by step, analyze the user requirement, you must get table schema first, breakdown into multiple sql statements if user need to insert mulitple records. 
+Output the next step smartly.
 
 Your response must meet below requirements:
+* Walk through the provided information, don't run query if there is already related information;
 * DO NOT generate duplicated sql statements;
 * The return field alias should be meaningful, it can be similar name of reference table column;
-* Double check if the fields in the SQL query are correct;
+* Make sure the SELECT and WHERE fields are in corresponding table schema definition;
 * Use "Unique Index" to help check record existence;
-
-{% if return_variables and return_variables != empty -%}
-=====
-Below variables can be used by subsequent SQL:
-{% for v in return_variables %}
-- @{{ v }}
-{% endfor %}
-{%- endif %}
-
-{% if table_definition -%}
-=====
-Related table {{ related_table }} definition:
-{{ table_definition }}
-{%- endif %}
+* For INSERT statement with mutliple records, should return in different meaningful alias;

Original file line number	Diff line number	Diff line change
`@@ -231,6 +231,10 @@ public async Task<bool> GetChatCompletionsStreamingAsync(Agent agent, List<RoleD`
`231`	`231`	`{`
`232`	`232`	`if (message.Role == ChatRole.Function)`
`233`	`233`	`{`
	`234`	`+ chatCompletionsOptions.Messages.Add(new ChatRequestAssistantMessage(string.Empty)`
	`235`	`+ {`
	`236`	`+ FunctionCall = new FunctionCall(message.FunctionName, message.FunctionArgs),`
	`237`	`+ });`
`234`	`238`	`chatCompletionsOptions.Messages.Add(new ChatRequestFunctionMessage(message.FunctionName, message.Content));`
`235`	`239`	`}`
`236`	`240`	`else if (message.Role == ChatRole.User)`
`@@ -287,7 +291,7 @@ private string GetPrompt(ChatCompletionsOptions chatCompletionsOptions)`
`287`	`291`	`if (x.Role == ChatRole.Function)`
`288`	`292`	`{`
`289`	`293`	`var m = x as ChatRequestFunctionMessage;`
`290`		`- return $"{m.Role}: {m.Name} => {m.Content}";`
	`294`	`+ return $"{m.Role}: {m.Content}";`
`291`	`295`	`}`
`292`	`296`	`else if (x.Role == ChatRole.User)`
`293`	`297`	`{`
`@@ -299,7 +303,9 @@ private string GetPrompt(ChatCompletionsOptions chatCompletionsOptions)`
`299`	`303`	`else if (x.Role == ChatRole.Assistant)`
`300`	`304`	`{`
`301`	`305`	`var m = x as ChatRequestAssistantMessage;`
`302`		`- return $"{m.Role}: {m.Content}";`
	`306`	`+ return m.FunctionCall != null ?`
	`307`	`+ $"{m.Role}: Call function {m.FunctionCall.Name}({m.FunctionCall.Arguments})" :`
	`308`	`+ $"{m.Role}: {m.Content}";`
`303`	`309`	`}`
`304`	`310`	`else`
`305`	`311`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ public SqlSelect(IServiceProvider services)`
`17`	`17`	`public async Task<bool> Execute(RoleDialogModel message)`
`18`	`18`	`{`
`19`	`19`	`var args = JsonSerializer.Deserialize<SqlStatement>(message.FunctionArgs);`
	`20`	`+ var sqlDriver = _services.GetRequiredService<SqlDriverService>();`
	`21`	`+`
`20`	`22`	`// check if need to instantely`
`21`	`23`	`var execNow = !args.Parameters.Any(x => x.Value.StartsWith("@"));`
`22`	`24`	`if (execNow)`
`@@ -28,24 +30,24 @@ public async Task<bool> Execute(RoleDialogModel message)`
`28`	`30`	`{`
`29`	`31`	`dictionary["@" + p.Name] = p.Value;`
`30`	`32`	`}`
`31`		`- var result = connection.QueryFirst<string>(args.Statement, dictionary);`
	`33`	`+ var result = connection.QueryFirstOrDefault(args.Statement, dictionary);`
`32`	`34`
`33`		`- if (args.IsCheckExistence)`
	`35`	`+ if (result == null)`
`34`	`36`	`{`
`35`		`- message.Content = result == null ?`
`36`		`- $"The record does not exist" :`
`37`		`- $"The record already exists";`
	`37`	`+ message.Content = "Record not found";`
`38`	`38`	`}`
`39`	`39`	`else`
`40`	`40`	`{`
`41`		`- message.Content = $"Retrieved result is {result} ({args.Reason})";`
	`41`	`+ message.Content = JsonSerializer.Serialize(result);`
	`42`	`+ args.Return.Value = message.Content;`
`42`	`43`	`}`
	`44`	`+`
	`45`	`+ sqlDriver.Enqueue(args);`
`43`	`46`	`}`
`44`	`47`	`else`
`45`	`48`	`{`
`46`		`- var sqlDriver = _services.GetRequiredService<SqlDriverService>();`
`47`	`49`	`sqlDriver.Enqueue(args);`
`48`		`- message.Content = $"Success.";`
	`50`	`+ message.Content = $"The {args.Return.Name} is saved to @{args.Return.Alias}";`
`49`	`51`	`}`
`50`	`52`
`51`	`53`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace BotSharp.Plugin.SqlDriver.Models;`
`4`	`4`
`5`		`-public class SqlParamater`
	`5`	`+public class SqlParameter`
`6`	`6`	`{`
`7`	`7`	`[JsonPropertyName("name")]`
`8`	`8`	`public string Name { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ public class SqlReturn`
`10`	`10`	`[JsonPropertyName("alias")]`
`11`	`11`	`public string Alias { get; set; }`
`12`	`12`
	`13`	`+ public string? Value { get; set; }`
	`14`	`+`
`13`	`15`	`public override string ToString()`
`14`	`16`	`{`
`15`	`17`	`return $"{Alias} - {Name}";`