Skip to content

Commit

Permalink
Bump version to v0.13.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
Oceania2018 committed Sep 18, 2023
1 parent 15e8bb0 commit 3df0565
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@
# 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.
Expand Down
24 changes: 18 additions & 6 deletions docs/quick-start/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 2 additions & 1 deletion src/WebStarter/WebStarter.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,14 @@
<ItemGroup Condition="$(SolutionName)==BotSharp">
<ProjectReference Include="..\Infrastructure\BotSharp.Core\BotSharp.Core.csproj" />
<ProjectReference Include="..\Infrastructure\BotSharp.OpenAPI\BotSharp.OpenAPI.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.MongoStorage\BotSharp.Plugin.MongoStorage.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.AzureOpenAI\BotSharp.Plugin.AzureOpenAI.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.ChatbotUI\BotSharp.Plugin.ChatbotUI.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.HuggingFace\BotSharp.Plugin.HuggingFace.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.KnowledgeBase\BotSharp.Plugin.KnowledgeBase.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.LLamaSharp\BotSharp.Plugin.LLamaSharp.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.MetaAI\BotSharp.Plugin.MetaAI.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.MongoStorage\BotSharp.Plugin.MongoStorage.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.MetaMessenger\BotSharp.Plugin.MetaMessenger.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.PaddleSharp\BotSharp.Plugin.PaddleSharp.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.Qdrant\BotSharp.Plugin.Qdrant.csproj" />
<ProjectReference Include="..\Plugins\BotSharp.Plugin.RoutingSpeeder\BotSharp.Plugin.RoutingSpeeder.csproj" />
Expand Down
Original file line number Diff line number Diff line change
@@ -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
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 3df0565

Please sign in to comment.