Skip to content

Latest commit

 

History

History
131 lines (101 loc) · 6.21 KB

README.md

File metadata and controls

131 lines (101 loc) · 6.21 KB

The Open Source AI Agent Application Framework

Connect LLMs to your existing application focused on your business

Discord QQ群聊 Apache 2.0 NuGet Build status Documentation Status

"Conversation as a platform (CaaP) is the future, so it's perfect that we're already offering the whole toolkits to our .NET developers using the BotSharp AI BOT Platform Builder to build a CaaP. It opens up as much learning power as possible for your own robots and precisely control every step of the AI processing pipeline."

BotSharp is an open source machine learning framework for AI Bot platform builder. This project involves natural language understanding, computer vision and audio processing technologies, and aims to promote the development and application of intelligent robot assistants in information systems. Out-of-the-box machine learning algorithms allow ordinary programmers to develop artificial intelligence applications faster and easier.

It's written in C# running on .Net Core that is full cross-platform framework, the plug-in and pipeline flow execution design is adopted to completely decouple the plug-ins. C# is a enterprise grade programming language which is widely used to code business logic in information management related system. More friendly to corporate developers. BotSharp adopts machine learning algrithm in C# directly. That will facilitate the feature of the typed language C#, and be more easier when refactoring code in system scope.

BotSharp is in accordance with components principle strictly, decouples every part that is needed in the platform builder. So you can choose different UI/UX, or pick up a different LLM providers. They are all modulized based on unified interfaces. BotSharp provides an advanced Agent abstraction layer to efficiently manage complex application scenarios in enterprises, allowing enterprise developers to efficiently integrate AI into business systems.

Some Features

  • Built-in multi-agents and conversation with state management.
  • Support multiple LLM Planning approaches to handle different tasks from simple to complex.
  • Built-in RAG related interfaces, Memeory based vector searching.
  • Support multiple AI platforms (ChatGPT 3.5 / 4.0, PaLM 2, LLaMA 3, Claude Sonnet 3.5, HuggingFace).
  • Allow multiple agents with different responsibilities cooperate to complete complex tasks.
  • Build, test, evaluate and audit your LLM agent in one place.
  • Build-in BotSharp UI written in SvelteKit.
  • Abstract standard Rich Content data structure. Integrate with popular message channels like Facebook Messenger, Slack and Telegram.
  • Provide RESTful Open API and WebSocket real-time communication.

Quick Started

  1. Run backend service
 PS D:\> git clone https://github.com/dotnetcore/BotSharp
 PS D:\> cd BotSharp
 # For Windows
 PS D:\BotSharp\> dotnet run --project .\src\WebStarter\WebStarter.csproj -p SolutionName=BotSharp
 # For Linux
 $ dotnet run --project ./src/WebStarter/WebStarter.csproj -p SolutionName=BotSharp
  1. Run Admin UI project, reference to BotSharp UI.
PS D:\> git clone https://github.com/SciSharp/BotSharp-UI
PS D:\> cd BotSharp-UI
PS D:\> npm install
PS D:\> npm run dev

Access http://localhost:5015/

Online Demo with UI

Core Modules

The core module is mainly composed of abstraction and framework function implementation, combined with some common tools.

  • Plugin Loader
  • Hooking
  • Authentication
  • Agent Profile
  • Conversation & State
  • Routing & Planning
  • Templating
  • File Repository
  • Caching
  • Rich Content
  • LLM Provider

Plugins

BotSharp uses component design, the kernel is kept to a minimum, and business functions are implemented by external components. The modular design also allows contributors to better participate. Below are the bulit-in plugins:

Data Storages

  • BotSharp.Core.Repository
  • BotSharp.Plugin.MongoStorage
  • BotSharp.Plugin.TencentCos

LLMs

  • BotSharp.Plugin.Planner
  • BotSharp.Plugin.AzureOpenAI
  • BotSharp.Plugin.OpenAI
  • BotSharp.Plugin.AnthropicAI
  • BotSharp.Plugin.GoogleAI
  • BotSharp.Plugin.MetaAI
  • BotSharp.Plugin.HuggingFace
  • BotSharp.Plugin.LLamaSharp
  • BotSharp.Plugin.SemanticKernel
  • BotSharp.Plugin.SparkDesk

Messaging / Channel

  • BotSharp.OpenAPI
  • BotSharp.Plugin.ChatHub
  • BotSharp.Plugin.MetaMessenger
  • BotSharp.Plugin.Twilio
  • BotSharp.Plugin.TelegramBots
  • BotSharp.Plugin.WeChat

RAGs

  • BotSharp.Plugin.KnowledgeBase
  • BotSharp.Plugin.Qdrant

Visions

  • BotSharp.Plugin.PaddleSharp

Tools

  • BotSharp.Plugin.Dashboard
  • BotSharp.Plugin.RoutingSpeeder
  • BotSharp.Plugin.AudioHandler
  • BotSharp.Plugin.EmailHandler
  • BotSharp.Plugin.FileHandler
  • BotSharp.Plugin.HttpHandler
  • BotSharp.Plugin.SqlDriver
  • BotSharp.Plugin.WebDriver
  • BotSharp.Plugin.PythonInterpreter

UIs

  • BotSharp.Plugin.ChatbotUI

Documents

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

If you feel that this project is helpful to you, please Star the project, we would be very grateful.

Member project of SciSharp STACK which is the .NET based ecosystem of open-source software for mathematics, science, and engineering.