Merge pull request #1149 from iceljc/features/add-chart-data

add chart data and code endpoints

Author: iceljc

src/Infrastructure/BotSharp.Abstraction/Chart/IBotSharpChartService.cs

@@ -0,0 +1,14 @@
+using BotSharp.Abstraction.Chart.Models;
+
+namespace BotSharp.Abstraction.Chart;
+
+public interface IBotSharpChartService
+{
+    public string Provider { get; }
+
+    Task<ChartDataResult?> GetConversationChartData(string conversationId, string messageId, ChartDataOptions options)
+        => throw new NotImplementedException();
+
+    Task<ChartCodeResult?> GetConversationChartCode(string conversationId, string messageId, ChartCodeOptions options)
+        => throw new NotImplementedException();
+}

src/Infrastructure/BotSharp.Abstraction/Chart/Models/ChartCodeOptions.cs

@@ -0,0 +1,25 @@
+namespace BotSharp.Abstraction.Chart.Models;
+
+public class ChartCodeOptions
+{
+    public string? AgentId { get; set; }
+    public string? TemplateName { get; set; }
+    public string Text { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Conversation state that can be used to fetch chart data
+    /// </summary>
+    public string? TargetStateName { get; set; }
+
+    public ChartLlmOptions? Llm { get; set; }
+    public List<KeyValue<object>>? States { get; set; }
+
+}
+
+public class ChartLlmOptions
+{
+    public string? Provider { get; set; }
+    public string? Model { get; set; }
+    public int? MaxOutputTokens { get; set; }
+    public string? ReasoningEffortLevel { get; set; }
+}

src/Infrastructure/BotSharp.Abstraction/Chart/Models/ChartCodeResult.cs

@@ -0,0 +1,7 @@
+namespace BotSharp.Abstraction.Chart.Models;
+
+public class ChartCodeResult
+{
+    public string Code { get; set; }
+    public string Language { get; set; }
+}

src/Infrastructure/BotSharp.Abstraction/Chart/Models/ChartDataOptions.cs

@@ -0,0 +1,9 @@
+namespace BotSharp.Abstraction.Chart.Models;
+
+public class ChartDataOptions
+{
+    /// <summary>
+    /// Conversation state that can be used to fetch chart data
+    /// </summary>
+    public string? TargetStateName { get; set; }
+}

src/Infrastructure/BotSharp.Abstraction/Chart/Models/ChartDataResult.cs

@@ -0,0 +1,6 @@
+namespace BotSharp.Abstraction.Chart.Models;
+
+public class ChartDataResult
+{
+    public object Data { get; set; }
+}

src/Infrastructure/BotSharp.OpenAPI/Controllers/ConversationController.cs

@@ -1,3 +1,4 @@
+using BotSharp.Abstraction.Chart;
 using BotSharp.Abstraction.Files.Constants;
 using BotSharp.Abstraction.Files.Enums;
 using BotSharp.Abstraction.Files.Utilities;
@@ -530,6 +531,35 @@ public IActionResult DownloadMessageFile([FromRoute] string conversationId, [Fro
     }
     #endregion
 
+    #region Chart
+    [AllowAnonymous]
+    [HttpGet("/conversation/{conversationId}/message/{messageId}/user/chart/data")]
+    public async Task<ConversationChartDataResponse?> GetConversationChartData(
+        [FromRoute] string conversationId,
+        [FromRoute] string messageId,
+        [FromQuery] ConversationChartDataRequest request)
+    {
+        var chart = _services.GetServices<IBotSharpChartService>().FirstOrDefault(x => x.Provider == request?.ChartProvider);
+        if (chart == null) return null;
+
+        var result = await chart.GetConversationChartData(conversationId, messageId, request);
+        return ConversationChartDataResponse.From(result);
+    }
+
+    [HttpPost("/conversation/{conversationId}/message/{messageId}/user/chart/code")]
+    public async Task<ConversationChartCodeResponse?> GetConversationChartCode(
+        [FromRoute] string conversationId,
+        [FromRoute] string messageId,
+        [FromBody] ConversationChartCodeRequest request)
+    {
+        var chart = _services.GetServices<IBotSharpChartService>().FirstOrDefault(x => x.Provider == request?.ChartProvider);
+        if (chart == null) return null;
+
+        var result = await chart.GetConversationChartCode(conversationId, messageId, request);
+        return ConversationChartCodeResponse.From(result);
+    }
+    #endregion
+
     #region Dashboard
     [HttpPut("/agent/{agentId}/conversation/{conversationId}/dashboard")]
     public async Task<bool> PinConversationToDashboard([FromRoute] string agentId, [FromRoute] string conversationId)

src/Infrastructure/BotSharp.OpenAPI/Using.cs

@@ -28,6 +28,7 @@
 global using BotSharp.Abstraction.Files;
 global using BotSharp.Abstraction.VectorStorage.Enums;
 global using BotSharp.Abstraction.Knowledges.Models;
+global using BotSharp.Abstraction.Chart.Models;
 global using BotSharp.OpenAPI.ViewModels.Conversations;
 global using BotSharp.OpenAPI.ViewModels.Users;
 global using BotSharp.OpenAPI.ViewModels.Agents;

src/Infrastructure/BotSharp.OpenAPI/ViewModels/Conversations/Request/ConversationChartDataRequest.cs

@@ -0,0 +1,17 @@
+namespace BotSharp.OpenAPI.ViewModels.Conversations;
+
+public class ConversationChartDataRequest : ChartDataOptions
+{
+    /// <summary>
+    /// Chart service provider
+    /// </summary>
+    public string ChartProvider { get; set; } = "Botsharp";
+}
+
+public class ConversationChartCodeRequest : ChartCodeOptions
+{
+    /// <summary>
+    /// Chart service provider
+    /// </summary>
+    public string ChartProvider { get; set; } = "Botsharp";
+}

src/Infrastructure/BotSharp.OpenAPI/ViewModels/Conversations/Response/ConversationChartDataResponse.cs

@@ -0,0 +1,40 @@
+namespace BotSharp.OpenAPI.ViewModels.Conversations;
+
+public class ConversationChartDataResponse
+{
+    public object Data { get; set; }
+
+    public static ConversationChartDataResponse? From(ChartDataResult? result)
+    {
+        if (result == null)
+        {
+            return null;
+        }
+
+        return new()
+        {
+            Data = result.Data
+        };
+    }
+}
+
+
+public class ConversationChartCodeResponse
+{
+    public string Code { get; set; }
+    public string Language { get; set; }
+
+    public static ConversationChartCodeResponse? From(ChartCodeResult? result)
+    {
+        if (result == null)
+        {
+            return null;
+        }
+
+        return new()
+        {
+            Code = result.Code,
+            Language = result.Language
+        };
+    }
+}

src/Plugins/BotSharp.Plugin.ChartHandler/data/agents/6745151e-6d46-4a02-8de4-1c4f21c7da95/templates/util-chart-plot_instruction.liquid

@@ -7,23 +7,24 @@ You must strictly follow the "Hard Requirements", "Render Requirements", "Code R
 
 ***** Hard Requirements *****
 ** Your output javascript code must be wrapped in one or multiple <script>...</script> blocks with everything needed inside.
-** You need to import ECharts.js exactly once to plot the charts. The script source is "https://cdnjs.cloudflare.com/ajax/libs/echarts/5.5.1/echarts.min.js".
+** You need to import ECharts.js exactly once to plot the charts. The script source is "https://cdnjs.cloudflare.com/ajax/libs/echarts/6.0.0/echarts.min.js".
 ** You must add an ECharts Toolbox bar at the top left corner of the chart.
 ** ALWAYS add a "Full screen" button right next to the Toolbox bar.
 ** The "Full screen" button can toggle the chart container in and out of fullscreen using the Fullscreen API. Requirements for this button:
     * Always call the Fullscreen API on the chart container div itself (document.getElementById("{{ chart_element_id }}")), not on the document.
+    * When entering fullscreen, the chart container must have widhth: 100vw and height: 100vh.
     * Use el.requestFullscreen() with fallbacks to el.webkitRequestFullscreen || el.msRequestFullscreen.
     * Exit fullscreen with document.exitFullscreen() and vendor fallbacks.
     * Listen for fullscreenchange, webkitfullscreenchange, and msfullscreenchange to keep the button working across repeated clicks and ESC exits.
     * Ensure the chart fully expands and scales to the entire screen when fullscreen is active.
     * fullscreenBtn must be a fully-formed object {show: true, name, title, icon: 'path://M3 3 H9 V5 H5 V9 H3 Z M15 3 H21 V9 H19 V5 H15 Z M3 15 H5 V19 H9 V21 H3 Z M19 15 H21 V21 H15 V19 H19 Z', onclick}.
     * When using "chart.setOption" to define the fullscreen button, DO NOT use "graphic". Include the fullscreenBtn object in toolbox.feature with name 'myFullscreen'.
+** Initialize the chart with explicit non-zero width (at least 800px) and non-zero height (at least 500px).
 
 
 ***** Render Requirements *****
 ** You must render the charts under the div html element with id {{ chart_element_id }}.
 ** You must not create any new html element.
-** You must ensure the generated charts have visible height (at least 500px) and width (at least 800px). DO NOT generate charts with zero height or zero width.
 ** You must not apply any styles on any html element.