HFPlanner

Author: Oceania2018

docs/architecture/hooks.md

@@ -47,4 +47,16 @@ More information about conversation hook please go to [Conversation Hook](../con
 ```csharp
 Task OnStateLoaded(ConversationState state);
 Task OnStateChanged(string name, string preValue, string currentValue);
+```
+
+### Content Generating Hook
+`IContentGeneratingHook`
+
+Model content generating hook, it can be used for logging, metrics and tracing.
+```csharp
+// Before content generating.
+Task BeforeGenerating(Agent agent, List<RoleDialogModel> conversations);
+
+// After content generated.
+Task AfterGenerated(RoleDialogModel message, TokenStatsModel tokenStats);
 ```

src/Infrastructure/BotSharp.Abstraction/Conversations/IConversationService.cs

@@ -3,6 +3,7 @@ namespace BotSharp.Abstraction.Conversations;
 public interface IConversationService
 {
     IConversationStateService States { get; }
+    string ConversationId { get; }
     Task<Conversation> NewConversation(Conversation conversation);
     void SetConversationId(string conversationId, List<string> states);
     Task<Conversation> GetConversation(string id);

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

@@ -1,10 +1,12 @@
 using BotSharp.Abstraction.Functions.Models;
-using BotSharp.Abstraction.Models;
 
 namespace BotSharp.Abstraction.Conversations.Models;
 
 public class RoleDialogModel : ITrackableMessage
 {
+    /// <summary>
+    /// If Role is Assistant, it is same as user's message id.
+    /// </summary>
     public string MessageId { get; set; }
 
     /// <summary>

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

@@ -3,6 +3,7 @@ namespace BotSharp.Abstraction.Conversations.Models;
 public class TokenStatsModel
 {
     public string Model { get; set; }
+    public string Prompt { get; set; }
     public int PromptCount { get; set; }
     public int CompletionCount { get; set; }
 

src/Infrastructure/BotSharp.Abstraction/MLTasks/ITextCompletion.cs

@@ -13,5 +13,5 @@ public interface ITextCompletion
     /// <param name="model"></param>
     void SetModelName(string model);
 
-    Task<string> GetCompletion(string text);
+    Task<string> GetCompletion(string text, string agentId, string messageId);
 }

src/Infrastructure/BotSharp.Abstraction/Planning/IExecutor.cs

@@ -5,9 +5,8 @@ namespace BotSharp.Abstraction.Planning;
 
 public interface IExecutor
 {
-    Task<bool> Execute(IRoutingService routing, 
-        Agent router,
+    Task<RoleDialogModel> Execute(IRoutingService routing, 
         FunctionCallFromLlm inst,
-        List<RoleDialogModel> dialogs,
-        RoleDialogModel message);
+        RoleDialogModel message,
+        List<RoleDialogModel> dialogs);
 }

src/Infrastructure/BotSharp.Abstraction/Planning/IPlaner.cs

@@ -7,7 +7,7 @@ namespace BotSharp.Abstraction.Planning;
 /// </summary>
 public interface IPlaner
 {
-    Task<FunctionCallFromLlm> GetNextInstruction(Agent router);
+    Task<FunctionCallFromLlm> GetNextInstruction(Agent router, string messageId);
     Task<bool> AgentExecuting(FunctionCallFromLlm inst, RoleDialogModel message);
     Task<bool> AgentExecuted(FunctionCallFromLlm inst, RoleDialogModel message);
 }

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

@@ -1,5 +1,4 @@
 using BotSharp.Abstraction.Functions.Models;
-using BotSharp.Abstraction.Planning;
 
 namespace BotSharp.Abstraction.Routing;
 
@@ -15,9 +14,7 @@ public interface IRoutingHandler
     bool Enabled => true;
     List<ParameterPropertyDef> Parameters => new List<ParameterPropertyDef>();
 
-    void SetRouter(Agent router) { }
-
-    void SetDialogs(List<RoleDialogModel> dialogs) { }
+    void SetDialogs(List<RoleDialogModel> dialogs);
 
     Task<bool> Handle(IRoutingService routing, FunctionCallFromLlm inst, RoleDialogModel message);
 }

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

@@ -2,10 +2,9 @@ namespace BotSharp.Abstraction.Routing;
 
 public interface IRoutingService
 {
-    List<RoleDialogModel> Dialogs { get; }
+    Agent Router { get; }
     void ResetRecursiveCounter();
-    void RefreshDialogs();
-    Task<bool> InvokeAgent(string agentId, RoleDialogModel message);
-    Task<bool> InstructLoop(RoleDialogModel message);
-    Task<bool> ExecuteOnce(Agent agent, RoleDialogModel message);
+    Task<bool> InvokeAgent(string agentId, List<RoleDialogModel> dialogs);
+    Task<RoleDialogModel> InstructLoop(RoleDialogModel message);
+    Task<RoleDialogModel> ExecuteOnce(Agent agent, RoleDialogModel message);
 }

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

@@ -5,7 +5,6 @@ namespace BotSharp.Abstraction.Routing;
 
 public abstract class RoutingHandlerBase
 {
-    protected Agent _router;
     protected readonly IServiceProvider _services;
     protected readonly ILogger _logger;
     protected RoutingSettings _settings;
@@ -20,11 +19,6 @@ public RoutingHandlerBase(IServiceProvider services,
         _settings = settings;
     }
 
-    public void SetRouter(Agent router)
-    {
-        _router = router;
-    }
-
     public void SetDialogs(List<RoleDialogModel> dialogs)
     {
         _dialogs = dialogs;