BotSharp/docs/index.rst
2023-06-19 07:43:36 -05:00

97 lines
3.7 KiB
ReStructuredText

.. BotSharp documentation master file, created by
sphinx-quickstart on Sun Aug 19 10:40:29 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
The Open Source AI Bot Platform Builder
======================================================
.. image:: https://img.shields.io/discord/1106946823282761851?label=Discord
:target: `discord`_
*"Conversation as a platform (CaaP) is the future, so it's perfect that we're already offering the whole toolkits to .NET developers using BotSharp the Bot Platform Builder to build a CaaP. It opens up as much learning power as possible for your robots and precisely control every step of the AI processing pipeline."*
**BotSharp** is an open source bot framework for AI Bot platform builders. 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 witten in C# running on .NET which is a full cross-platform framework. C# is an 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/C++ interfaces directly which skips the python interfaces. That will facilitate the feature of the typed language C#, and be easier when refactoring code in system scope.
BotSharp is strictly in accordance with the components principle and decouples every part that is needed in the platform builder. So you can choose different UI/UX, or pick up a different NLP Tagger, or select a more advanced algorithm to do NER tasks. They are all modularized based on unified interfaces.
.. image:: static/logos/BotSharp.png
:height: 64px
Some Features
-------------
* Built-in multi-Agents management, easy to build Bot as a Service platform.
* Integrate with multiple LLMs like ChatGPT and LLaMA.
* Using plug-in design, it is easy to expand functions.
* Working with multiple Vector Stores for senmatic search.
* Supporting different UI providers like `Chatbot UI`_ and `HuggingChat UI`_.
* Integrated with popular social platforms like Facebook Messenger, Slack and Telegram.
* Providing REST APIs to work with your own UI.
Indices and tables
==================
The main documentation for the site is organized into the following sections:
* :ref:`User Documentation <user-docs>`
* :ref:`Integration Documentation <integration-docs>`
* :ref:`NLP Documentation <nlp-docs>`
* :ref:`Architecture Documentation <architecture-docs>`
* :ref:`search`
.. _user-docs:
.. toctree::
:maxdepth: 3
:caption: Hands-On Chatbot Platform:
FrontCover
overview
installation
agent/import-agent
agent/train-agent
agent/test-agent
agent/optimize-agent
.. _integration-docs:
.. toctree::
:maxdepth: 3
:caption: Channels Integration Documentation:
integrations/facebook-messenger
integrations/slack
integrations/telegram
integrations/skype
.. _architecture-docs:
.. toctree::
:maxdepth: 3
:caption: Architecture Documentation:
configuration/db
configuration/platform
.. _nlp-docs:
.. toctree::
:maxdepth: 3
:caption: NLP Documentation:
models/crf
models/nb
models/ngram
models/svm
models/tfidf
models/penntreebank
If you feel that this project is helpful to you, please Star us on the project, we will be very grateful.
.. _Chatbot UI: https://github.com/mckaywrigley/chatbot-ui
.. _HuggingChat UI: https://github.com/huggingface/chat-ui
.. _discord: https://discord.gg/qRVm82fKTS