Skip to content

Commit e0024d8

Browse files
author
Jicheng Lu
committed
Merge branch 'master' of https://github.com/SciSharp/BotSharp into features/refine-knowledge-service
2 parents 0333d04 + e1de5c5 commit e0024d8

3 files changed

Lines changed: 60 additions & 4 deletions

File tree

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,57 @@ BotSharp uses component design, the kernel is kept to a minimum, and business fu
140140
- [x] Multi-Agent Routing
141141
- [x] Knowledge Base
142142

143+
144+
### FAQ
145+
146+
#### General Questions
147+
148+
**What is BotSharp?**
149+
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.
150+
151+
**What .NET versions are supported?**
152+
BotSharp runs on .NET Core, which is fully cross-platform. It supports .NET 6+ and works on Windows, Linux, and macOS.
153+
154+
**Is BotSharp free to use?**
155+
Yes, BotSharp is licensed under Apache 2.0, allowing free use in both personal and commercial projects.
156+
157+
#### LLM Provider Configuration
158+
159+
**Which LLM providers are supported?**
160+
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.
161+
162+
**How do I configure a custom LLM provider?**
163+
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`.
164+
165+
#### Agent Development
166+
167+
**How do I create a custom agent?**
168+
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.
169+
170+
**Can multiple agents cooperate on a task?**
171+
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.
172+
173+
#### MCP Integration
174+
175+
**What is MCP and how does BotSharp support it?**
176+
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.
177+
178+
#### Deployment
179+
180+
**How do I deploy BotSharp in production?**
181+
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.
182+
183+
**Can I use BotSharp without the UI?**
184+
Yes, BotSharp provides RESTful Open API and WebSocket real-time communication. You can integrate it directly with your own frontend or messaging channels.
185+
186+
#### Troubleshooting
187+
188+
**BotSharp fails to start with dependency errors**
189+
Ensure you have .NET 6+ SDK installed and all NuGet packages are restored. Run `dotnet restore` before `dotnet run`.
190+
191+
**LLM calls are timing out**
192+
Check your API key configuration in `appsettings.json`, verify network connectivity to the LLM provider, and ensure the model name is correct.
193+
143194
### Documents
144195

145196
Read the docs: https://botsharp.readthedocs.io?wt.mc_id=AI-MVP-5005183

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,9 @@ public class EmbeddingData
7676
/// </summary>
7777
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
7878
public string? AppendTokenName { get; set; }
79+
80+
/// <summary>
81+
/// Whether to enable full screen or not
82+
/// </summary>
83+
public bool FullScreen { get; set; }
7984
}

src/Plugins/BotSharp.Plugin.Membase/MembasePlugin.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
using BotSharp.Abstraction.Graph;
21
using BotSharp.Abstraction.Plugins.Models;
32
using BotSharp.Abstraction.Rules;
43
using BotSharp.Plugin.Membase.GraphDb;
54
using BotSharp.Plugin.Membase.Handlers;
6-
using BotSharp.Plugin.Membase.Interfaces;
75
using Refit;
86

97
namespace BotSharp.Plugin.Membase;
@@ -13,7 +11,7 @@ public class MembasePlugin : IBotSharpPlugin
1311
public string Id => "8df12767-9a44-45d9-93cd-12a10adf3933";
1412
public string Name => "Membase";
1513
public string Description => "Document Database with Graph Traversal & Vector Search.";
16-
public string IconUrl => "https://membase.dev/favicon.png";
14+
public string IconUrl => "https://www.membase.dev/favicon.png";
1715

1816
private string _membaseCredential = string.Empty;
1917
private string _membaseProjectId = string.Empty;
@@ -56,7 +54,9 @@ public bool AttachMenu(List<PluginMenuDef> menu)
5654
{
5755
Source = "membase",
5856
HtmlTag = "iframe",
59-
Url = $"https://console.membase.dev/query-editor/{_membaseProjectId}?token={_membaseCredential}"
57+
Url = $"https://console.membase.dev/query-editor/{_membaseProjectId}?token={_membaseCredential}",
58+
HtmlStyle = "width: 100%; height: 90%;",
59+
FullScreen = true
6060
}
6161
});
6262
return true;

0 commit comments

Comments
 (0)