Update tutorial doc.

docs/README.md

@@ -0,0 +1,12 @@
+# How to contribute docs
+
+We use [Sphinx](https://www.sphinx-doc.org/en/master/) to build document, please make sure you installed the appropriate Sphinx plugins before making the docs.
+
+```shell
+pip install -U sphinx
+pip install recommonmark
+pip install sphinx_rtd_theme
+
+cd docs
+./make html
+```

docs/conf.py

@@ -64,9 +64,9 @@ author = 'Haiping Chen'
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.0'
+version = '0.5'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = '0.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -6,17 +6,15 @@
 The Open Source AI Bot Platform Builder
 ======================================================
 
-.. image:: https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg
-    :target: `gitter`_
+.. 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 the BotSharp 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."*
+*"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 machine learning 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. 
+**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 Core 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. 
-
-Why we do this? because we all know python is not a friendly programming language for enterprise developers; not only because it's low performance but it's a type weak language and can be a disater if you use python to build your bussiness system.
+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.
 
@@ -26,16 +24,13 @@ BotSharp is strictly in accordance with the components principle and decouples e
 Some Features
 -------------
 
-* Integrated debugging is easier without relying on any other machine learning algorithm libraries.
 * Built-in multi-Agents management, easy to build Bot as a Service platform.
-* Context In/ Out with lifespan to make conversion flow more controllable.
-* Use the natural language processing pipeline mechanism to work with extensions easily, and build your own unique bot processing flows. 
-* Rewrote NLP algorithm from the ground up without historical issues.
-* Support export/import of agents from other bot platforms directly. 
-* Support different UI providers like `Rasa UI`_ and `Articulate UI`_.
-* Support for multiple data request and response formats such as Rasa NLU and Dialogflow.
-* Integrate with popular social platforms like Facebook Messenger, Slack and Telegram.
-* Multi-core parallel computing optimization, High-Performance C# on GPUs in Hybridizer.
+* 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
 ==================
@@ -96,6 +91,6 @@ The main documentation for the site is organized into the following sections:
 
 If you feel that this project is helpful to you, please Star us on the project, we will be very grateful.
 
-.. _Rasa UI: https://github.com/paschmann/rasa-ui
-.. _Articulate UI: https://github.com/Oceania2018/articulate-ui
-.. _gitter: https://gitter.im/botsharpcore/Lobby
+.. _Chatbot UI: https://github.com/mckaywrigley/chatbot-ui
+.. _HuggingChat UI: https://github.com/huggingface/chat-ui
+.. _discord: https://discord.gg/qRVm82fKTS

docs/installation.rst

@@ -2,75 +2,58 @@ Installation
 ============
 BotSharp strictly follows the modular design principle and adopts a structure in which views and logic are separated. 
 So you can choose the front-end Bot design and management interface. 
-If you want to use the `Articulate UI`_ as a front end, you can use the articulateui-specific compose file to quickly experience BotSharp.
-
-Docker Composer
-^^^^^^^^^^^^^^^
-You can use docker compose to run, make sure you've got `Docker`_ installed.
-
-::
-
-    PS D:\> git clone https://github.com/Oceania2018/BotSharp
-    PS D:\> cd BotSharp
-
-1. Integrate with `Botpress`_
-
-
-2. Integrate with `Articulate UI`_
-
-::
-
- PS D:\BotSharp\> docker-compose -f dockerfiles/docker-compose-articulateui.yml up
-
-Point your web browser at http://localhost:3000 and enjoy Articulate-UI with BotSharp.
-|ArticulateHomeScreenshot|
-
-3. Integrate with `Rasa UI`_, you can use docker compose to run.
-
-::
-
- PS D:\BotSharp\> docker-compose -f dockerfiles/docker-compose-rasaui.yml up
-
-Point your web browser at http://localhost:5001 and enjoy Rasa-UI with BotSharp.
-
-|RasaUIHomeScreenshot|
-
-4. Integrate with `Rasa Talk`_
 
 
 Building & Run locally
 ^^^^^^^^^^^^^^^^^^^^^^
-If you are a .NET developer and want to develop extensions or fix bug for BotSharp, you would CTRL + F5 to run it locally in debug mode. 
-Make sure the `Microsoft .NET Core`_ build environment and `Node.js`_ is installed. 
+If you are a .NET developer and want to develop extensions or fix bug for BotSharp, you would hit F5 to run it locally in debug mode. 
+Make sure the `Microsoft .NET SDK`_ 6.0+ build environment and `Node.js`_ is installed. 
 Building solution using dotnet CLI (preferred).
 
-* Build NLU API
+* Build BotSharp backend API
 ::
 
     PS D:\> git clone https://github.com/Oceania2018/BotSharp
     PS D:\> cd BotSharp
-    PS D:\> dotnet build -v m -o ../bin -c ARTICULATE
-    PS D:\> dotnet bin\BotSharp.WebHost.dll
-
-If you don't have Redis installed, please update ArticulateAi.json:
+    PS D:\> dotnet build
 
+* Update `appsettings.json`, BotSharp can work with serveral LLM providers. Below config is tasking Azure OpenAI as the LLM backend
 ::
 
-"AgentStorage": "AgentStorageInRedis"
-
-to 
+    "AzureOpenAi": {
+        "ApiKey": "",
+        "Endpoint": "https://.openai.azure.com/",
+        "DeploymentName": ""
+    }
 
+* Run backend web project
 ::
 
-"AgentStorage": "AgentStorageInMemory" 
+    PS D:\> dotnet run --project src/WebStarter
 
-* Build Chatbot Designer
+|BackendServiceHomeScreenshot|
+
+* Open REST API in browser http://localhost:5500/swagger
+
+|APIHomeScreenshot|
+
+* Launch a chatbot UI
+If you want to use the `Chatbot UI`_ as a front end.
 ::
 
-    PS D:\> git clone https://github.com/Oceania2018/articulate-ui
-    PS D:\> cd articulate-ui
-    PS D:\> npm install
-    PS D:\> npm start
+    PS D:\> git clone https://github.com/mckaywrigley/chatbot-ui
+    PS D:\> cd chatbot-ui
+    PS D:\> cd npm i
+    PS D:\> cd npm run dev
+
+Update API url in `.env.local` to your localhost BotSharp backend service.
+::
+    OPENAI_API_HOST=http://localhost:5500
+
+
+* Point your web browser at http://localhost:3000 and enjoy Chatbot with BotSharp.
+|ChatbotUIHomeScreenshot|
+
 
 Building docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -103,8 +86,6 @@ Get a bash shell if you want to update config in the container.
 
  PS D:\BotSharp\> docker exec -it botsharp /bin/bash
 
-|APIHomeScreenshot|
-
 
 Install in NuGet
 ^^^^^^^^^^^^^^^^
@@ -112,7 +93,6 @@ Install in NuGet
 ::
  
  PM> Install-Package BotSharp.Core
- PM> Install-Package BotSharp.RestApi
 
 Use BotSharp.NLP as a natural language processing toolkit alone.
 
@@ -120,14 +100,11 @@ Use BotSharp.NLP as a natural language processing toolkit alone.
 
  PM> Install-Package BotSharp.NLP
 
-.. _Botpress: https://github.com/botpress/botpress
-.. _Rasa UI: https://github.com/paschmann/rasa-ui
-.. _Articulate UI: https://github.com/Oceania2018/articulate-ui
-.. _Rasa Talk: https://github.com/jackdh/RasaTalk
-.. _Microsoft .NET Core: https://www.microsoft.com/net/download
+.. _Chatbot UI: https://github.com/mckaywrigley/chatbot-ui
+.. _Microsoft .NET SDK: https://www.microsoft.com/net/download
 .. _Node.js: https://nodejs.org
 .. _Docker: https://www.docker.com
 
+.. |BackendServiceHomeScreenshot| image:: /static/screenshots/BackendServiceHomeScreenshot.png
 .. |APIHomeScreenshot| image:: /static/screenshots/APIHome.png
-.. |ArticulateHomeScreenshot| image:: /static/screenshots/ArticulateHome.png
-.. |RasaUIHomeScreenshot| image:: /static/screenshots/RasaUIHome.png
+.. |ChatbotUIHomeScreenshot| image:: /static/screenshots/ChatbotUIHome.png

docs/overview.md

@@ -1,5 +1,5 @@
 # BotSharp Overview
-*Bo Peng & Haiping Chen --10/10/2018*
+*Haiping Chen --06/18/2023*
 
 BotSharp is an open source machine learning framework for AI Bot platform builder. This project involves natural language understanding 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.
 

src/WebStarter/WebStarter.csproj

@@ -8,6 +8,14 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <Compile Remove="knowledge_chunks\**" />
+    <Content Remove="knowledge_chunks\**" />
+    <EmbeddedResource Remove="knowledge_chunks\**" />
+    <None Remove="knowledge_chunks\**" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Remove="crawl-300d-2M-subword.bin" />
     <None Remove="Prompts\chat-samples.txt" />
     <None Remove="Prompts\chat-with-bob.txt" />
   </ItemGroup>