From 3df0565a631e3a22eddea571e928fff8cb8f0405 Mon Sep 17 00:00:00 2001 From: Haiping Chen Date: Mon, 18 Sep 2023 13:41:49 -0500 Subject: [PATCH] Bump version to v0.13.0. --- docs/conf.py | 4 ++-- docs/quick-start/get-started.md | 24 ++++++++++++++----- src/WebStarter/WebStarter.csproj | 3 ++- .../agent.json | 5 ++-- .../agents.json | 2 +- 5 files changed, 26 insertions(+), 12 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0f57d91c..71a47940 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,9 +64,9 @@ author = 'Haiping Chen' # built documents. # # The short X.Y version. -version = '0.12' +version = '0.13' # The full version, including alpha/beta/rc tags. -release = '0.12.0' +release = '0.13.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/quick-start/get-started.md b/docs/quick-start/get-started.md index eadcc765..d4d2d098 100644 --- a/docs/quick-start/get-started.md +++ b/docs/quick-start/get-started.md @@ -4,18 +4,30 @@ In order to allow developers to experience the convenience of BotSharp as quickly as possible, we have designed a basic sample project PizzaBot. This example allows you to run it quickly on your local machine. This example requires `llama-2` quantized model downloaded with `gguf` format if you want to run locally. +### Run in command line + ```console git clone https://github.com/SciSharp/BotSharp +cd BotSharp +dotnet run --project .\src\WebStarter\WebStarter.csproj -p SolutionName=PizzaBot ``` -Double click `PizzaBot` to start the solution. -![Pizza Bot](assets/PizzaBotSample1.png) - -Hit `WebStarter` to run it in Debug mode. -![Pizza Bot Starter](assets/PizzaBotSample2.png) - Here you go, you will see this running screen. + ![Pizza Bot Starter](assets/PizzaBotSample3.png) Next, try to access the chat from `Open API`, we public our [Postman collection](https://www.postman.com/orange-flare-634868/workspace/botsharp/collection/1346299-d1a31c49-825d-4449-bdc8-936c66ff6bfd). Remember to set the environment as `localhost`. + ![Pizza Bot Starter](assets/PizzaBotSample4.png) + + +### Run in debug mode + +If you have Visual Studio installed, you can run it in debug mode. +Double click `PizzaBot` to start the solution. + +![Pizza Bot](assets/PizzaBotSample1.png) + +Hit `WebStarter` to run it in Debug mode, or you can start from command line + +![Pizza Bot Starter](assets/PizzaBotSample2.png) \ No newline at end of file diff --git a/src/WebStarter/WebStarter.csproj b/src/WebStarter/WebStarter.csproj index b0d9b1fc..aa1aee08 100644 --- a/src/WebStarter/WebStarter.csproj +++ b/src/WebStarter/WebStarter.csproj @@ -52,13 +52,14 @@ + - + diff --git a/src/WebStarter/data/agents/c2b57a74-ae4e-4c81-b3ad-9ac5bff982bd/agent.json b/src/WebStarter/data/agents/c2b57a74-ae4e-4c81-b3ad-9ac5bff982bd/agent.json index b196e2f0..9b9c7ee1 100644 --- a/src/WebStarter/data/agents/c2b57a74-ae4e-4c81-b3ad-9ac5bff982bd/agent.json +++ b/src/WebStarter/data/agents/c2b57a74-ae4e-4c81-b3ad-9ac5bff982bd/agent.json @@ -1,7 +1,8 @@ { "name": "Ordering", - "description": "Make pizza order according to user's preference.", + "description": "Place new pizza order or inquiry existed order.", "createdDateTime": "2023-07-26T02:29:25.123224Z", "updatedDateTime": "2023-07-26T02:29:25.123274Z", - "id": "c2b57a74-ae4e-4c81-b3ad-9ac5bff982bd" + "id": "c2b57a74-ae4e-4c81-b3ad-9ac5bff982bd", + "allowRouting": true } \ No newline at end of file diff --git a/src/WebStarter/data/users/456e35c5-caf0-4d45-9084-b44a8ca717e4/agents.json b/src/WebStarter/data/users/456e35c5-caf0-4d45-9084-b44a8ca717e4/agents.json index 83e8c2af..5ce90dcb 100644 --- a/src/WebStarter/data/users/456e35c5-caf0-4d45-9084-b44a8ca717e4/agents.json +++ b/src/WebStarter/data/users/456e35c5-caf0-4d45-9084-b44a8ca717e4/agents.json @@ -22,7 +22,7 @@ }, { "userId": "456e35c5-caf0-4d45-9084-b44a8ca717e4", - "agentId": "03d3fb55-9ada-423b-a6b4-f9ecddf4b26e", + "agentId": "fe8c60aa-b114-4ef3-93cb-a8efeac80f75", "updatedTime": "2023-08-14T18:14:11.6833783Z", "createdTime": "2023-08-14T18:14:11.6829767Z", "id": "b10c3209-6fd6-41d1-afd9-ea9543be286d"