Skip to content

Commit ba1eaab

Browse files
hacheybjhacheybj
authored
Merge pull request #95 from botpress/rk_bot_management
Added Chatbot Management Content
2 parents ade5f24 + 332ffcb commit ba1eaab

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+259
-114
lines changed

‎docs/chatbot_management/analytics.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Analytics
3+
---
4+
5+
![Messaging channels](/img/docs/chatbot_charts.png)
6+
Analytics is available only for an activated bot, it holds infromation about the usage and performance of your bot. Analytics tab is per bot and it shows a dashboard that holds graphs, numbers and indexes about for the selected period.
7+
8+
## Selected Period
9+
You can change the selected period to focus on specific period details. By default it is set for the past week, you are still able to change it.
10+
11+
12+
## 1. Total Users
13+
The absolute total number of users during the selected period. Next to it an index that show the percentage of increase/decrease in the total users using the chatbot compared to previous priod(s).
14+
15+
## 2. New users
16+
The absolute number of new users during the selected period. Next to it an index that show the percentage of increase/decrease in the new users using the chatbot compared to previous priod(s).
17+
## 3. Returning Users
18+
The absolute number of returning users during the selected period. Next to it an index that show the percentage of increase/decrease in the returning users using the chatbot compared to previous priod(s).
19+
## 4. Session
20+
The absolute number of session/conversations opened with the chatbot during the selected period. Next to it an index that show the percentage of increase/decrease in the number of the opened sessios compared to previous priod(s).
21+
22+
## 5. Messages
23+
The absolute number of messages sent to the chatbot during the selected period. Next to it an index that show the percentage of increase/decrease in the number of the messages sent to the chatbot compared to previous priod(s).
24+
25+
## 6. Overall Dashboard
26+
This graph shows the relation between users, sessions and messages over a period of time.

‎docs/chatbot_management/chat.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Chat
3+
---
4+
5+
![Chatbot Logs](/img/docs/chatbot_chat.png)
6+
7+
Once you've published your chatbot, you can quickly test it out from the cloud dashboard in the 'Chat' tab of your chatbot.

‎docs/chatbot_management/config_variables.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Configuration Variables
3+
---
4+
![Chatbot Details](/img/docs/chatbot_config.png)
5+
You can define configuration variables that will be accessible inside your Hooks and Actions.
6+
7+
:::caution
8+
9+
- Values are not synchronized automatically on the cloud and must be configured manually.
10+
- Values set in studio are for development environment and values set in cloud are for production environment.
11+
12+
:::
13+
14+
![Chatbot Details](/img/docs/chatbot_config_steps.png)
15+
16+
1. Go to Chatbot Information > Configuration variables and create a Key and add development environment's value. Click save and republish your chatbot.
17+
2. On your cloud dashboard, under chatbot's Configuration Variables tab, you can set your production_value to the same key.(In case of different values for different environments)
18+

‎docs/chatbot_management/details.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Chatbot Details
3+
---
4+
# Chatbot Details
5+
6+
![Chatbot Details](/img/docs/chatbot_details.png)
7+
8+
9+
## Admin Name
10+
11+
The name displayed in the administration page. This name is only for the bot administrators. The end user will never see this name.
12+
13+
## Display Name, Description & Language
14+
15+
- Display name will be shown up in the chatbot's conversation.
16+
- Bot Description will be shown up in the Bot info page.
17+
18+
You can change your bot name, description and language from the studio.<br/>
19+
Go to Chatbot Information > General and edit the fields. Click save and republish your chatbot.
20+
![Chatbot Description](/img/docs/chatbot_description.png)
21+
22+
23+
24+
## Additional Details
25+
26+
You can add more details to your chatbot info page like Website URL, Email, Phone Number, Terms & Privacy policy URLs.<br/>
27+
Go to Chatbot Information > Additional Details > Edit. Click save and republish your chatbot.
28+
![Chatbot Description](/img/docs/chatbot_additional_details.png)
29+
30+
31+
32+
## Danger Zone
33+
34+
Danger Zone allows you to delete your chatbot permanently from your workspace.
35+
36+
:::danger
37+
38+
Additionally, make sure to backup your bot if you want to re-use it in the future. Click Download button (next to admin name) to have a copy of your bot before deleting it from your workspace.
39+
40+
:::

‎docs/chatbot_management/logs.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Logs
3+
---
4+
# Add Logs to your chatbot
5+
![Chatbot logs](/img/docs/chatbot_log.png)
6+
7+
## Steps to add logs to your actions.
8+
### Adding logger
9+
10+
![Chatbot Logs](/img/docs/chatbot_logs.png)
11+
1. Create an action.
12+
2. Add bp.logger.info("Some text") inside your action and save it.
13+
14+
15+
### Testing logs
16+
17+
![Chatbot Logs](/img/docs/chatbot_logs_2.png)
18+
19+
3. Go to the Explorer and add an action to any node. Click on publish.
20+
4. Now, go to your cloud dashboard navigate to your published chatbot.
21+
Have a chat with your bot in the 'Chat' tab of the menu.
22+
Switch to logs tab to check the logs of your actions.

‎docs/chatbot_management/messaging.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Messaging Channels
3+
---
4+
![Chatbot Details](/img/docs/chatbot_messenger.png)
5+
6+
Integrate your chatbot with various messaging channels.
7+
8+
Click on the following links to know more about each channel integration.
9+
1. [Messenger](./messaging-channels/../../messaging-channels/direct-integrations/facebook-messenger.md)
10+
2. [Slack](./messaging-channels/../../messaging-channels/direct-integrations/slack.md)
11+
3. [SunCo](./messaging-channels/../../messaging-channels/broker-integrations/sunco.md)
12+
4. [Teams](./messaging-channels/../../messaging-channels/direct-integrations/microsoft-teams.md)
13+
5. [Telegram](./messaging-channels/../../messaging-channels/direct-integrations/telegram.md)
14+
6. [Twilio](./messaging-channels/../../messaging-channels/broker-integrations/twilio.md)
15+
7. [Vonage](./messaging-channels/../../messaging-channels/broker-integrations/vonage.md)
16+
8. [Webchat](./messaging-channels/../../messaging-channels/direct-integrations/facebook-messenger.md)

‎docs/chatbot_management/misunderstood.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Misunderstood
3+
---
4+
5+
![Messaging channels](/img/docs/chatbot_mis.png)
6+
The misunderstood module holds information about the user messages that were misunderstood by the chatbot and it is available only for an activated bot.
7+
8+
## How does it work?
9+
10+
The chatbot determines that it didn't understand the user in three ways:
11+
12+
1. Big ambiguity between two or more intents with nearly the same confidence when matching what the user said
13+
2. When what the user said didn't match with any intent, a "none" intent is selected by the chatbot
14+
3. The user clicked the "thumbs down" emoji on an elected Q&A
15+
16+
## Continuous Learning
17+
18+
By consulting the misunderstood module, you guarantee that your bot is continuously learning and growing. Once a user input is identified as misunderstood, you can either:
19+
20+
- **Amend**: You can amend your intent(s) or QnA(s) utterances with what was not understood, or
21+
- **Ignore**: You can choose to ignore a statement, so it is not logged again as misunderstood.
22+
23+
## Automatic Utterance Clustering
24+
25+
In order to make it easier for our builder (conversation designers, developers, etc.) we have added a new functionality in the misunderstood module, which is the automatic utterance clustering. When a builder click an utterance to take a decision about, the user statements are reordered to push all the matching/similar statements to the one the builder have chose.
26+
27+
So for example, below are the misunderstood statements:
28+
29+
![Misunderstood](/img/docs/chatbot_miss.png)
30+
31+
We can see, food related statements are in the middle, when we select one of them, it is pushed up to the top along with other matching/similar statements.
32+
33+
### Utterance operations:
34+
35+
![Misunderstood](/img/docs/chatbot_miss3.png)
36+
37+
- **Amend**: You can amend your intent(s) or QnA(s) utterances with what was not understood.
38+
- **Ignore**: You can choose to ignore a statement, so it is not logged again as a misunderstood.
39+
- **Revert**: And you can also **Revert** back to previous status.
40+
41+
## Misunderstood Status
42+
43+
The misunderstood messages split into 3 categories:
44+
45+
1. **Pending**: Messages that must either be Ignored or Amended.
46+
2. **Resolved**: Messages that have been Amended.
47+
3. **Ignored**: Messages that have been Ignored.

‎docs/chatbot_management/overview.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Overview
3+
slug: /management/overview
4+
hide_title: true
5+
---
6+
7+
# Chatbot Management
8+
![Messaging channels](/img/docs/chatbot_management_banner.png)
9+
10+
11+
12+
Get to know everything about configuring and managing your chatbots in Botpress Cloud

‎docs/messaging-channels/botpress-webchat/website-embedding/website-embedding.md

-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ title: Website Embedding
88
1. Make sure you've [published your chatbot](/quickstart/publishing-your-chatbot) to botpress cloud dashboard.
99
2. Go to your published chatbot and select `Web Chat` option under `Channels` tab.
1010
3. Copy the Preconfigured URL script and paste it in the `<body></body>` tag of your HTML page.
11-
12-
1311
(Optional) Moreover, click on the `Custom Configuration` tab if you want to customize the webchat configurations.
1412

1513
![Messaging channels](/img/docs/custom-config.png)

‎docs/messaging-channels/broker-integrations/smooch-sunshine-conversations.md ‎docs/messaging-channels/broker-integrations/sunco.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: smooch-sunshine-conversations
2+
id: sunco
33
title: Sunshine Conversations
44
---
55

@@ -43,11 +43,8 @@ The webhook secret is needed to validate webhooks requests. You get a webhook se
4343
1. Select `v2` as your webhook version
4444
1. Select **Conversation message** and **Postbacks** in the basic triggers
4545
1. Click **Create Webhook**. You will see the webhook you created in the table, and the secret in the last column
46+
1. Copy paste the webhook secret in the **Webhook Secret** channel configuration
4647

47-
## Connecting with Botpress Cloud
48+
### Save Configuration
4849

49-
![Messaging channels](/img/docs/sunco-config.png)
50-
51-
1. Go to your deployed bot and go to channels tab. Select SunCo.
52-
2. Paste your App ID. Key ID, KEY Secret, Webhook Secret.
53-
3. Enable the channel and click on save.
50+
Channel configuration is complete, you can now click **Save**

‎docs/messaging-channels/broker-integrations/twilio.md

-7
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,3 @@ To receive messages from Twilio, you will need to setup a webhook
3232
1. Click on your phone number
3333
1. Scroll down the phone number settings page
3434
1. Copy paste the webhook url provided in the channel configuration UI to the **A Message Comes In** field
35-
36-
37-
## Connecting with Botpress Cloud
38-
39-
![Messaging channels](/img/docs/twilio-config.png)
40-
41-
1. Paste your Account SID, Auth Token, enable the channel and click on save.

‎docs/messaging-channels/broker-integrations/vonage.md

-7
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,3 @@ You can use the Vonage sandbox to test you channel with Whatsapp
3636
1. Check the **Use Testing API** box in your channel configuration
3737
1. Go to your [Sandbox Settings](https://dashboard.nexmo.com/messages/sandbox)
3838
1. Copy paste the webhook url provided in the channel configuration UI to the **Inbound** and **Status** fields in the **Webhooks** section
39-
40-
## Connecting with Botpress Cloud
41-
42-
![Messaging channels](/img/docs/vonage-config.png)
43-
44-
1. Paste your API Key, API Secret, Signature Secret.
45-
2. Enable the channel and click on save.

‎docs/messaging-channels/direct-integrations/facebook-messenger.md

+12-17
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ title: Facebook Messenger
1010

1111
You will need a Facebook app and a Facebook page to connect you bot to messenger
1212

13-
#### Create a Facebook App
13+
### Create a Facebook App
1414

1515
To create a Facebook App, log in to your Facebook account and go to the [Facebook for Developers website](https://developers.facebook.com/). Select **My Apps** from the top menu, and create a new app. For more details and assistance, visit the [Facebook developer documentation](https://developers.facebook.com/docs/development)
1616

17-
#### Create a Facebook Page
17+
### Create a Facebook Page
1818

1919
If you do not already have a Facebook page you will need to create one. [You can find details on how to create a new Facebook page here](https://www.facebook.com/pages/creation/)
2020

2121
To link your chatbot to a pre-existing page, you must have an administrator or developer role
2222

23-
#### Channel Configuration
23+
## Channel Configuration
2424

25-
#### API version
25+
### API version
2626

2727
The messenger channel is made to interact with version 12.0 or higher of the Messenger API. It is not the default version so it must be changed in your app's settings
2828

@@ -64,19 +64,14 @@ You can generate any random alphanumerical string for this configuration. Paste
6464

6565
Channel configuration is complete, you can now click **Save**. It is important you save your configuration before configuring the webhook, otherwise Messenger will be unable to validate the webhook url
6666

67+
## Webhook Configuration
6768

68-
69-
70-
71-
## Connecting with Botpress Cloud
72-
73-
![Messaging channels](/img/docs/messenger-config.png)
74-
69+
To receive messages from Messenger, you will need to setup a webhook
7570

7671
1. Go to your Facebook App.
77-
2. In the left sidebar, expand the **Messenger** menu and select **Settings**
78-
3. In the **Webhooks** section, click **Add Callback URL**
79-
4. Copy paste the webhook url provided in the channel configuration UI
80-
5. Copy paste the verify token you generated earlier
81-
6. Click on **Verify and save**. Make sure your channel configuration was saved before doing this step, otherwise the webhook validation will fail
82-
7. Click on **Add subscriptions** and add `messages` and `messaging_postbacks` to your webhook
72+
1. In the left sidebar, expand the **Messenger** menu and select **Settings**
73+
1. In the **Webhooks** section, click **Add Callback URL**
74+
1. Copy paste the webhook url provided in the channel configuration UI
75+
1. Copy paste the verify token you generated earlier
76+
1. Click on **Verify and save**. Make sure your channel configuration was saved before doing this step, otherwise the webhook validation will fail
77+
1. Click on **Add subscriptions** and add `messages` and `messaging_postbacks` to your webhook

‎docs/messaging-channels/direct-integrations/microsoft-teams.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ Your Microsoft Account should have access to Azure and Teams. You can check out
1414

1515
## Channel Configuration
1616

17-
## Register App
17+
### Register App
1818

1919
1. In the Azure portal, open the [App registrations](https://portal.azure.com#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) page
2020
1. Click **New registration**, then choose a name for your application
2121
1. In the section **Supported account types**, choose **Accounts in any organizational directory and personal Microsoft accounts**, then click **Register**
2222
1. Copy paste the value of `Application (client) ID` to the **App Id** channel configuration
2323

24-
## App Password
24+
### App Password
2525

2626
1. Click **Certificates & secrets**, then click **New client secret**, then fill in the required fields
2727
1. Copy paste the the value in the **Value** column to the **App Secret** channel configuration
@@ -38,11 +38,3 @@ Channel configuration is complete, you can now click **Save**
3838
1. Copy paste the webhook url provided in the channel configuration UI to the **Messaging endpoint** field
3939
1. Click **Register**
4040
1. On the next page (**Connect to channels**), under the section, **Add a featured channel**, click **Configure Microsoft Teams Channel**, then click **Save**
41-
42-
## Connecting with Botpress Cloud
43-
44-
![Messaging channels](/img/docs/teams-config.png)
45-
46-
1. Paste your App ID and App Password and enable the channel.
47-
2. Click save and send message to your bot on teams.
48-

‎docs/messaging-channels/direct-integrations/slack.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ You will need a Slack App to connect your bot to Slack
1616

1717
## Channel Configuration
1818

19-
## Signing Secret
19+
### Signing Secret
2020

2121
The signing secret is used to verify webhook requests
2222

2323
1. In the left sidebar, click on **Settings** > **Basic Information**
2424
2. Scroll down to **App Credentials** section. Copy paste the value of the signing secret to the **Signing Secret** channel configuration
2525

26-
## Bot Token
26+
### Bot Token
2727

2828
The bot token is used to authenticate requests made to the Slack API
2929

@@ -67,12 +67,3 @@ Your slack app needs to be added to your workspace to allow Slack users to commu
6767
1. In the left sidebar, click on **Features** > **App Home**
6868
1. Scroll down and tick **Allow users to send Slash commands and messages from the messages tab**
6969
1. In Slack, under the **Apps** section of the sidebar, click the **+ Add apps** button. In the search bar, type the name of your Slack app. Click on your Slack app in the search results. You can now chat with your Slack App
70-
71-
72-
73-
## Connecting with Botpress Cloud
74-
75-
![Messaging channels](/img/docs/slack-config.png)
76-
77-
1. Paste your Signing Secret and Bot Token and enable the channel.
78-
2. Click save and send message to your bot on slack.

‎docs/messaging-channels/direct-integrations/telegram.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,8 @@ When you create a Telegram bot, Botfather will automatically generate a token. T
2424

2525
If your existing token is compromised or you lost it for some reason, use the `/token` command to generate a new one
2626

27+
### Bot Token
2728

28-
## Connecting with Botpress Cloud
29+
Copy paste your telegram bot token into the **Bot Token** channel configuration and click **Save**. Webhooks will be created automatically
2930

30-
31-
32-
![Messaging channels](/img/docs/telegram-config.png)
33-
34-
Copy paste your telegram bot token into the **Bot Token** channel configuration, enable the channel and click **Save**.
31+
1. Copy paste your telegram bot token into the Bot Token channel configuration and click Save. Webhooks will be created automatically

‎docusaurus.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ const config = {
9595
},
9696
{
9797
type: "doc",
98-
docId: "analytics/analytics",
98+
docId: "chatbot_management/overview",
9999
position: "left",
100-
label: "Analytics",
100+
label: "Chatbot Management",
101101
},
102102
{
103103
type: "docsVersionDropdown",

0 commit comments

Comments
 (0)