BotSharp/docs/index.rst

102 lines
3.5 KiB
ReStructuredText
Raw Normal View History

.. BotSharp documentation master file, created by
2018-08-19 21:36:06 +00:00
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.
2023-09-18 08:35:02 +00:00
The Open Source LLM Application Framework
2018-09-21 20:11:57 +00:00
======================================================
2023-06-19 12:43:36 +00:00
.. image:: https://img.shields.io/discord/1106946823282761851?label=Discord
:target: `discord`_
2018-09-14 21:49:53 +00:00
2023-09-18 08:35:02 +00:00
**Build the AI bot from scratch with .NET**
2023-08-01 00:57:11 +00:00
2023-09-18 08:35:02 +00:00
> The LLM powered Conversational Service building blocks and best practice
2023-06-19 12:43:36 +00:00
*"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."*
2023-09-18 08:35:02 +00:00
**BotSharp** is an open source AI framework for your enterprise-grade LLM applications. 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 business oriented systems. Out-of-the-box machine learning algorithms allow ordinary programmers to develop artificial intelligence applications faster and easier.
2023-06-19 12:43:36 +00:00
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.
2023-09-18 08:35:02 +00:00
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 Vector Storage, or select a more advanced algorithm to do NLU tasks. They are all modularized based on unified interfaces.
2018-10-24 22:25:15 +00:00
.. image:: static/logos/BotSharp.png
:height: 64px
2018-09-21 20:11:57 +00:00
Indices and tables
==================
The main documentation for the site is organized into the following sections:
2023-08-01 00:57:11 +00:00
* :ref:`Get Started <get-started>`
* :ref:`Integration Documentation <integration-docs>`
2018-10-02 16:46:24 +00:00
* :ref:`Architecture Documentation <architecture-docs>`
* :ref:`search`
2023-08-01 00:57:11 +00:00
.. _get-started:
.. toctree::
2023-09-04 02:45:31 +00:00
:maxdepth: 2
2023-08-01 00:57:11 +00:00
:caption: Get Started with BotSharp
2018-10-18 19:13:56 +00:00
2023-08-01 00:57:11 +00:00
quick-start/overview
quick-start/installation
.. _agent-docs:
.. toctree::
2023-09-04 02:45:31 +00:00
:maxdepth: 2
2023-08-01 00:57:11 +00:00
:caption: Agent & Conversation
2023-08-14 17:12:22 +00:00
agent/intro
2023-08-01 00:57:11 +00:00
agent/conversation
2023-08-14 17:12:22 +00:00
agent/state
.. _integration-docs:
.. toctree::
2023-09-04 02:45:31 +00:00
:maxdepth: 2
2023-08-14 17:12:22 +00:00
:caption: Interactive Channels
2023-08-14 17:12:22 +00:00
channels/intro
channels/messenger
channels/wechat
2023-08-10 12:25:08 +00:00
.. _knowledge-base:
.. toctree::
2023-09-04 02:45:31 +00:00
:maxdepth: 2
2023-08-10 12:25:08 +00:00
:caption: Knowledge Base
knowledge-base/text-embedding
knowledge-base/vector-database
knowledge-base/similarity-search
2023-08-14 17:12:22 +00:00
knowledge-base/build-qa-bot
2023-08-19 13:25:47 +00:00
.. _llm:
2023-08-14 17:12:22 +00:00
.. toctree::
2023-09-04 02:45:31 +00:00
:maxdepth: 2
2023-08-14 17:12:22 +00:00
:caption: Prompt Engineering
2023-08-19 13:25:47 +00:00
prompt/prompt
2023-08-18 04:27:07 +00:00
prompt/template
2023-08-19 13:25:47 +00:00
llm/function
llm/few-shot-learning
2023-08-10 12:25:08 +00:00
2018-10-02 16:46:24 +00:00
.. _architecture-docs:
.. toctree::
2023-09-04 02:45:31 +00:00
:maxdepth: 2
2023-08-10 12:25:08 +00:00
:caption: Architecture:
2018-10-02 16:46:24 +00:00
2023-08-14 17:12:22 +00:00
architecture/authentication
architecture/plugin
architecture/hooks
2023-09-04 02:45:31 +00:00
architecture/routing
2023-08-14 17:12:22 +00:00
architecture/data-persistence
2018-10-02 16:46:24 +00:00
If you feel that this project is helpful to you, please Star us on the project, we will be very grateful.
2023-06-19 12:43:36 +00:00
.. _discord: https://discord.gg/qRVm82fKTS