Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ This command starts a local development server and opens up a browser window. Mo

#### About search

In order to play aroud with search locally you need to set algolia env variables by default set to "empty"
In order to play around with search locally you need to set algolia env variables by default set to "empty"
`export ALGOLIA_API_KEY =__YOUR_ALGOLIA_API_KEY__`
`export ALGOLIA_APP_ID =__YOUR_ALGOLIA_APP_ID__`
`export ALGOLIA_INDEX =__YOUR_ALGOLIA_INDEX__`

A temporary solution has been done since we redirect everything from /docs/ to this documetation site. Whenever we remove this redirect we should remove the `customWithBaseUrl` function in the `src/theme/SearchBar/index.tsx` and use the native `withBaseUrl` instead.
A temporary solution has been done since we redirect everything from /docs/ to this documentation site. Whenever we remove this redirect we should remove the `customWithBaseUrl` function in the `src/theme/SearchBar/index.tsx` and use the native `withBaseUrl` instead.

### Build

Expand All @@ -35,4 +35,4 @@ This command generates static content into the `build` directory and can be serv

### Deployment

Deployement is handled by Vercel
Deployment is handled by Vercel
12 changes: 6 additions & 6 deletions docs/analytics/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ hide_title: true

![Messaging channels](/img/docs/analytics.png)

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.
Analytics is available only for an activated bot, it holds information 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.



Expand All @@ -17,31 +17,31 @@ You can change the selected period to focus on specific period details. By defau
<!-- ![Messaging channels](/img/docs/calendar.png) -->

## Total Users
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).
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 period(s).

<!-- ![image](https://user-images.githubusercontent.com/89806971/200643380-3970d933-14db-4eb3-83a5-353ffa3d8b35.png) -->


## New users
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).
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 period(s).

<!-- ![image](https://user-images.githubusercontent.com/89806971/200643772-ba754e92-dc28-4350-beca-d451c93e1e61.png) -->


## Returning Users
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).
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 period(s).

<!-- ![image](https://user-images.githubusercontent.com/89806971/200643897-de31f33b-fd46-40fb-96c8-6b6173a24f80.png) -->


## Session
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).
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 sessions compared to previous period(s).

<!-- ![image](https://user-images.githubusercontent.com/89806971/200644081-69cb0278-a349-4660-833a-6726e3e0ce20.png) -->


## Messages
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).
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 period(s).

<!-- ![image](https://user-images.githubusercontent.com/89806971/200644188-f6722343-be9b-4c08-85e8-5b308c12e5fb.png) -->

Expand Down
12 changes: 6 additions & 6 deletions docs/management/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ title: Analytics
---

![Analytics](/img/docs/chatbot_charts.png)
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.
Analytics is available only for an activated bot, it holds information 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.

## Selected Period
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.


## 1. Total Users
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).
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 period(s).

## 2. New users
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).
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 period(s).
## 3. Returning Users
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).
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 period(s).
## 4. Session
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).
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 sessions compared to previous period(s).

## 5. Messages
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).
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 period(s).

## 6. Overall Dashboard
This graph shows the relation between users, sessions and messages over a period of time.
2 changes: 1 addition & 1 deletion docs/management/misunderstood.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By consulting the misunderstood module, you guarantee that your bot is continuou

## Automatic Utterance Clustering

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.
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 chosen by the builder.

So for example, below are the misunderstood statements:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Website Embedding

![Messaging channels](/img/docs/webchat-banner.png)

1. Make sure you've [published your chatbot](/quickstart/publishing-your-chatbot) to botpress cloud dashboard.
1. Make sure you've [published your chatbot](/quickstart/publishing-your-chatbot) to Botpress cloud dashboard.
2. Go to your published chatbot and select `Web Chat` option under `Channels` tab.
3. Copy the Preconfigured URL script and paste it in the `<body></body>` tag of your HTML page.
(Optional) Moreover, click on the `Custom Configuration` tab if you want to customize the webchat configurations.
Expand Down
10 changes: 5 additions & 5 deletions docs/messaging-channels/broker-integrations/sunco.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ You will need a Smooch app with a channel configured before connecting Smooch to

1. On the Smooch [home page](https://app.smooch.io/), click on **Create new app.**
1. Enter a name for your app and click **Create App**
1. Connect a channel to your app (Telegram, Whatsapp, or any other listed channel)
1. Connect a channel to your app (Telegram, WhatsApp, or any other listed channel)
1. You should see a channel in the **Overview** section of your app

## Configuration

### App Id
### App ID

The smooch channel needs the app id to identify the smooch app when making API calls

1. Go to the **Settings** section of your app
1. You should see an **App Id** section if you scroll down. Copy paste this value to the **App Id** channel configuration
1. You should see an **App ID** section if you scroll down. Copy paste this value to the **App ID** channel configuration

### Key Id and Key Secret
### Key ID and Key Secret

The key id and secret are needed to authenticate API calls to Smooch

1. At the bottom of to the **Settings** section of your app, click **Generate API key**
1. Copy paste the id (the one that starts with `app_`) in the **Key Id** channel configuration
1. Copy paste the id (the one that starts with `app_`) in the **Key ID** channel configuration
1. Copy paste the secret in the **Key Secret** configuration

### Webhook Secret
Expand Down
2 changes: 1 addition & 1 deletion docs/messaging-channels/broker-integrations/twilio.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Channel configuration is complete, you can now click **Save**

## Webhook Configuration

To receive messages from Twilio, you will need to setup a webhook
To receive messages from Twilio, you will need to set up a webhook

1. Click on **Explore Products** in the left pannel
1. Click on **Messaging**
Expand Down
2 changes: 1 addition & 1 deletion docs/messaging-channels/broker-integrations/vonage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Channel configuration is complete, you can now click **Save**

### Sandbox

You can use the Vonage sandbox to test you channel with Whatsapp
You can use the Vonage sandbox to test you channel with WhatsApp

1. Check the **Use Testing API** box in your channel configuration
1. Go to your [Sandbox Settings](https://dashboard.nexmo.com/messages/sandbox)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To create a Facebook App, log in to your Facebook account and go to the [Faceboo

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/)

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

## Channel Configuration

Expand Down Expand Up @@ -57,7 +57,7 @@ The page ID and access token are used to send messages to the Messenger API

1. In the left sidebar, expand the **Messenger** menu and select **Settings**
1. In the **Access Tokens** section, click **Add or remove Pages** and add you facebook page
1. Copy the number under you page name and paste it in you **Page Id** channel configuration
1. Copy the number under you page name and paste it in you **Page ID** channel configuration
1. Click on **Generate token**. Copy this token and paste it in the **Access Token** channel configuration in cloud dashboard.

### Verify Token
Expand All @@ -68,16 +68,16 @@ You can generate any random alphanumerical string for this configuration. Paste

### Save Configuration

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.
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.

## Webhook Configuration

To receive messages from Messenger, you will need to setup a webhook.
To receive messages from Messenger, you will need to set up a webhook.

1. Go to your Facebook App.
1. In the left sidebar, expand the **Messenger** menu and select **Settings**
1. In the **Webhooks** section, click **Add Callback URL**
1. Copy paste the webhook url provided in the channel configuration UI from cloud dashboard.
1. Copy paste the verify token you generated earlier.
1. Click on **Verify and save**. Make sure your channel configuration was saved before doing this step, otherwise the webhook validation will fail.
1. Click on **Verify and save**. Make sure your channel configuration was saved before doing this step; otherwise, the webhook validation will fail.
1. Click on **Add subscriptions** and add `messages` and `messaging_postbacks` to your webhook.
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ Your Microsoft Account should have access to Azure and Teams. You can check out
1. In the Azure portal, open the [App registrations](https://portal.azure.com#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) page
1. Click **New registration**, then choose a name for your application
1. In the section **Supported account types**, choose **Accounts in any organizational directory and personal Microsoft accounts**, then click **Register**
1. Copy paste the value of `Application (client) ID` to the **App Id** channel configuration
1. Copy paste the value of `Application (client) ID` to the **App ID** channel configuration

### App Password

1. Click **Certificates & secrets**, then click **New client secret**, then fill in the required fields
1. Copy paste the the value in the **Value** column to the **App Secret** channel configuration
1. Copy paste the value in the **Value** column to the **App Secret** channel configuration

### Save Configuration

Expand All @@ -34,7 +34,7 @@ Channel configuration is complete, you can now click **Save**

1. Navigate to the [Bot Framework Registration Page](https://dev.botframework.com/bots/new)
1. Fill the **Display name** and **Bot handle** fields with whatever value
1. Copy paste you **App Id** to the app id field
1. Copy paste you **App ID** to the app id field
1. Copy paste the webhook url provided in the channel configuration UI to the **Messaging endpoint** field
1. Click **Register**
1. On the next page (**Connect to channels**), under the section, **Add a featured channel**, click **Configure Microsoft Teams Channel**, then click **Save**
4 changes: 2 additions & 2 deletions docs/messaging-channels/direct-integrations/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The bot token is used to authenticate requests made to the Slack API

### Save Configuration

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

## Webhook Configuration

Expand All @@ -46,7 +46,7 @@ Slack sends regular events such as messages to the event webhook
1. Turn on events by click the On/Off button
1. Under **Subscribe to bot event**, add `message.im` and `message.channels`
1. Copy paste the webhook url provided in the channel configuration UI to the **Request URL** field
1. Click the **Save Changes** button. Make sure your slack channel configuration is saved before doing this step, otherwise webhook validation will fail
1. Click the **Save Changes** button. Make sure your slack channel configuration is saved before doing this step; otherwise, webhook validation will fail
1. A yellow banner will be displayed at the top of the screen. Click the **reinstall your App** link

### Interactivity Webhook
Expand Down
4 changes: 2 additions & 2 deletions docs/messaging-channels/direct-integrations/telegram.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ To create a bot on Telegram, use Telegram's BotFather. BotFather is a bot on Tel

The name of your bot is displayed in contact details and elsewhere.

The Username is a short name to be used in mentions and t.me links. Usernames are 5-32 characters long and are case insensitive but may only include Latin characters, numbers, and underscores. Your bot's username must end in `bot`, such as `tetris_bot` or `TetrisBot`
The Username is a short name to be used in mentions and t.me links. Usernames are 5-32 characters long and are case-insensitive but may only include Latin characters, numbers, and underscores. Your bot's username must end in `bot`, such as `tetris_bot` or `TetrisBot`

## Channel Configuration

### Generate an Authorization Token

When you create a Telegram bot, Botfather will automatically generate a token. The token is a string that is required to authorize the bot and send requests to the Bot API. Keep your token secure and store it safely; anyone can use it to control your bot.
When you create a Telegram bot, BotFather will automatically generate a token. The token is a string that is required to authorize the bot and send requests to the Bot API. Keep your token secure and store it safely; anyone can use it to control your bot.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/create-your-first-chatbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /quickstart/create-your-first-chatbot

![Create a chatbot](/img/docs/create-chatbot.png "Create a chatbot")

You can start with an Empty Bot or pick one from the templates provided by botpress.
You can start with an Empty Bot or pick one from the templates provided by Botpress.

Click on `Create` button and select the destination folder to save your bots locally.

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/download-studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Experience the speed of using Botpress Studio, a continuously enhanced interface



Now that you are [logged in](/login-signup) in to your account. Next, we should download the suitable Botpress Studio version.
Now that you are [logged in](/login-signup) to your account. Next, we should download the suitable Botpress Studio version.

Click the Studio version that is suitable for your OS. The Studio will get downloaded. After it is downloaded, install it and start it.

Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart/login.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 1. Login & Signup
title: 1. Login & Sign-up
slug: /quickstart/login-signup
---

Expand Down Expand Up @@ -40,7 +40,7 @@ From there, choose the suitable authentication provider.
3. Sign in with your credentials


## Github
## GitHub
You can securely access your account's resources by authenticating through GitHub.


Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ hide_title: true

# 🔥 Quickstart

This guide will help you build and deploy your chatbot to botpress cloud in 5 easy steps.
This guide will help you build and deploy your chatbot to Botpress cloud in 5 easy steps.

1. [Login/Sign Up to Botpress Cloud Dashboard](/quickstart/login-signup)
2. [Downloading Botpress Studio](/quickstart/create-your-first-chatbot)
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/testing-your-chatbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ After the bot is successfully published to the cloud, you can test it from the c
2. In the top navigation menu, click on `Chat`
3. Chat with a Hi to test if bot responds back.

Hurray! 🎉 You've successfully created and published your bot on botpress cloud.
Hurray! 🎉 You've successfully created and published your bot on Botpress cloud.


:::info
Expand Down
Loading