Merge branch 'master' of https://github.com/SciSharp/BotSharp into features/refine-template-config

Author: Jicheng Lu

README.md

@@ -140,6 +140,57 @@ BotSharp uses component design, the kernel is kept to a minimum, and business fu
 - [x] Multi-Agent Routing
 - [x] Knowledge Base
 
+
+### FAQ
+
+#### General Questions
+
+**What is BotSharp?**
+BotSharp is an open-source .NET machine learning framework for building AI Bot platforms. It provides out-of-the-box components for natural language understanding, computer vision, and audio processing, enabling enterprise developers to integrate AI into business systems efficiently.
+
+**What .NET versions are supported?**
+BotSharp runs on .NET Core, which is fully cross-platform. It supports .NET 6+ and works on Windows, Linux, and macOS.
+
+**Is BotSharp free to use?**
+Yes, BotSharp is licensed under Apache 2.0, allowing free use in both personal and commercial projects.
+
+#### LLM Provider Configuration
+
+**Which LLM providers are supported?**
+BotSharp supports multiple AI platforms including ChatGPT (3.5/4o/o1), Gemini 2, LLaMA 3, Claude Sonnet 3.5, DeepSeek V3, HuggingFace, and more through its modular plugin system.
+
+**How do I configure a custom LLM provider?**
+Create a plugin that implements the LLM provider interface, or use one of the built-in plugins like `BotSharp.Plugin.OpenAI` or `BotSharp.Plugin.AnthropicAI`. Configure the API keys in your `appsettings.json`.
+
+#### Agent Development
+
+**How do I create a custom agent?**
+Define an agent profile with its responsibilities, then implement the required hooks and plugins. BotSharp's advanced Agent abstraction layer handles the complex orchestration automatically.
+
+**Can multiple agents cooperate on a task?**
+Yes, BotSharp supports multi-agent scenarios where agents with different responsibilities can cooperate to complete complex tasks. The routing and planning system handles agent coordination.
+
+#### MCP Integration
+
+**What is MCP and how does BotSharp support it?**
+MCP (Model Context Protocol) enables large model calls to external tools. BotSharp has built-in MCP integration with visual management capabilities, supporting mainstream services like mcp.so.
+
+#### Deployment
+
+**How do I deploy BotSharp in production?**
+Run the backend service using `dotnet run` and deploy it behind a reverse proxy (Nginx/IIS). The Admin UI (built with SvelteKit) can be deployed separately. See the [documentation](https://botsharp.readthedocs.io) for detailed deployment guides.
+
+**Can I use BotSharp without the UI?**
+Yes, BotSharp provides RESTful Open API and WebSocket real-time communication. You can integrate it directly with your own frontend or messaging channels.
+
+#### Troubleshooting
+
+**BotSharp fails to start with dependency errors**
+Ensure you have .NET 6+ SDK installed and all NuGet packages are restored. Run `dotnet restore` before `dotnet run`.
+
+**LLM calls are timing out**
+Check your API key configuration in `appsettings.json`, verify network connectivity to the LLM provider, and ensure the model name is correct.
+
 ### Documents
 
 Read the docs: https://botsharp.readthedocs.io?wt.mc_id=AI-MVP-5005183

src/Infrastructure/BotSharp.Abstraction/Conversations/Dtos/ChatResponseDto.cs

@@ -46,6 +46,10 @@ public class ChatResponseDto : InstructResult
     [JsonPropertyName("is_streaming")]
     public bool IsStreaming { get; set; }
 
+    [JsonPropertyName("thought")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public Dictionary<string, string?>? Thought { get; set; }
+
     [JsonPropertyName("meta_data")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public Dictionary<string, string?>? MetaData { get; set; }

src/Infrastructure/BotSharp.Abstraction/Conversations/Models/Conversation.cs

@@ -114,6 +114,10 @@ public class DialogMetaData
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? ToolCallId { get; set; }
 
+    [JsonPropertyName("thought")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public Dictionary<string, string?>? Thought { get; set; }
+
     [JsonPropertyName("meta_data")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public Dictionary<string, string?>? MetaData { get; set; }

src/Infrastructure/BotSharp.Abstraction/Conversations/Models/RoleDialogModel.cs

@@ -76,6 +76,9 @@ public class RoleDialogModel : ITrackableMessage
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? ToolCallId { get; set; }
 
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public Dictionary<string, string?>? Thought { get; set; }
+
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public Dictionary<string, string?>? MetaData { get; set; }
 
@@ -141,7 +144,6 @@ public class RoleDialogModel : ITrackableMessage
     [JsonIgnore(Condition = JsonIgnoreCondition.Always)]
     public bool IsStreaming { get; set; }
 
-
     [JsonIgnore(Condition = JsonIgnoreCondition.Always)]
     public bool IsFromUser => Role == AgentRole.User;
 
@@ -210,6 +212,7 @@ public static RoleDialogModel From(RoleDialogModel source,
             Data = source.Data,
             IsStreaming = source.IsStreaming,
             Annotations = source.Annotations,
+            Thought = source.Thought != null ? new(source.Thought) : null,
             MetaData = source.MetaData != null ? new(source.MetaData) : null
         };
     }

src/Infrastructure/BotSharp.Abstraction/MLTasks/Settings/LlmModelSetting.cs

@@ -99,7 +99,10 @@ public class ReasoningSetting
 public class WebSearchSetting
 {
     public bool IsDefault { get; set; }
+
+    [Obsolete("Set SearchContextSize in Parameters")]
     public string? SearchContextSize { get; set; }
+    public Dictionary<string, ModelParamSetting>? Parameters { get; set; }
 }
 #endregion
 

src/Infrastructure/BotSharp.Abstraction/Plugins/Models/PluginMenuDef.cs

@@ -76,4 +76,9 @@ public class EmbeddingData
     /// </summary>
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? AppendTokenName { get; set; }
+
+    /// <summary>
+    /// Whether to enable full screen or not
+    /// </summary>
+    public bool FullScreen { get; set; }
 }

src/Infrastructure/BotSharp.Abstraction/Rules/IRuleTrigger.cs

@@ -21,4 +21,10 @@ public interface IRuleTrigger
     /// Explain the purpose of rule trigger (display purpose)
     /// </summary>
     string Statement => string.Empty;
+
+    /// <summary>
+    /// Optional list of agent IDs this trigger is associated with.
+    /// Used for display/filtering in UI only (not used in execution logic).
+    /// </summary>
+    string[]? AgentIds => null;
 }

src/Infrastructure/BotSharp.Abstraction/Rules/RuleGraph.cs

@@ -114,7 +114,7 @@ public void AddEdge(RuleNode from, RuleNode to, EdgeItemPayload payload)
                 Type = payload.Type,
                 Labels = [.. payload.Labels ?? []],
                 Weight = payload.Weight,
-                Purpose = payload.Purpose,
+                Alias = payload.Alias,
                 Description = payload.Description,
                 Config = new(payload.Config ?? [])
             });
@@ -234,9 +234,15 @@ public class GraphItem
     public virtual string Type { get; set; } = null!;
     public virtual IEnumerable<string> Labels { get; set; } = [];
     public virtual double Weight { get; set; } = 1.0;
-    public virtual string? Purpose { get; set; }
     public virtual string? Description { get; set; }
     public virtual Dictionary<string, string?> Config { get; set; } = [];
+
+    private string? _alias;
+    public virtual string Alias
+    {
+        get => string.IsNullOrEmpty(_alias) ? Name : _alias;
+        set => _alias = value;
+    }
 }
 
 public class NodeItem : GraphItem

src/Infrastructure/BotSharp.Core.Rules/Conditions/LogicGateCondition.cs

@@ -1,4 +1,3 @@
-using System.Text.Json;
 using BotSharp.Core.Rules.Models;
 
 namespace BotSharp.Core.Rules.Conditions;
@@ -16,11 +15,13 @@ namespace BotSharp.Core.Rules.Conditions;
 ///   (A AND B) OR (C AND NOT D)
 ///
 /// Leaf node format:
-///   { "node": "node_name", "key": "data_key" }
-///   - "node": The Name of a parent condition node whose result to inspect.
-///   - "key":  The key in the parent node's RuleNodeResult.Data dictionary that holds
-///             a boolean string ("true"/"false"). If omitted, falls back to the parent
-///             node's RuleNodeResult.Success flag.
+///   { "node_alias": "node_alias", "key": "data_key" }
+///   - "node_alias": The Alias of a parent condition node whose result to inspect.
+///                   Using Alias instead of Name avoids collisions when multiple nodes
+///                   share the same Name (e.g. several "http_request" nodes).
+///   - "key":   The key in the parent node's RuleNodeResult.Data dictionary that holds
+///              a boolean string ("true"/"false"). If omitted, falls back to the parent
+///              node's RuleNodeResult.Success flag.
 ///
 /// Node config:
 ///   "expression" - A JSON-encoded LogicExpression tree.
@@ -30,20 +31,20 @@ namespace BotSharp.Core.Rules.Conditions;
 /// Example: work_order_valid AND (client_name_valid OR NOT affiliate_name_valid)
 ///
 ///   Given three parent condition nodes:
-///     - Node A ("check_work_order")  returns Data["work_order_valid"] = "true"
-///     - Node B ("check_client")      returns Data["client_name_valid"] = "false"
-///     - Node C ("check_affiliate")   returns Data["affiliate_name_valid"] = "false"
+///     - Node A (node_alias "check_work_order")  returns Data["work_order_valid"] = "true"
+///     - Node B (node_alias "check_client")      returns Data["client_name_valid"] = "false"
+///     - Node C (node_alias "check_affiliate")   returns Data["affiliate_name_valid"] = "false"
 ///
 ///   The gate node config would be:
 ///     {
 ///       "expression": {
 ///         "op": "and",
 ///         "children": [
-///           { "node": "check_work_order", "key": "work_order_valid" },
+///           { "node_alias": "check_work_order", "key": "work_order_valid" },
 ///           { "op": "or", "children": [
-///               { "node": "check_client", "key": "client_name_valid" },
+///               { "node_alias": "check_client", "key": "client_name_valid" },
 ///               { "op": "not", "children": [
-///                   { "node": "check_affiliate", "key": "affiliate_name_valid" }
+///                   { "node_alias": "check_affiliate", "key": "affiliate_name_valid" }
 ///               ]}
 ///           ]}
 ///         ]
@@ -142,10 +143,10 @@ public async Task<RuleNodeResult> EvaluateAsync(
 
         var defaultValue = currentNode.Config?.GetValueOrDefault("default_value") ?? "false";
 
-        // 3. Build lookup: parent node name → its latest RuleFlowStepResult
+        // 3. Build lookup: parent node alias → its latest RuleFlowStepResult
         var parentResults = (context.PrevStepResults ?? [])
             .Where(r => parentNodeIds.Contains(r.Node.Id))
-            .GroupBy(r => r.Node.Name, StringComparer.OrdinalIgnoreCase)
+            .GroupBy(r => r.Node.Alias, StringComparer.OrdinalIgnoreCase)
             .ToDictionary(g => g.Key, g => g.Last(), StringComparer.OrdinalIgnoreCase);
 
         // 4. Evaluate the expression tree
@@ -167,13 +168,13 @@ private bool Evaluate(
         Dictionary<string, RuleFlowStepResult> parentResults,
         string defaultValue)
     {
-        // Leaf node: look up a specific parent's result
-        if (!string.IsNullOrEmpty(expr.Node))
+        // Leaf node: look up a specific parent's result by alias
+        if (!string.IsNullOrEmpty(expr.NodeAlias))
         {
-            if (!parentResults.TryGetValue(expr.Node, out var stepResult))
+            if (!parentResults.TryGetValue(expr.NodeAlias, out var stepResult))
             {
-                _logger.LogWarning("Logic gate: parent node '{Node}' not found in results, using default '{Default}'.",
-                    expr.Node, defaultValue);
+                _logger.LogWarning("Logic gate: parent node alias '{Alias}' not found in results, using default '{Default}'.",
+                    expr.NodeAlias, defaultValue);
                 return ParseBool(defaultValue);
             }
 

src/Infrastructure/BotSharp.Core.Rules/Engines/RuleEngine.cs

@@ -234,7 +234,7 @@ private async Task ExecuteGraphTraversal(
                 Edge = nextEdge,
                 Graph = graph,
                 Text = text,
-                Parameters = BuildParameters(nextNode.Config, states, innerData),
+                Parameters = BuildParameters(states, innerData),
                 PrevStepResults = results,
                 JsonOptions = options?.JsonOptions
             };
@@ -702,17 +702,11 @@ private void ValidateGraphSchema(RuleGraph graph)
 
     #region Private methods
     private Dictionary<string, string?> BuildParameters(
-        Dictionary<string, string?>? config,
         IEnumerable<MessageState>? states,
         Dictionary<string, string?>? param = null)
     {
         var dict = new Dictionary<string, string?>();
 
-        if (config != null)
-        {
-            dict = new(config);
-        }
-
         if (!states.IsNullOrEmpty())
         {
             foreach (var state in states!)