SemianiakaVY/BotSharp
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master' into jason_dev

Browse source
This commit is contained in:
jason 2024-12-06 12:37:21 +08:00
parent 09b1f3e234 f2dc57c6b7
commit ed27520757
56 changed files with 992 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

459
docs/architecture/agent-utility.md Normal file
View file

@ -0,0 +1,459 @@
# Agent Utility
## Introduction
This document aims to introduce the agent utility concept and provide an instruction on adding custom agent utilities in AI project “BotSharp”. We will start by explaining the mechanism of agent utility in [Section 2](#agent-utility). Then, we illustrate the custom agent utility setup and integration in [Section 3](#agent-utility-setup) and [Section 4](#agent-utility-integration), respectively. A use case will be demonstrated in [Section 5](#use-case-demo). We wrap up the document with a short summary.
## Agent Utility
The agent utility is a unique feature that can be integrated into agent to enhance its capability. Its core principle is that it can dynamically and seamlessly add extra prompts and add task-oriented functions (or tools) during conversation, without disrupting the agent’s primary purpose. In other words, the agent utility can perform extra tasks based on the context of conversation. Typical examples of agent utility include reading images/pdf, generating image, and sending http requests. [Fig 2.1.1](#agent-utility-example) demonstrates an example of these utilities. In this example, “Chatbot” is a simple agent to answer user questions and the utilities extend its capability to explain image content, generate requested image, and send a specific http request.
<div id="agent-utility-example">
<img src="assets/agent-utility/agent-utility-example.png" style="display: block; margin: auto;" />
</div>
<br />
## Agent Utility Setup
In this section, we outline the steps to set up a custom agent utility. We start with the basic code structure and then add essential utility data, such as prompts and functions. The utility hooks are used to incorporate the utility into the agent. Finally, we give a brief overview of the utility implementation.
### Basic Code Structure
The basic code structure of a typical agent utility includes prompt/function data, hooks, and function implementation. We can add specific utility prompts and functions in different projects. Note that the agent “6745151e-6d46-4a02-8de4-1c4f21c7da95” is considered as a dedicated utility assistant, and every prompt and function can be optionally used as a utility. [Fig 3.1.1](#agent-utility-code-structure) presents the structure of prompt, function, hooks, and implementation of an http utility.
<div id="agent-utility-code-structure">
<img src="assets/agent-utility/agent-utility-code-structure.png" style="display: block; margin: auto;" />
</div>
<br />
### Utility Data
For a typical agent utility, it is essential to add at least a prompt and a function. The prompt is added under the “templates” folder and its recommended name is “[function name].fn.liquid”, while the function is added under the “functions” folder and its recommended name is “[function name].json”. Once we compile the project, we can find the aggregated utility assistant folder at location: “\BotSharp\src\WebStarter\bin\Debug\net8.0\data\agents\6745151e-6d46-4a02-8de4-1c4f21c7da95”.
### Utility Hooks
The utility hooks are used to connect the agent utility to the agent system. The code snippet below demonstrates an implementation of the http utility hook, where we define the utility name, prompts and functions. Note that each utility can be used across different agents.
```csharp
public class HttpHandlerPlugin : IBotSharpPlugin
{
public string Id => "2c1eb1c4-16e5-4c65-8ee4-032324c26b81";
public string Name => "HTTP Handler";
public string Description => "Empower agent to handle HTTP request in RESTful API or GraphQL";
public string IconUrl => "https://lirp.cdn-website.com/6f8d6d8a/dms3rep/multi/opt/API_Icon-640w.png";
public string[] AgentIds => new[] { "87c458fc-ec5f-40ae-8ed6-05dda8a07523" };
public void RegisterDI(IServiceCollection services, IConfiguration config)
{
services.AddScoped(provider =>
{
var settingService = provider.GetRequiredService<ISettingService>();
return settingService.Bind<HttpHandlerSettings>("HttpHandler");
});
services.AddScoped<IAgentUtilityHook, HttpHandlerUtilityHook>();
}
}
```
The agent hook is used to append the utility prompt and function during the conversation. Note that the utility data is only allowed to be included in the context of conversation. The utility mechanism is implemented in the “OnAgentUtilityLoaded” hook, and it is invoked when we load any agent.
```csharp
public async Task<Agent> LoadAgent(string id)
{
if (string.IsNullOrEmpty(id) || id == Guid.Empty.ToString())
{
return null;
}
var hooks = _services.GetServices<IAgentHook>();
// Before agent is loaded.
foreach (var hook in hooks)
{
if (!string.IsNullOrEmpty(hook.SelfId) && hook.SelfId != id)
{
continue;
}
hook.OnAgentLoading(ref id);
}
var agent = await GetAgent(id);
if (agent == null)
{
return null;
}
await InheritAgent(agent);
OverrideInstructionByChannel(agent);
AddOrUpdateParameters(agent);
// Populate state into dictionary
agent.TemplateDict = new Dictionary<string, object>();
PopulateState(agent.TemplateDict);
// After agent is loaded
foreach (var hook in hooks)
{
if (!string.IsNullOrEmpty(hook.SelfId) && hook.SelfId != id)
{
continue;
}
hook.SetAget(agent);
if (!string.IsNullOrEmpty(agent.Instruction))
{
hook.OnInstructionLoaded(agent.Instruction, agent.TemplateDict);
}
if (agent.Functions != null)
{
hook.OnFunctionsLoaded(agent.Functions);
}
if (agent.Samples != null)
{
hook.OnSamplesLoaded(agent.Samples);
}
hook.OnAgentUtilityLoaded(agent);
hook.OnAgentLoaded(agent);
}
_logger.LogInformation($"Loaded agent {agent}.");
return agent;
}
```
### Utility Function Implementation
Here we introduce a simple utility function implementation. The actual content depends on what task you want this utility to fulfill. The code snippet below illustrates the implementation of the “handle http request” function. Note that the property “Name” must be consistent with the function added in the utility data. The “Indication” is an optional property whose content will be displayed in the chat while the user is waiting for the assistant response.
```csharp
public class HandleHttpRequestFn : IFunctionCallback
{
public string Name => "handle_http_request";
public string Indication => "Handling http request";
private readonly IServiceProvider _services;
private readonly ILogger<HandleHttpRequestFn> _logger;
private readonly IHttpClientFactory _httpClientFactory;
private readonly IHttpContextAccessor _context;
private readonly BotSharpOptions _options;
public HandleHttpRequestFn(IServiceProvider services,
ILogger<HandleHttpRequestFn> logger,
IHttpClientFactory httpClientFactory,
IHttpContextAccessor context,
BotSharpOptions options)
{
_services = services;
_logger = logger;
_httpClientFactory = httpClientFactory;
_context = context;
_options = options;
}
public async Task<bool> Execute(RoleDialogModel message)
{
var args = JsonSerializer.Deserialize<LlmContextIn>(message.FunctionArgs, _options.JsonSerializerOptions);
var url = args?.RequestUrl;
var method = args?.HttpMethod;
var content = args?.RequestContent;
try
{
var response = await SendHttpRequest(url, method, content);
var responseContent = await HandleHttpResponse(response);
message.Content = responseContent;
return true;
}
catch (Exception ex)
{
var msg = $"Fail when sending http request. Url: {url}, method: {method}, content: {content}";
_logger.LogWarning($"{msg}\n(Error: {ex.Message})");
message.Content = msg;
return false;
}
}
private async Task<HttpResponseMessage?> SendHttpRequest(string? url, string? method, string? content)
{
if (string.IsNullOrEmpty(url)) return null;
using var client = _httpClientFactory.CreateClient();
AddRequestHeaders(client);
var (uri, request) = BuildHttpRequest(url, method, content);
var response = await client.SendAsync(request);
if (response == null || !response.IsSuccessStatusCode)
{
_logger.LogWarning($"Response status code: {response?.StatusCode}");
}
return response;
}
private void AddRequestHeaders(HttpClient client)
{
client.DefaultRequestHeaders.Add("Authorization", $"{_context.HttpContext.Request.Headers["Authorization"]}");
var settings = _services.GetRequiredService<HttpHandlerSettings>();
var origin = !string.IsNullOrEmpty(settings.Origin) ? settings.Origin : $"{_context.HttpContext.Request.Headers["Origin"]}";
if (!string.IsNullOrEmpty(origin))
{
client.DefaultRequestHeaders.Add("Origin", origin);
}
}
private (Uri, HttpRequestMessage) BuildHttpRequest(string url, string? method, string? content)
{
var httpMethod = GetHttpMethod(method);
StringContent httpContent;
var requestUrl = url;
if (httpMethod == HttpMethod.Get)
{
httpContent = BuildHttpContent("{}");
requestUrl = BuildQuery(url, content);
}
else
{
httpContent = BuildHttpContent(content);
}
if (!Uri.TryCreate(requestUrl, UriKind.Absolute, out var uri))
{
var settings = _services.GetRequiredService<HttpHandlerSettings>();
var baseUri = new Uri(settings.BaseAddress);
uri = new Uri(baseUri, requestUrl);
}
return (uri, new HttpRequestMessage
{
RequestUri = uri,
Method = httpMethod,
Content = httpContent
});
}
private HttpMethod GetHttpMethod(string? method)
{
var localMethod = method?.Trim()?.ToUpper();
HttpMethod matchMethod;
switch (localMethod)
{
case "GET":
matchMethod = HttpMethod.Get;
break;
case "DELETE":
matchMethod = HttpMethod.Delete;
break;
case "PUT":
matchMethod = HttpMethod.Put;
break;
case "Patch":
matchMethod = HttpMethod.Patch;
break;
default:
matchMethod = HttpMethod.Post;
break;
}
return matchMethod;
}
private StringContent BuildHttpContent(string? content)
{
var str = string.Empty;
try
{
var json = JsonSerializer.Deserialize<JsonDocument>(content ?? "{}", _options.JsonSerializerOptions);
str = JsonSerializer.Serialize(json, _options.JsonSerializerOptions);
}
catch (Exception ex)
{
_logger.LogWarning($"Error when build http content: {content}\n(Error: {ex.Message})");
}
return new StringContent(str, Encoding.UTF8, MediaTypeNames.Application.Json);
}
private string BuildQuery(string url, string? content)
{
if (string.IsNullOrEmpty(url) || string.IsNullOrEmpty(content)) return url;
try
{
var queries = new List<string>();
var json = JsonSerializer.Deserialize<JsonDocument>(content, _options.JsonSerializerOptions);
var root = json.RootElement;
foreach (var prop in root.EnumerateObject())
{
var name = prop.Name.Trim();
var value = prop.Value.ToString().Trim();
if (string.IsNullOrEmpty(name) || string.IsNullOrEmpty(value))
{
continue;
}
queries.Add($"{name}={value}");
}
if (!queries.IsNullOrEmpty())
{
url += $"?{string.Join('&', queries)}";
}
return url;
}
catch (Exception ex)
{
_logger.LogWarning($"Error when building url query. Url: {url}, Content: {content}\n(Error: {ex.Message})");
return url;
}
}
private async Task<string> HandleHttpResponse(HttpResponseMessage? response)
{
if (response == null) return string.Empty;
return await response.Content.ReadAsStringAsync();
}
}
```
### Utility Inheritance
Here we introduce a new feature: utility inheritance. As we are using the routing-based multi-agent architecture, different agents may come into the call stack while we are handling user requests. With the utility inheritance, the agent can not only use the utilities added to itself but also inherit the utilities from the entry agent, which is the first agent that comes into the call stack, such as a router agent. [Fig 3.5.1](#routing-architecture) illustrates a typical example of routing-based multi-agent architecture, where “Pizza Bot” is the router and "Order Inquery", "Ordering", "Payment" are task agents. When the user starts chatting, “Pizza Bot” first comes into the call stack, with "Order Inquery", "Ordering", or "Payment" joining next depending on what the user actually requests. For example, if we allow "Order Inquery" to inherit utilities, all the utilities from itself as well as “Pizza Bot” will be invoked once the "Order Inquery" agent is in action.
<div id="routing-architecture">
<img src="assets/agent-utility/routing-arch.png" style="display: block; margin: auto;" />
</div>
<br />
### Agent Setup
Here we introduce the agent setup with utilities and inheritance. As we introduced in [Section 3.3](#utility-hooks), each utility of an agent is structured with utility name, functions, and prompts. [Fig 3.6.1](#router-utility-ui) and [Fig 3.6.2](#task-agent-utility-ui) presents the utility configuration and utility inheritance of “Pizza Bot” and “Order Inquery”, respectively. As is displayed, we can apply the utility configuration and inheritance via agent files or agent detail ui. Note that we can uncheck the box to disable a utility ([Fig 3.6.2](#router-utility-ui)).
```json
{
"id": "8970b1e5-d260-4e2c-90b1-f1415a257c18",
"name": "Pizza Bot",
"description": "AI assistant that can help customer place pizza order.",
"type": "routing",
"inheritAgentId": "01fcc3e5-9af7-49e6-ad7a-a760bd12dc4a",
"createdDateTime": "2023-08-18T10:39:32.2349685Z",
"updatedDateTime": "2023-08-18T14:39:32.2349686Z",
"iconUrl": "https://cdn-icons-png.flaticon.com/512/6978/6978255.png",
"disabled": false,
"isPublic": true,
"profiles": [ "pizza" ],
"utilities": [
{
"name": "http_handler",
"functions": [
{ "name": "handle_http_request" }
],
"templates": [
{ "name": "handle_http_request.fn" }
]
}
],
"routingRules": [
{
"type": "reasoner",
"field": "NaiveReasoner"
}
]
}
```
<br />
<div id="router-utility-ui">
<img src="assets/agent-utility/router-utility-ui.png" style="display: block; margin: auto;" />
</div>
<br />
<br />
<br />
```json
{
"name": "Order Inquiry",
"description": "Check the order status like payment, delivery or baking.",
"createdDateTime": "2023-08-18T14:39:32.2349685Z",
"updatedDateTime": "2023-08-18T14:39:32.2349686Z",
"id": "b284db86-e9c2-4c25-a59e-4649797dd130",
"disabled": false,
"isPublic": true,
"mergeUtility": true,
"profiles": [ "pizza" ]
}
```
<br />
<div id="task-agent-utility-ui">
<img src="assets/agent-utility/task-agent-utility-ui.png" style="display: block; margin: auto;" />
</div>
<br />
## Agent Utility Integration
In this section, we outline the steps to integrate a custom agent utility, including registering plugin, registering assembly, and adding project reference.
The code snippet below presents the “Http Handler Plugin” in the “BotSharp.Plugin.HttpHandler”, where we can register the hooks and other essential settings. Note that there is no need to register the function here, since it is automatically registered on the application level.
```csharp
public class HttpHandlerPlugin : IBotSharpPlugin
{
public string Id => "2c1eb1c4-16e5-4c65-8ee4-032324c26b81";
public string Name => "HTTP Handler";
public string Description => "Empower agent to handle HTTP request in RESTful API or GraphQL";
public string IconUrl => "https://lirp.cdn-website.com/6f8d6d8a/dms3rep/multi/opt/API_Icon-640w.png";
public string[] AgentIds => new[] { "87c458fc-ec5f-40ae-8ed6-05dda8a07523" };
public void RegisterDI(IServiceCollection services, IConfiguration config)
{
services.AddScoped(provider =>
{
var settingService = provider.GetRequiredService<ISettingService>();
return settingService.Bind<HttpHandlerSettings>("HttpHandler");
});
services.AddScoped<IAgentUtilityHook, HttpHandlerUtilityHook>();
}
}
```
[Fig 4.1.2](#register-assembly) demonstrates the utility assembly registration in “appsettings.json”. It is important to note that we are required to add the project reference to the Startup project, e.g., WebStarter. Moreover, we are required to add any new custom agent utility in the “Plugin” folder instead of the “BotSharp” folder.
<div style="text-align: center;" id="register-assembly">
<img src="assets/agent-utility/register-assembly.png" />
</div>
<br />
## Use Case Demo
In this section, we demonstrate an http utility. After we set up and integrate the custom agent utility in backend, we can start the BotSharp-UI and go to any specific agent. [Fig 5.1.1](#add-utility) shows an example of the “Chatbot” agent, where we can add any registered utilities in the highlight section.
<div style="text-align: center;" id="add-utility">
<img src="assets/agent-utility/add-utility.png" />
</div>
<br />
Once we add the utility, we can initialize a conversation by clicking the bot icon at the top left corner. [Fig 5.1.2](#chat-window-demo) shows the conversation window, where we can find the number of utilities at the left panel. We can also click the agent name to go back to the agent page.
<div style="text-align: center;" id="chat-window-demo">
<img src="assets/agent-utility/chat-window-demo.png" />
</div>
<br />
Here we use dummy rest APIs (source: https://dummy.restapiexample.com/) for the demo purpose. [Fig 5.1.3](#dummy-http) displays the various http requests sent in the conversation with “Chatbot”. We can see that the “Http Handler” utility has successfully extends the agent to send http request and receive response.
<div style="text-align: center;" id="dummy-http">
<img src="assets/agent-utility/dummy-http.png" />
</div>
<br />
## Summary
In this document, we introduce the agent utility concept and provide a step-by-step instruction on adding custom agent utilities in AI project “BotSharp”.
The agent utility is designed for enhancing the agent capability to perform dedicated tasks, such as sending http request, reading images, and generating images, by adding extra prompts and functions.
The agent utility setup and integration are explained step by step in [Section 3](#agent-utility-setup) and [Section 4](#agent-utility-integration), respectively.
We end up the document by demonstrating the Http utility, where we prove the utility can handle various http requests in the chat with agents.

BIN
docs/architecture/assets/agent-utility/add-utility.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
docs/architecture/assets/agent-utility/agent-utility-code-structure.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 87 KiB

BIN
docs/architecture/assets/agent-utility/agent-utility-example.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 107 KiB

BIN
docs/architecture/assets/agent-utility/chat-window-demo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
docs/architecture/assets/agent-utility/dummy-http.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 103 KiB

BIN
docs/architecture/assets/agent-utility/register-assembly.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 29 KiB

BIN
docs/architecture/assets/agent-utility/router-utility-ui.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
docs/architecture/assets/agent-utility/routing-arch.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
docs/architecture/assets/agent-utility/task-agent-utility-ui.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.5 KiB

1
docs/index.rst
View file

@ -115,6 +115,7 @@ The main documentation for the site is organized into the following sections:
architecture/plugin
architecture/hooks
architecture/routing
architecture/agent-utility
architecture/logging
architecture/data-persistence

9
src/Infrastructure/BotSharp.Abstraction/Agents/AgentHookBase.cs
View file

@ -71,7 +71,14 @@ public abstract class AgentHookBase : IAgentHook
var (functions, templates) = GetUtilityContent(agent);
agent.Functions.AddRange(functions);
foreach (var fn in functions)
{
if (!agent.Functions.Any(x => x.Name.Equals(fn.Name, StringComparison.OrdinalIgnoreCase)))
{
agent.Functions.Add(fn);
}
}
foreach (var prompt in templates)
{
agent.Instruction += $"\r\n\r\n{prompt}\r\n\r\n";

10
src/Infrastructure/BotSharp.Abstraction/Agents/Enums/BuiltInAgentId.cs
View file

@ -51,4 +51,14 @@ public class BuiltInAgentId
/// Evaluate prompt and conversation
/// </summary>
public const string Evaluator = "dfd9b46d-d00c-40af-8a75-3fbdc2b89869";
/// <summary>
/// Translates user-defined natural language rules into programmatic code
/// </summary>
public const string RuleEncoder = "6acfb93c-3412-402e-9ba5-c5d3cd8f0161";
/// <summary>
/// Schedule job
/// </summary>
public const string Crontab = "c2o139da-a62a-4355-8605-fdf0ffaca58e";
}

1
src/Infrastructure/BotSharp.Abstraction/Conversations/Enums/ConversationChannel.cs
View file

@ -7,4 +7,5 @@ public class ConversationChannel
public const string Phone = "phone";
public const string Messenger = "messenger";
public const string Email = "email";
public const string Cron = "cron";
}

7
src/Infrastructure/BotSharp.Abstraction/Infrastructures/IDistributedLocker.cs Normal file
View file

@ -0,0 +1,7 @@
namespace BotSharp.Abstraction.Infrastructures;
public interface IDistributedLocker
{
bool Lock(string resource, Action action, int timeout = 30);
Task<bool> LockAsync(string resource, Func<Task> action, int timeout = 30);
}

3
src/Infrastructure/BotSharp.Abstraction/Planning/IPlanningHook.cs
View file

@ -5,6 +5,9 @@ public interface IPlanningHook
Task<string> GetSummaryAdditionalRequirements(string planner, RoleDialogModel message)
=> Task.FromResult(string.Empty);
Task OnSourceCodeGenerated(string planner, RoleDialogModel msg, string language)
=> Task.CompletedTask;
Task OnPlanningCompleted(string planner, RoleDialogModel msg)
=> Task.CompletedTask;
}

5
src/Infrastructure/BotSharp.Abstraction/Repositories/Filters/RoleFilter.cs
View file

@ -15,4 +15,9 @@ public class RoleFilter
{
return new RoleFilter();
}
public bool IsInit()
{
return Names.IsNullOrEmpty();
}
}

8
src/Infrastructure/BotSharp.Core.Crontab/Abstraction/ICrontabHook.cs Normal file
View file

@ -0,0 +1,8 @@
using BotSharp.Core.Crontab.Models;
namespace BotSharp.Core.Crontab.Abstraction;
public interface ICrontabHook
{
Task OnCronTriggered(CrontabItem item);
}

9
src/Infrastructure/BotSharp.Core.Crontab/Abstraction/ICrontabService.cs Normal file
View file

@ -0,0 +1,9 @@
using BotSharp.Core.Crontab.Models;
namespace BotSharp.Core.Crontab.Abstraction;
public interface ICrontabService
{
Task<List<CrontabItem>> GetCrontable();
Task ScheduledTimeArrived(CrontabItem item);
}

28
src/Infrastructure/BotSharp.Core.Crontab/BotSharp.Core.Crontab.csproj Normal file
View file

@ -0,0 +1,28 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<None Remove="data\agents\c2o139da-a62a-4355-8605-fdf0ffaca58e\agent.json" />
</ItemGroup>
<ItemGroup>
<Content Include="data\agents\c2o139da-a62a-4355-8605-fdf0ffaca58e\agent.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\BotSharp.Abstraction\BotSharp.Abstraction.csproj" />
<ProjectReference Include="..\BotSharp.Core\BotSharp.Core.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="NCrontab" Version="3.3.3" />
</ItemGroup>
</Project>

40
src/Infrastructure/BotSharp.Core.Crontab/CrontabPlugin.cs Normal file
View file

@ -0,0 +1,40 @@
/*****************************************************************************
Copyright 2024 Written by Haiping Chen. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
******************************************************************************/
namespace BotSharp.Core.Crontab;
/// <summary>
/// Crontab plugin is a time-based job scheduler in agent framework.
/// The cron system is used for automating repetitive tasks, such as trigger AI Agent to do specific task periodically.
/// </summary>
public class CrontabPlugin : IBotSharpPlugin
{
public string Id => "3155c15e-28d3-43f7-8ead-fc43324ec21a";
public string Name => "BotSharp Crontab";
public string Description => "Crontab plugin is a time-based job scheduler in agent framework. The cron system is used to trigger AI Agent to do specific task periodically.";
public string IconUrl => "https://icon-library.com/images/stop-watch-icon/stop-watch-icon-10.jpg";
public string[] AgentIds =
[
BuiltInAgentId.Crontab
];
public void RegisterDI(IServiceCollection services, IConfiguration config)
{
services.AddScoped<ICrontabService, CrontabService>();
services.AddHostedService<CrontabWatcher>();
}
}

14
src/Infrastructure/BotSharp.Core.Crontab/Models/CrontabItem.cs Normal file
View file

@ -0,0 +1,14 @@
namespace BotSharp.Core.Crontab.Models;
public class CrontabItem
{
public string UserId { get; set; } = null!;
public string AgentId { get; set; } = null!;
public string Topic { get; set; } = null!;
public string Cron { get; set; } = null!;
public override string ToString()
{
return $"AgentId: {AgentId}, UserId: {UserId}, Topic: {Topic}";
}
}

77
src/Infrastructure/BotSharp.Core.Crontab/Services/CrontabService.cs Normal file
View file

@ -0,0 +1,77 @@
/*****************************************************************************
Copyright 2024 Written by Haiping Chen. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
******************************************************************************/
using BotSharp.Abstraction.Agents.Enums;
using BotSharp.Core.Crontab.Models;
using BotSharp.Core.Infrastructures;
/*****************************************************************************
Copyright 2024 Written by Haiping Chen. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
******************************************************************************/
using Microsoft.Extensions.Logging;
namespace BotSharp.Core.Crontab.Services;
/// <summary>
/// The Crontab service schedules distributed events based on the execution times provided by users.
/// In a scalable environment, distributed locks are used to ensure that each event is triggered only once.
/// </summary>
public class CrontabService : ICrontabService
{
private readonly IServiceProvider _services;
private ILogger _logger;
public CrontabService(IServiceProvider services, ILogger<CrontabService> logger)
{
_services = services;
_logger = logger;
}
public async Task<List<CrontabItem>> GetCrontable()
{
return
[
new CrontabItem
{
Cron = "*/30 * * * * *",
AgentId = BuiltInAgentId.AIAssistant,
}
];
}
public async Task ScheduledTimeArrived(CrontabItem item)
{
_logger.LogInformation("ScheduledTimeArrived");
await HookEmitter.Emit<ICrontabHook>(_services, async hook =>
await hook.OnCronTriggered(item)
);
await Task.Delay(1000 * 10);
}
}

70
src/Infrastructure/BotSharp.Core.Crontab/Services/CrontabWatcher.cs Normal file
View file

@ -0,0 +1,70 @@
using BotSharp.Abstraction.Infrastructures;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using NCrontab;
namespace BotSharp.Core.Crontab.Services;
public class CrontabWatcher : BackgroundService
{
private readonly ILogger _logger;
private readonly IServiceProvider _services;
public CrontabWatcher(IServiceProvider services, ILogger<CrontabWatcher> logger)
{
_logger = logger;
_services = services;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
_logger.LogInformation("Crontab Watcher background service is running.");
using (var scope = _services.CreateScope())
{
var locker = scope.ServiceProvider.GetRequiredService<IDistributedLocker>();
while (!stoppingToken.IsCancellationRequested)
{
var delay = Task.Delay(1000, stoppingToken);
await locker.LockAsync("CrontabWatcher", async () =>
{
await RunCronChecker(scope.ServiceProvider);
});
await delay;
}
_logger.LogWarning("Crontab Watcher background service is stopped.");
}
}
private async Task RunCronChecker(IServiceProvider services)
{
var cron = services.GetRequiredService<ICrontabService>();
var crons = await cron.GetCrontable();
foreach (var item in crons)
{
var schedule = CrontabSchedule.Parse(item.Cron, new CrontabSchedule.ParseOptions
{
IncludingSeconds = true // Ensure you account for seconds
});
// Get the current time
var currentTime = DateTime.UtcNow;
// Get the next occurrence from the schedule
var nextOccurrence = schedule.GetNextOccurrence(currentTime.AddSeconds(-1));
// Check if the current time matches the schedule
bool matches = currentTime >= nextOccurrence && currentTime < nextOccurrence.AddSeconds(1);
if (matches)
{
_logger.LogInformation($"The current time matches the cron expression {item}");
cron.ScheduledTimeArrived(item);
}
}
}
}

7
src/Infrastructure/BotSharp.Core.Crontab/Using.cs Normal file
View file

@ -0,0 +1,7 @@
global using Microsoft.Extensions.Configuration;
global using Microsoft.Extensions.DependencyInjection;
global using BotSharp.Abstraction.Agents.Enums;
global using BotSharp.Abstraction.Plugins;
global using BotSharp.Core.Crontab.Services;
global using BotSharp.Core.Crontab.Abstraction;

24
src/Infrastructure/BotSharp.Core.Crontab/data/agents/c2o139da-a62a-4355-8605-fdf0ffaca58e/agent.json Normal file
View file

@ -0,0 +1,24 @@
{
"id": "c2o139da-a62a-4355-8605-fdf0ffaca58e",
"name": "Crontab",
"description": "Convert the user-specified schedule into a Cron expression, accurate to the second level.",
"iconUrl": "https://icon-library.com/images/stop-watch-icon/stop-watch-icon-10.jpg",
"type": "task",
"createdDateTime": "2024-12-03T00:00:00Z",
"updatedDateTime": "2024-12-03T00:00:00Z",
"disabled": false,
"isPublic": true,
"profiles": [ "cron" ],
"llmConfig": {
"provider": "openai",
"model": "gpt-4o-mini"
},
"routingRules": [
{
"field": "cron_expression",
"required": true,
"field_type": "string",
"description": "A Cron expression, accurate to the second level."
}
]
}

13
src/Infrastructure/BotSharp.Core.Rules/BotSharp.Core.Rules.csproj Normal file
View file

@ -0,0 +1,13 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\..\Infrastructure\BotSharp.Abstraction\BotSharp.Abstraction.csproj" />
</ItemGroup>
</Project>

19
src/Infrastructure/BotSharp.Core.Rules/RulesPlugin.cs Normal file
View file

@ -0,0 +1,19 @@
namespace BotSharp.Core.Rules;
public class RulesPlugin : IBotSharpPlugin
{
public string Id => "0197c1bc-9ae6-4c56-a305-8a1b4095bebc";
public string Name => "BotSharp Rules";
public string Description => "Translates user-defined natural language rules into programmatic code and is responsible for executing these rules under user-specified conditions.";
public string IconUrl => "https://w7.pngwing.com/pngs/442/614/png-transparent-regulation-computer-icons-regulatory-compliance-medical-device-manufacturing-others-miscellaneous-blue-text-thumbnail.png";
public string[] AgentIds =
[
BuiltInAgentId.RuleEncoder
];
public void RegisterDI(IServiceCollection services, IConfiguration config)
{
}
}

4
src/Infrastructure/BotSharp.Core.Rules/Using.cs Normal file
View file

@ -0,0 +1,4 @@
global using BotSharp.Abstraction.Agents.Enums;
global using BotSharp.Abstraction.Plugins;
global using Microsoft.Extensions.Configuration;
global using Microsoft.Extensions.DependencyInjection;

6
src/Infrastructure/BotSharp.Core.SideCar/BotSharpSideCarPlugin.cs
View file

@ -8,8 +8,10 @@ namespace BotSharp.Core.SideCar;
public class BotSharpSideCarPlugin : IBotSharpPlugin
{
public string Id => "06e5a276-bba0-45af-9625-889267c341c9";
public string Name => "Side Car";
public string Description => "Provides side car for calling agent cluster in conversation";
public string Name => "BotSharp SideCar";
public string Description => "Provide side car pattern to to better handle Agent Cluster calls in the same conversation. Agent cluster is composed of multiple Routing Agents.";
public string? IconUrl => "https://icons.veryicon.com/png/128/internet--web/2022-alibaba-cloud-product-icon-cloud/aliyuncvc-cloud-video-conference.png";
public SettingsMeta Settings => new SettingsMeta("SideCar");
public object GetNewSettingsInstance() => new SideCarSettings();

16
src/Infrastructure/BotSharp.Core.SideCar/Services/BotSharpConversationSideCar.cs
View file

@ -1,3 +1,19 @@
/*****************************************************************************
Copyright 2024 Written by Jicheng Lu. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
******************************************************************************/
using BotSharp.Core.Infrastructures;
namespace BotSharp.Core.SideCar.Services;

2
src/Infrastructure/BotSharp.Core/BotSharpCoreExtensions.cs
View file

@ -25,7 +25,7 @@ public static class BotSharpCoreExtensions
config.Bind("Interpreter", interpreterSettings);
services.AddSingleton(x => interpreterSettings);
services.AddSingleton<DistributedLocker>();
services.AddSingleton<IDistributedLocker, DistributedLocker>();
// Register template render
services.AddSingleton<ITemplateRender, TemplateRender>();

16
src/Infrastructure/BotSharp.Core/Conversations/Services/ConversationStateService.cs
View file

@ -1,3 +1,19 @@
/*****************************************************************************
Copyright 2024 Written by Jicheng Lu. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
******************************************************************************/
using BotSharp.Abstraction.Conversations.Enums;
namespace BotSharp.Core.Conversations.Services;

9
src/Infrastructure/BotSharp.Core/Infrastructures/DistributedLocker.cs
View file

@ -1,9 +1,10 @@
using BotSharp.Abstraction.Infrastructures;
using Medallion.Threading.Redis;
using StackExchange.Redis;
namespace BotSharp.Core.Infrastructures;
public class DistributedLocker
public class DistributedLocker : IDistributedLocker
{
private readonly IConnectionMultiplexer _redis;
private readonly ILogger _logger;
@ -14,7 +15,7 @@ public class DistributedLocker
_logger = logger;
}
public async Task<T> Lock<T>(string resource, Func<Task<T>> action, int timeoutInSeconds = 30)
public async Task<bool> LockAsync(string resource, Func<Task> action, int timeoutInSeconds = 30)
{
var timeout = TimeSpan.FromSeconds(timeoutInSeconds);
@ -24,9 +25,11 @@ public class DistributedLocker
if (handle == null)
{
_logger.LogWarning($"Acquire lock for {resource} failed due to after {timeout}s timeout.");
return false;
}
return await action();
await action();
return true;
}
}

8
src/Infrastructure/BotSharp.Core/Roles/Services/RoleService.cs
View file

@ -39,7 +39,15 @@ public class RoleService : IRoleService
public async Task<IEnumerable<Role>> GetRoles(RoleFilter filter)
{
var db = _services.GetRequiredService<IBotSharpRepository>();
var roles = db.GetRoles(filter);
if (filter.IsInit() && roles.IsNullOrEmpty())
{
await RefreshRoles();
await Task.Delay(100);
roles = db.GetRoles(filter);
}
return roles;
}

2
src/Infrastructure/BotSharp.Core/Routing/Reasoning/NaiveReasoner.cs
View file

@ -29,6 +29,8 @@ public class NaiveReasoner : IRoutingReasoner
private readonly IServiceProvider _services;
private readonly ILogger _logger;
public string Name => "Naive Reasoner";
public NaiveReasoner(IServiceProvider services, ILogger<NaiveReasoner> logger)
{
_services = services;

4
src/Infrastructure/BotSharp.Core/Routing/Reasoning/OneStepForwardReasoner.cs
View file

@ -34,7 +34,7 @@ public class OneStepForwardReasoner : IRoutingReasoner
private readonly IServiceProvider _services;
private readonly ILogger _logger;
public OneStepForwardReasoner(IServiceProvider services, ILogger<NaiveReasoner> logger)
public OneStepForwardReasoner(IServiceProvider services, ILogger<OneStepForwardReasoner> logger)
{
_services = services;
_logger = logger;
@ -116,7 +116,7 @@ public class OneStepForwardReasoner : IRoutingReasoner
}
else
{
context.Empty(reason: $"Agent queue is cleared by {nameof(NaiveReasoner)}");
context.Empty(reason: $"Agent queue is cleared by {nameof(OneStepForwardReasoner)}");
// context.Push(inst.OriginalAgent, "Push user goal agent");
}
return true;

2
src/Infrastructure/BotSharp.Core/Routing/Reasoning/SequentialReasoner.cs
View file

@ -33,7 +33,7 @@ public class SequentialReasoner : IRoutingReasoner
public int MaxLoopCount => 100;
private FunctionCallFromLlm _lastInst;
public SequentialReasoner(IServiceProvider services, ILogger<NaiveReasoner> logger)
public SequentialReasoner(IServiceProvider services, ILogger<SequentialReasoner> logger)
{
_services = services;
_logger = logger;

10
src/Infrastructure/BotSharp.Core/Routing/RoutingService.InstructLoop.cs
View file

@ -97,14 +97,20 @@ public partial class RoutingService
{
var rule = router.RoutingRules.FirstOrDefault(x => x.Type == RuleType.Reasoner);
if (rule == null)
{
_logger.LogError($"Can't find any reasoner");
return _services.GetServices<IRoutingReasoner>().First(x => x.Name == "Naive Reasoner");
}
var reasoner = _services.GetServices<IRoutingReasoner>().
FirstOrDefault(x => x.GetType().Name.EndsWith(rule.Field));
if (reasoner == null)
{
_logger.LogError($"Can't find specific planner named {rule.Field}");
_logger.LogError($"Can't find specific reasoner named {rule.Field}");
// Default use NaiveReasoner
return _services.GetRequiredService<NaiveReasoner>();
return _services.GetServices<IRoutingReasoner>().First(x => x.Name == "Naive Reasoner");
}
return reasoner;

16
src/Infrastructure/BotSharp.Core/Translation/TranslationService.cs
View file

@ -1,3 +1,19 @@
/*****************************************************************************
Copyright 2024 Written by Jicheng Lu. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
******************************************************************************/
using BotSharp.Abstraction.Infrastructures.Enums;
using BotSharp.Abstraction.MLTasks;
using BotSharp.Abstraction.Options;

2
src/Plugins/BotSharp.Plugin.AnthropicAI/BotSharp.Plugin.AnthropicAI.csproj
View file

@ -11,7 +11,7 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Anthropic.SDK" Version="4.1.1" />
<PackageReference Include="Anthropic.SDK" Version="4.3.0" />
</ItemGroup>
<ItemGroup>

3
src/Plugins/BotSharp.Plugin.ExcelHandler/BotSharp.Plugin.ExcelHandler.csproj
View file

@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
@ -28,7 +28,6 @@
<ItemGroup>
<PackageReference Include="Microsoft.Data.Sqlite" Version="8.0.8" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="8.0.8" />
<PackageReference Include="MySql.Data" Version="9.0.0" />
<PackageReference Include="NPOI" Version="2.7.1" />
</ItemGroup>

17
src/Plugins/BotSharp.Plugin.JavaScriptInterpreter/BotSharp.Plugin.JavaScriptInterpreter.csproj Normal file
View file

@ -0,0 +1,17 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Jint" Version="4.1.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\Infrastructure\BotSharp.Abstraction\BotSharp.Abstraction.csproj" />
</ItemGroup>
</Project>

24
src/Plugins/BotSharp.Plugin.JavaScriptInterpreter/JsInterpreterPlugin.cs Normal file
View file

@ -0,0 +1,24 @@
using BotSharp.Abstraction.Plugins;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
namespace BotSharp.Plugin.JavaScriptInterpreter;
public class JsInterpreterPlugin : IBotSharpAppPlugin
{
public string Id => "7a5a8cd7-26d9-4ac3-9d79-d02084bea372";
public string Name => "JavaScript Interpreter";
public string Description => "";
public string? IconUrl => "";
public void Configure(IApplicationBuilder app)
{
}
public void RegisterDI(IServiceCollection services, IConfiguration config)
{
}
}

2
src/Plugins/BotSharp.Plugin.LLamaSharp/BotSharp.Plugin.LLamaSharp.csproj
View file

@ -11,7 +11,7 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="LLamaSharp" Version="0.12.0" />
<PackageReference Include="LLamaSharp" Version="0.18.0" />
</ItemGroup>
<ItemGroup>

1
src/Plugins/BotSharp.Plugin.LLamaSharp/LlamaAiModel.cs
View file

@ -36,7 +36,6 @@ public class LlamaAiModel
_params = new ModelParams(Path.Combine(_settings.ModelDir, model))
{
ContextSize = (uint)_settings.MaxContextLength,
Seed = 1337,
GpuLayerCount = _settings.NumberOfGpuLayer
};

8
src/Plugins/BotSharp.Plugin.LLamaSharp/Providers/TextEmbeddingProvider.cs
View file

@ -1,4 +1,6 @@
using System.IO;
using System.Xml.Linq;
using static System.Net.Mime.MediaTypeNames;
namespace BotSharp.Plugin.LLamaSharp.Providers;
@ -19,7 +21,7 @@ public class TextEmbeddingProvider : ITextEmbedding
_settings = settings;
}
public Task<float[]> GetVectorAsync(string text)
public async Task<float[]> GetVectorAsync(string text)
{
if (_embedder == null)
{
@ -29,10 +31,10 @@ public class TextEmbeddingProvider : ITextEmbedding
_embedder = new LLamaEmbedder(weights, @params);
}
return _embedder.GetEmbeddings(text);
return (await _embedder.GetEmbeddings(text)).First();
}
public Task<List<float[]>> GetVectorsAsync(List<string> texts)
public async Task<List<float[]>> GetVectorsAsync(List<string> texts)
{
throw new NotImplementedException();
}

10
src/Plugins/BotSharp.Plugin.Planner/Functions/SummaryPlanFn.cs
View file

@ -71,13 +71,15 @@ public class SummaryPlanFn : IFunctionCallback
var summary = await GetAiResponse(plannerAgent);
message.Content = summary.Content;
// Validate the sql result
// Emit event if the sql statement is generated by planner
var args = JsonSerializer.Deserialize<SummaryPlan>(message.FunctionArgs);
if (args.IsSqlTemplate == false)
if (args != null && !args.IsSqlTemplate && args.ContainsSqlStatements)
{
await fn.InvokeFunction("validate_sql", message);
await HookEmitter.Emit<IPlanningHook>(_services, async hook =>
await hook.OnSourceCodeGenerated(nameof(TwoStageTaskPlanner), message, "sql")
);
}
await HookEmitter.Emit<IPlanningHook>(_services, async hook =>
await hook.OnPlanningCompleted(nameof(TwoStageTaskPlanner), message)
);

3
src/Plugins/BotSharp.Plugin.Planner/TwoStaging/Models/SummaryPlan.cs
View file

@ -4,4 +4,7 @@ public class SummaryPlan
{
[JsonPropertyName("is_sql_template")]
public bool IsSqlTemplate { get; set; } = false;
[JsonPropertyName("contains_sql_statements")]
public bool ContainsSqlStatements { get; set; } = false;
}

2
src/Plugins/BotSharp.Plugin.Planner/data/agents/282a7128-69a1-44b0-878c-a9159b88f3b9/agent.json
View file

@ -1,7 +1,7 @@
{
"id": "282a7128-69a1-44b0-878c-a9159b88f3b9",
"name": "Planner",
"description": "Plan feasible implementation steps for user task request",
"description": "Plan feasible implementation steps for complex user task request",
"type": "task",
"createdDateTime": "2023-08-27T10:39:00Z",
"updatedDateTime": "2023-08-27T14:39:00Z",

6
src/Plugins/BotSharp.Plugin.Planner/data/agents/282a7128-69a1-44b0-878c-a9159b88f3b9/functions/plan_summary.json
View file

@ -8,6 +8,10 @@
"type": "boolean",
"description": "If user request is to generate sql template instead of actual sql statement."
},
"contains_sql_statements": {
"type": "boolean",
"description": "Set to true if the response contains sql statements."
},
"related_tables": {
"type": "array",
"description": "table name in planning steps",
@ -17,6 +21,6 @@
}
}
},
"required": [ "related_tables", "is_sql_template" ]
"required": [ "related_tables", "is_sql_template", "contains_sql_statements" ]
}
}

2
src/Plugins/BotSharp.Plugin.PythonInterpreter/BotSharp.Plugin.PythonInterpreter.csproj
View file

@ -25,7 +25,7 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="pythonnet" Version="3.0.3" />
<PackageReference Include="pythonnet" Version="3.0.4" />
</ItemGroup>
<ItemGroup>

7
src/Plugins/BotSharp.Plugin.SqlDriver/Functions/ExecuteQueryFn.cs
View file

@ -1,14 +1,8 @@
using BotSharp.Abstraction.Agents.Enums;
using BotSharp.Abstraction.Routing;
using BotSharp.Core.Infrastructures;
using BotSharp.Plugin.SqlDriver.Interfaces;
using BotSharp.Plugin.SqlDriver.Models;
using Dapper;
using Microsoft.Data.SqlClient;
using Microsoft.Extensions.Logging;
using MySqlConnector;
using Npgsql;
using System.Data.Common;
namespace BotSharp.Plugin.SqlDriver.Functions;
@ -113,6 +107,7 @@ public class ExecuteQueryFn : IFunctionCallback
using var connection = new SqlConnection(settings.SqlServerExecutionConnectionString ?? settings.SqlServerConnectionString);
return connection.Query(string.Join("\r\n", sqlTexts));
}
private IEnumerable<dynamic> RunQueryInRedshift(string[] sqlTexts)
{
var settings = _services.GetRequiredService<SqlDriverSetting>();

27
src/Plugins/BotSharp.Plugin.SqlDriver/Functions/SqlSelect.cs
View file

@ -1,6 +1,6 @@
using BotSharp.Plugin.SqlDriver.Models;
using Microsoft.Data.SqlClient;
using MySqlConnector;
using Npgsql;
using static Dapper.SqlMapper;
namespace BotSharp.Plugin.SqlDriver.Functions;
@ -26,12 +26,15 @@ public class SqlSelect : IFunctionCallback
}
// check if need to instantely
var settings = _services.GetRequiredService<SqlDriverSetting>();
var result = settings.DatabaseType switch
var dbHook = _services.GetRequiredService<ISqlDriverHook>();
var dbType = dbHook.GetDatabaseType(message);
var result = dbType switch
{
"MySql" => RunQueryInMySql(args),
"SqlServer" => RunQueryInSqlServer(args),
_ => throw new NotImplementedException($"Database type {settings.DatabaseType} is not supported.")
"mysql" => RunQueryInMySql(args),
"sqlserver" => RunQueryInSqlServer(args),
"redshift" => RunQueryInRedshift(args),
_ => throw new NotImplementedException($"Database type {dbType} is not supported.")
};
if (result == null)
@ -70,4 +73,16 @@ public class SqlSelect : IFunctionCallback
}
return connection.Query(args.Statement, dictionary);
}
private IEnumerable<dynamic> RunQueryInRedshift(SqlStatement args)
{
var settings = _services.GetRequiredService<SqlDriverSetting>();
using var connection = new NpgsqlConnection(settings.RedshiftConnectionString);
var dictionary = new Dictionary<string, object>();
foreach (var p in args.Parameters)
{
dictionary["@" + p.Name] = p.Value;
}
return connection.Query(args.Statement, dictionary);
}
}

19
src/Plugins/BotSharp.Plugin.SqlDriver/Hooks/SqlDriverPlanningHook.cs
View file

@ -20,14 +20,23 @@ public class SqlDriverPlanningHook : IPlanningHook
_services = services;
}
public async Task OnPlanningCompleted(string planner, RoleDialogModel msg)
public async Task OnSourceCodeGenerated(string planner, RoleDialogModel msg, string language)
{
// envoke validate
if (language != "sql")
{
return;
}
var routing = _services.GetRequiredService<IRoutingService>();
await routing.InvokeFunction("validate_sql", msg);
await HookEmitter.Emit<ISqlDriverHook>(_services, async (hook) =>
{
await hook.SqlGenerated(msg);
});
var settings = _services.GetRequiredService<SqlDriverSetting>();
var settings = _services.GetRequiredService<SqlDriverSetting>();
if (!settings.ExecuteSqlSelectAutonomous)
{
var conversationStateService = _services.GetRequiredService<IConversationStateService>();
@ -51,7 +60,6 @@ public class SqlDriverPlanningHook : IPlanningHook
var response = await completion.GetChatCompletions(agent, wholeDialogs);
// Invoke "execute_sql"
var routing = _services.GetRequiredService<IRoutingService>();
await routing.InvokeFunction(response.FunctionName, response);
msg.CurrentAgentId = agent.Id;
@ -61,6 +69,11 @@ public class SqlDriverPlanningHook : IPlanningHook
msg.StopCompletion = response.StopCompletion;
}
public async Task OnPlanningCompleted(string planner, RoleDialogModel msg)
{
}
public async Task<string> GetSummaryAdditionalRequirements(string planner, RoleDialogModel message)
{
var settings = _services.GetRequiredService<SqlDriverSetting>();

4
tests/BotSharp.Plugin.PizzaBot/data/agents/8970b1e5-d260-4e2c-90b1-f1415a257c18/agent.json
View file

@ -12,8 +12,8 @@
"profiles": [ "pizza" ],
"routingRules": [
{
"type": "planner",
"field": "NaivePlanner"
"type": "reasoner",
"field": "NaiveReasoner"
}
]
}