Merge from master into add_richCoontent Branch

Author: Yanan Wang

docs/channels/components.md

@@ -1,6 +1,6 @@
 # Messaging Components
 
-Conversations are a lot more than simple text messages when you are building a AI chatbot.  In addition to text, the `BotSharp`` allows you to send rich-media, like audio, video, and images, and provides a set of structured messaging options in the form of message templates, quick replies, buttons and more. The UI rendering program can render components according to the returned data format.
+Conversations are a lot more than simple text messages when you are building a AI chatbot.  In addition to text, the `BotSharp` allows you to send rich-media, like audio, video, and images, and provides a set of structured messaging options in the form of message templates, quick replies, buttons and more. The UI rendering program can render components according to the returned data format.
 
 
 ## Text Messages
@@ -75,7 +75,7 @@ Message templates are structured message formats used for various purposes to pr
                     ...
                 }
             ]
-        }
+          }
         }
     }
 }

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

@@ -1,36 +1,9 @@
+using BotSharp.Abstraction.Models;
+
 namespace BotSharp.Abstraction.Conversations.Models;
 
-public class IncomingMessageModel
+public class IncomingMessageModel : MessageConfig
 {
     public string Text { get; set; } = string.Empty;
-
-    public virtual string Channel { get; set; } = string.Empty;
-
-    /// <summary>
-    /// Completion Provider
-    /// </summary>
-    [JsonPropertyName("provider")]
-    public virtual string? Provider { get; set; } = null;
-
-    /// <summary>
-    /// Model name
-    /// </summary>
-    [JsonPropertyName("model")]
-    public virtual string? Model { get; set; } = null;
-
-    /// <summary>
-    /// The sampling temperature to use that controls the apparent creativity of generated completions.
-    /// </summary>
-    public float Temperature { get; set; } = 0.5f;
-
-    /// <summary>
-    /// An alternative value to Temperature, called nucleus sampling, that causes
-    /// the model to consider the results of the tokens with probability mass.
-    /// </summary>
-    public float SamplingFactor { get; set; } = 0.5f;
-
-    /// <summary>
-    /// Conversation states from input
-    /// </summary>
-    public List<string> States { get; set; } = new List<string>();
+    public virtual string Channel { get; set; }
 }

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

@@ -1,7 +1,12 @@
+using BotSharp.Abstraction.Functions.Models;
+using BotSharp.Abstraction.Models;
+
 namespace BotSharp.Abstraction.Conversations.Models;
 
-public class RoleDialogModel
+public class RoleDialogModel : ITrackableMessage
 {
+    public string MessageId { get; set; }
+
     /// <summary>
     /// user, system, assistant, function
     /// </summary>
@@ -36,10 +41,17 @@ public class RoleDialogModel
     [JsonIgnore(Condition = JsonIgnoreCondition.Always)]
     public bool StopCompletion { get; set; }
 
+    public FunctionCallFromLlm Instruction { get; set; }
+
+    private RoleDialogModel()
+    {
+    }
+
     public RoleDialogModel(string role, string text)
     {
         Role = role;
         Content = text;
+        MessageId = Guid.NewGuid().ToString();
     }
 
     public override string ToString()

src/Infrastructure/BotSharp.Abstraction/Functions/Models/FunctionDef.cs

@@ -4,6 +4,7 @@ public class FunctionDef
 {
     public string Name { get; set; }
     public string Description { get; set; }
+    public string? Impact { get; set; }
     public FunctionParametersDef Parameters { get; set; } = new FunctionParametersDef();
 
     public override string ToString()

src/Infrastructure/BotSharp.Abstraction/Instructs/Models/InstructResult.cs

@@ -1,7 +1,10 @@
+using BotSharp.Abstraction.Models;
+
 namespace BotSharp.Abstraction.Instructs.Models;
 
-public class InstructResult
+public class InstructResult : ITrackableMessage
 {
+    public string MessageId { get; set; }
     public string Text { get; set; }
     public object Data { get; set; }
     public ConversationState States { get; set; }

src/Infrastructure/BotSharp.Abstraction/Models/ITrackableMessage.cs

@@ -0,0 +1,9 @@
+namespace BotSharp.Abstraction.Models;
+
+/// <summary>
+/// Define a message ID to extend message-level applications, such as model fees, token usage, and data collection
+/// </summary>
+public interface ITrackableMessage
+{
+    string MessageId { get; set; }
+}

src/Infrastructure/BotSharp.Abstraction/Models/MessageConfig.cs

@@ -0,0 +1,32 @@
+namespace BotSharp.Abstraction.Models;
+
+public class MessageConfig
+{
+    /// <summary>
+    /// Completion Provider
+    /// </summary>
+    [JsonPropertyName("provider")]
+    public virtual string? Provider { get; set; } = null;
+
+    /// <summary>
+    /// Model name
+    /// </summary>
+    [JsonPropertyName("model")]
+    public virtual string? Model { get; set; } = null;
+
+    /// <summary>
+    /// The sampling temperature to use that controls the apparent creativity of generated completions.
+    /// </summary>
+    public float Temperature { get; set; } = 0.5f;
+
+    /// <summary>
+    /// An alternative value to Temperature, called nucleus sampling, that causes
+    /// the model to consider the results of the tokens with probability mass.
+    /// </summary>
+    public float SamplingFactor { get; set; } = 0.5f;
+
+    /// <summary>
+    /// Conversation states from input
+    /// </summary>
+    public List<string> States { get; set; } = new List<string>();
+}

src/Infrastructure/BotSharp.Abstraction/Routing/IRoutingHandler.cs

@@ -1,5 +1,4 @@
 using BotSharp.Abstraction.Functions.Models;
-using BotSharp.Abstraction.Models;
 
 namespace BotSharp.Abstraction.Routing;
 
@@ -19,5 +18,5 @@ void SetRouter(Agent router) { }
 
     void SetDialogs(List<RoleDialogModel> dialogs) { }
 
-    Task<RoleDialogModel> Handle(IRoutingService routing, FunctionCallFromLlm inst);
+    Task<bool> Handle(IRoutingService routing, FunctionCallFromLlm inst, RoleDialogModel message);
 }

src/Infrastructure/BotSharp.Abstraction/Routing/IRoutingService.cs

@@ -8,7 +8,7 @@ public interface IRoutingService
     void ResetRecursiveCounter();
     void RefreshDialogs();
     Task<FunctionCallFromLlm> GetNextInstruction();
-    Task<RoleDialogModel> InvokeAgent(string agentId);
-    Task<RoleDialogModel> InstructLoop();
-    Task<RoleDialogModel> ExecuteOnce(Agent agent);
+    Task<bool> InvokeAgent(string agentId, RoleDialogModel message);
+    Task<bool> InstructLoop(RoleDialogModel message);
+    Task<bool> ExecuteOnce(Agent agent, RoleDialogModel message);
 }

src/Infrastructure/BotSharp.Abstraction/Routing/Models/RoutingContext.cs

@@ -18,8 +18,11 @@ public RoutingContext(RoutingSettings setting)
     /// </summary>
     public string IntentName { get; set; }
 
+    /// <summary>
+    /// Agent that can handl user original goal.
+    /// </summary>
     public string OriginAgentId
-        => _stack.Last();
+        => _stack.Where(x => x != _setting.RouterId).Last();
 
     public string GetCurrentAgentId()
     {