From 461867e24c51ec223a8b750cb44c405631538fff Mon Sep 17 00:00:00 2001 From: Neil MacMullen Date: Sat, 29 Jun 2024 22:41:05 +0100 Subject: [PATCH 1/4] Provide experimental copilot support --- applications/lokqlDx/Copilot.cs | 118 ++++++++++++++++++ applications/lokqlDx/MainWindow.xaml | 36 +++++- applications/lokqlDx/MainWindow.xaml.cs | 75 +++++++++++ .../lokql-engine/InteractiveTableExplorer.cs | 2 + 4 files changed, 228 insertions(+), 3 deletions(-) create mode 100644 applications/lokqlDx/Copilot.cs diff --git a/applications/lokqlDx/Copilot.cs b/applications/lokqlDx/Copilot.cs new file mode 100644 index 0000000..181f5b6 --- /dev/null +++ b/applications/lokqlDx/Copilot.cs @@ -0,0 +1,118 @@ +using System.Net.Http; +using System.Net.Http.Headers; +using System.Net.Http.Json; +using System.Text; +using System.Text.Json; +using KustoLoco.Core.Console; +using NotNullStrings; + +namespace lokqlDx; + +public class Copilot +{ + + public void RenderResponses(IKustoConsole console) + { + foreach(var message in context) + { + var color = message.role switch + { + "user" => ConsoleColor.Green, + "assistant" => ConsoleColor.Yellow, + "system" => ConsoleColor.Cyan, + _ => ConsoleColor.White + }; + console.ForegroundColor = color; + console.WriteLine(message.content); + console.WriteLine(); + } + } + + private HttpClient _client; + + List context = []; + public Copilot(string apiToken) + { + Initialised = apiToken.IsNotBlank(); + _client = new HttpClient(); + _client.DefaultRequestHeaders.Authorization = + new AuthenticationHeaderValue("Bearer", apiToken); + AddSystemInstructions(@" +You are an assistant to the user. You will be asked questions about tables of data and +will be expected to provide answers in the form of KQL queries. + +This KQL engine does not support the top operator. Please avoid it in your responses. + +This KQL engine does not support joining on more than a single column. Please avoid doing this in your responses and +instead use the extend operator to generate a new column that can be used for joining. + +This KQL implementation does not support arg_min or dynamic property types. + +You should provide only a brief explanation of the query and ensure that the KQL query is enclosed within the markdown code block syntax. +Prefer to place each pipeline stage on a new line to improve readability. + +When asked to render a chart, use the render operator to specify the type of chart to render. The render operator should be the final operator in the query. +The only 'with' property that the render operator supports is 'title'. Please use this to specify a suitable name for the chart. + +When asked to render multi-series charts use the project operator to order columns such that the column that defines the series +name is the final one in the list. Charts are rendered such that the first column is the x-axis, the second is the y-axis and +the last one is the series name. + +In general, prefer to place any time-based column as the x-axis and quantity-based columns as the y-axis but this is not a strict requirement. + +Here are some common mistakes I want you to avoid: +- Using the top operator +- Using the arg_min operator +- Using the dynamic property types +- Joining on more than a single column +- Using the render operator in the middle of the query +- using 'm' or 'mon' to specify months in a timespan. Remember that 'm' is minutes and that 'mon' is not a valid timespan. Instead you need to convert months to a number of days. + +I will now give some some information about the schema of the tables that you will be asked to query. + +"); + } + + + public async Task Issue(string question) + { + AddUserMessage(question); + var requestData = new + { + model = "gpt-4", + messages = context.Select(x => new { x.role, x.content }).ToArray() + }; + + var requestContent = new StringContent(JsonSerializer.Serialize(requestData), Encoding.UTF8, + "application/json"); + var response = await _client.PostAsync("https://api.openai.com/v1/chat/completions", requestContent); + var responseString = await response.Content.ReadAsStringAsync(); + var responseDto = JsonSerializer.Deserialize(responseString); + await response.Content.ReadFromJsonAsync(); + var assistanceResponse = responseDto?.choices?.FirstOrDefault()?.message.content ?? string.Empty; + AddCopilotResponse(assistanceResponse); + return assistanceResponse; + } + + private void AddMessage(string role, string content) => context.Add(new ChatMessage(role, content)); + + private void AddUserMessage(string content) => AddMessage("user", content); + + private void AddCopilotResponse(string content) => AddMessage("assistant", content); + public void AddSystemInstructions(string content) => AddMessage("system", content); + + + public readonly record struct ChatMessage(string role, string content); + + public class ChatResponse + { + public ChatChoice[] choices { get; set; } = []; + } + + public class ChatChoice + { + public ChatMessage message { get; set; } = new ChatMessage(); + } + + public bool Initialised { get; private set; } +} diff --git a/applications/lokqlDx/MainWindow.xaml b/applications/lokqlDx/MainWindow.xaml index 1b4dcaa..950510a 100644 --- a/applications/lokqlDx/MainWindow.xaml +++ b/applications/lokqlDx/MainWindow.xaml @@ -50,10 +50,40 @@ - + + - - + + + + + + + + + + + + + + + + + + + + $" {z.First} is of type {z.Second.Type.Name}").ToArray(); + foreach (var column in cols) + { + sb.AppendLine(column); + } + _copilot.AddSystemInstructions(sb.ToString()); + } + } + var userchat = UserChat.Text; + UserChat.Text = string.Empty; + const int maxResubmissions = 3; + for (var i = 0; i < maxResubmissions; i ++) + { + var response = await _copilot.Issue(userchat); + + + var console = new WpfConsole(ChatHistory); + console.PrepareForOutput(); + _copilot.RenderResponses(console); + + //now try to extract kql... + var lines = response.Split('\n'); + var kql = new StringBuilder(); + var getting = false; + foreach (var line in lines) + { + if (line.StartsWith("```kql")) + { + kql.Clear(); + getting = true; + continue; + } + if (line.StartsWith("```")) + { + getting = false; + continue; + } + + if (getting) + kql.AppendLine(line.Trim()); + } + + if (kql.ToString().IsBlank()) + break; + await RunQuery(kql.ToString()); + var lastResult = _explorer._prevResultIncludingError; + + if (lastResult.Error.IsBlank()) + break; + userchat = $"That query gave an error: {lastResult.Error}"; + } + + + + SubmitButton.IsEnabled = true; + + } } diff --git a/libraries/lokql-engine/InteractiveTableExplorer.cs b/libraries/lokql-engine/InteractiveTableExplorer.cs index 9b17103..10dd609 100644 --- a/libraries/lokql-engine/InteractiveTableExplorer.cs +++ b/libraries/lokql-engine/InteractiveTableExplorer.cs @@ -31,6 +31,7 @@ public class InteractiveTableExplorer public readonly KustoSettingsProvider Settings; public DisplayOptions _currentDisplayOptions = new(10); + public KustoQueryResult _prevResultIncludingError =KustoQueryResult.Empty; public InteractiveTableExplorer(IKustoConsole outputConsole, ITableAdaptor loader, KustoSettingsProvider settings, CommandProcessor commandProcessor) @@ -129,6 +130,7 @@ public async Task RunNextBlock(BlockSequence blocks) var result = await GetCurrentContext().RunQuery(query); if (result.Error.Length == 0) _prevResult = result; + _prevResultIncludingError = result; DisplayResults(result); } From 5e3672d0152150aaae10bd40ecad430aef862153 Mon Sep 17 00:00:00 2001 From: Neil MacMullen Date: Sun, 30 Jun 2024 13:00:03 +0100 Subject: [PATCH 2/4] tweak ui --- applications/lokqlDx/Copilot.cs | 36 +++++++++++++++++------ applications/lokqlDx/MainWindow.xaml | 14 +++++++-- applications/lokqlDx/MainWindow.xaml.cs | 39 +++++++++++++++---------- 3 files changed, 62 insertions(+), 27 deletions(-) diff --git a/applications/lokqlDx/Copilot.cs b/applications/lokqlDx/Copilot.cs index 181f5b6..f7feeed 100644 --- a/applications/lokqlDx/Copilot.cs +++ b/applications/lokqlDx/Copilot.cs @@ -10,16 +10,27 @@ namespace lokqlDx; public class Copilot { - - public void RenderResponses(IKustoConsole console) + public static class Roles + { + public const string User = "user"; + public const string Assistant = "assistant"; + public const string System = "system"; + public const string Kql = "kql"; + } + public void RenderResponses(IKustoConsole console,params string [] roles) { foreach(var message in context) { + if (roles.Length > 0 && !roles.Contains(message.role)) + { + continue; + } var color = message.role switch { - "user" => ConsoleColor.Green, - "assistant" => ConsoleColor.Yellow, - "system" => ConsoleColor.Cyan, + Roles.User => ConsoleColor.Green, + Roles.Assistant => ConsoleColor.White, + Roles.System => ConsoleColor.Red, + Roles.Kql => ConsoleColor.Yellow, _ => ConsoleColor.White }; console.ForegroundColor = color; @@ -80,7 +91,9 @@ public async Task Issue(string question) var requestData = new { model = "gpt-4", - messages = context.Select(x => new { x.role, x.content }).ToArray() + messages = context + .Where(m=> m.role!= Roles.Kql) + .Select(x => new { x.role, x.content }).ToArray() }; var requestContent = new StringContent(JsonSerializer.Serialize(requestData), Encoding.UTF8, @@ -96,10 +109,10 @@ public async Task Issue(string question) private void AddMessage(string role, string content) => context.Add(new ChatMessage(role, content)); - private void AddUserMessage(string content) => AddMessage("user", content); + private void AddUserMessage(string content) => AddMessage(Roles.User, content); - private void AddCopilotResponse(string content) => AddMessage("assistant", content); - public void AddSystemInstructions(string content) => AddMessage("system", content); + private void AddCopilotResponse(string content) => AddMessage(Roles.Assistant, content); + public void AddSystemInstructions(string content) => AddMessage(Roles.System, content); public readonly record struct ChatMessage(string role, string content); @@ -115,4 +128,9 @@ public class ChatChoice } public bool Initialised { get; private set; } + + public void AddResponse(string response) + { + AddMessage(Roles.Kql,response); + } } diff --git a/applications/lokqlDx/MainWindow.xaml b/applications/lokqlDx/MainWindow.xaml index 950510a..a05bfa8 100644 --- a/applications/lokqlDx/MainWindow.xaml +++ b/applications/lokqlDx/MainWindow.xaml @@ -56,7 +56,11 @@ RunEvent="OnQueryEditorRunTextBlock" /> - + + + Terse + + @@ -71,7 +75,11 @@ HorizontalAlignment="Stretch" Background="DarkGray"/> - + + + + + + + $" {z.First} is of type {z.Second.Type.Name}").ToArray(); - foreach (var column in cols) - { - sb.AppendLine(column); - } + foreach (var column in cols) sb.AppendLine(column); _copilot.AddSystemInstructions(sb.ToString()); } } + var userchat = UserChat.Text; UserChat.Text = string.Empty; const int maxResubmissions = 3; - for (var i = 0; i < maxResubmissions; i ++) + for (var i = 0; i < maxResubmissions; i++) { var response = await _copilot.Issue(userchat); var console = new WpfConsole(ChatHistory); - console.PrepareForOutput(); - _copilot.RenderResponses(console); //now try to extract kql... var lines = response.Split('\n'); @@ -310,12 +305,13 @@ private async void SubmitToCopilot(object sender, RoutedEventArgs e) var getting = false; foreach (var line in lines) { - if (line.StartsWith("```kql")) + if (line.StartsWith("```kql") || line.StartsWith("```kusto")) { kql.Clear(); getting = true; continue; } + if (line.StartsWith("```")) { getting = false; @@ -326,6 +322,13 @@ private async void SubmitToCopilot(object sender, RoutedEventArgs e) kql.AppendLine(line.Trim()); } + _copilot.AddResponse(kql.ToString()); + console.PrepareForOutput(); + var options = new List { Copilot.Roles.System, Copilot.Roles.User, Copilot.Roles.Kql }; + if (TerseMode.IsChecked != true) + options.Add(Copilot.Roles.Assistant); + _copilot.RenderResponses(console, options.ToArray()); + if (kql.ToString().IsBlank()) break; await RunQuery(kql.ToString()); @@ -335,10 +338,14 @@ private async void SubmitToCopilot(object sender, RoutedEventArgs e) break; userchat = $"That query gave an error: {lastResult.Error}"; } - - + SubmitButton.IsEnabled = true; + } + private void ResetCopilot(object sender, RoutedEventArgs e) + { + _copilot = new Copilot(string.Empty); + ChatHistory.Document.Blocks.Clear(); } } From 78f9f5571f5b96e1be315c84844df6b65391a5fe Mon Sep 17 00:00:00 2001 From: Neil MacMullen Date: Sun, 30 Jun 2024 19:06:18 +0100 Subject: [PATCH 3/4] Implement datetime-part --- .../BuiltIns/BuiltInScalarFunctions.cs | 1 + .../ScalarFunctions/DatetimePartFunction.cs | 28 +++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 libraries/KustoLoco.Core/Evaluation/BuiltIns/ScalarFunctions/DatetimePartFunction.cs diff --git a/libraries/KustoLoco.Core/Evaluation/BuiltIns/BuiltInScalarFunctions.cs b/libraries/KustoLoco.Core/Evaluation/BuiltIns/BuiltInScalarFunctions.cs index aa37954..95e2676 100644 --- a/libraries/KustoLoco.Core/Evaluation/BuiltIns/BuiltInScalarFunctions.cs +++ b/libraries/KustoLoco.Core/Evaluation/BuiltIns/BuiltInScalarFunctions.cs @@ -148,6 +148,7 @@ static void AddCoalesce(List overloads, Func a.Year, + "month" => a.Month, + "quarter" => 1+((a.Month-1)/3), + "week" => 1+((a.DayOfYear-1)/7), + "day" => a.DayOfYear, + "hour" => a.Hour, + "minute" => a.Minute, + "second" => a.Second, + "millisecond" => a.Millisecond, + "microsecond" => a.Microsecond, + "nanosecond" => (int) a.Ticks, + _ => 0 + }; + } + +} From b44b7e50707e6721a70ab878a1c3cb17fd893161 Mon Sep 17 00:00:00 2001 From: Neil MacMullen Date: Sun, 30 Jun 2024 19:24:02 +0100 Subject: [PATCH 4/4] Import UI improvements --- applications/lokqlDx/MainWindow.xaml.cs | 13 ++++++++++--- applications/lokqlDx/Preferences.cs | 2 +- applications/lokqlDx/WorkspaceManager.cs | 12 ++++++++++++ 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/applications/lokqlDx/MainWindow.xaml.cs b/applications/lokqlDx/MainWindow.xaml.cs index b0fd575..812dc6a 100644 --- a/applications/lokqlDx/MainWindow.xaml.cs +++ b/applications/lokqlDx/MainWindow.xaml.cs @@ -18,6 +18,7 @@ public partial class MainWindow : Window { private readonly string[] _args; private readonly WpfConsole _console; + private readonly Size _minWindowSize = new(600, 400); private readonly PreferencesManager _preferenceManager = new(); private readonly WorkspaceManager _workspaceManager; @@ -111,12 +112,18 @@ private void UpdateUIFromWorkspace() private async void MainWindow_OnLoaded(object sender, RoutedEventArgs e) { _preferenceManager.Load(); - var pathToLoad = _args.Any() ? _args[0] : _preferenceManager.Preferences.LastWorkspacePath; + var pathToLoad = _args.Any() + ? _args[0] + : _preferenceManager.Preferences.LastWorkspacePath; _workspaceManager.Load(pathToLoad); if (Width > 100 && Height > 100 && Left > 0 && Top > 0) { - Width = _preferenceManager.Preferences.WindowWidth; - Height = _preferenceManager.Preferences.WindowHeight; + Width = _preferenceManager.Preferences.WindowWidth < _minWindowSize.Width + ? _minWindowSize.Width + : _preferenceManager.Preferences.WindowWidth; + Height = _preferenceManager.Preferences.WindowHeight < _minWindowSize.Height + ? _minWindowSize.Height + : _preferenceManager.Preferences.WindowHeight; Left = _preferenceManager.Preferences.WindowLeft; Top = _preferenceManager.Preferences.WindowTop; } diff --git a/applications/lokqlDx/Preferences.cs b/applications/lokqlDx/Preferences.cs index b69e552..ce10ae4 100644 --- a/applications/lokqlDx/Preferences.cs +++ b/applications/lokqlDx/Preferences.cs @@ -3,7 +3,7 @@ public class Preferences { public string LastWorkspacePath { get; set; } = string.Empty; - public double FontSize { get; set; } + public double FontSize { get; set; } = 20; public string FontFamily { get; set; } = string.Empty; public double WindowWidth { get; set; } public double WindowHeight { get; set; } diff --git a/applications/lokqlDx/WorkspaceManager.cs b/applications/lokqlDx/WorkspaceManager.cs index 4b5697d..27ec2fd 100644 --- a/applications/lokqlDx/WorkspaceManager.cs +++ b/applications/lokqlDx/WorkspaceManager.cs @@ -71,6 +71,18 @@ public void Save(string path,string userText) public void Load(string path) { + if (!File.Exists(path)) + { + var rootSettingFolderPath = + System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), + "kustoloco"); + if (!Directory.Exists(rootSettingFolderPath)) + Directory.CreateDirectory(rootSettingFolderPath); + + path = System.IO.Path.Combine(rootSettingFolderPath, "settings"); + File.WriteAllText(path, JsonSerializer.Serialize(new Workspace())); + } + Path = path; try {