The Botsociety2 export is currently in development. As of now, the only integration available is Dialogflow for the Google Assistant preset. We are planning to support all of the other presets and the Rasa export integration in the next 4 weeks. Sign up to stay updated with our progress.
The build mode allows you to export your Botsociety design to bot building technologies and other platforms. Once you set up your design in the build mode, you can export to different platforms without having to chnage anything. If you can't find the platform that you are lookiing for, drop us a line at firstname.lastname@example.org or consider building a custom integration.
Adding Build Mode metadata
Clicking on in the left panel icon takes you to Build Mode, which is the page in which you can add build mode metadata to your design and get it ready for export.
You should see the same design canvas with your paths and messages, but note that the path header and every single message now has intents associated with them.
On the left-hand side Build Mode panel, you will be able to choose a platform for your export and manage the intents and Entities in the design.
Let’s explore Build Mode together.
Intents are actions that a user desires to take which define the current context of the conversation. They are used in Natural Language Processing and in Conversation Design, and many platforms support them.
Every message has a default intent intent associated by default.
To edit the intent, click on the current value, and a dropdown window will appear:
You can then select one of your intents, or create a new one.
To create a new Intent, simply click on “Create new Intent”, and a new window will ask you to name your new Intent, which will be added to the list.
You can edit an Intent’s name at any time by clicking on the Edit intent button button next to it in the intent dropdown list.
Entities, also known as variables, are objects that provide clarification or specific context for a particular intent.
To add an Entity, highlight any word in one of your messages, and a new prompt will appear, through which you can define a new Entity.
In this example, we will define the Entity "city", associated to the words "San Francisco."
All mentions of "San Francisco" throughout the design will be associated with the Entity "city".
You will see a complete list of all your Entities on the Build Mode panel on the left-hand side of the screen, including information about their Type and a count of how many times a specific Entity is found in the design.
Types allow you to match your Entities with Intents used by external platforms, such as Dialogflow.
By clicking on the Type value next to a Entity, you will be able to edit it.
You can create and edit a set of custom types. Just click on “Add custom type” at the bottom of the drop down and a prompt will ask you to name your new Type.
Exporting to Dialogflow
Botsociety supports exporting to Dialogflow, a major conversational AI platform.
First, choose or continue with Dialogflow as your platform of choice, then fill out the design with build mode metadata such as intents, entities, etc.
Designing your Welcome Path
The welcome path/messages represent the initial exchange between the user and the virtual assistant you are designing. It is the message or messages triggered by default once the user summons your bot.
When you click on export, you are required to select the welcome path, which is usually the first path in your design.
Assistant Path (specific to Google Assistant and Alexa)
Note that in the case of Google Assistant and Alexa, the assistants will take care of the message “Google Assistant/Alexa: Ok, here is Botsociety,” so you don’t need to include that in your design. So, in the following messages, you don’t need to include the first two messages in your design, as the assistant will take care of them for you:
- User: Ok Google/Alexa, let me talk with Botsociety
- Google Assistant/Alexa: Ok, here is Botsociety.
- Botsociety Bot: Here is Botsociety. How can I help you?
If you do want to include the first two messages in your design, you should create a separate path and link it to the beginning of the conversation in the welcome path (in this case, message 3).
In that case, in the export pop up window you should select the path which begins with message 3 as the welcome path. We choose the first intent in your welcome path and use that as the welcome intent when exporting to Dialogflow.
Here, the intent order pizza refers to the main conversation between the user and the bot, which is why it is defined as the welcome path that Dialogflow will adopt as the welcome intent for the design.
You can export messages with choices in two ways:
- The choice brings to only one intent (triggers the same intent) and defines an entity
- The choice can trigger multiple intents
To design and export for 1, follow the steps below the image:
- Add a message with choices (ex. Carousel with clickable items)
- Delete the resulting paths
- Continue designing in the same path
- In the build mode, assign a different intent to the message following the carousel message.
- Define the value of the entity as part of the text of the carousel
Otherwise, the choices will trigger multiple intents, as mentioned in 2 and shown in the example below:
Creating Follow up intents
In Botsociety, you can set follow up intents that will be exported to Dialogflow as ‘custom’ follow up intents. Since these are custom intents, they do not have utterances and training phrases when exported to Dialogflow.
For guidance, you can set up your intents and name them according to the convention below. The intents below are only for guidance and you can instead add any follow up intents you want, with the naming convention
- For follow up intent of type yes/no:
- Name an intent
- Another one
- Name an intent
- For follow up intent of type later:
- For follow up intent of type cancel:
- For follow up intent of type more:
- For follow up intent of type next:
- For follow up intent of type previous:
- For follow up intent of type repeat:
- For follow up intent of type select.number:
- For the Fallback built-in type: See next section
Remember that since these are custom intents, they will not have training phrases ready in Dialogflow, so you will have to add those manually as utterances on Botsociety or Dialogflow.
Adding Repair Paths (Fallback Paths)
General Fallback Path
If you want a path to be a general repair (fallback) path, you will need to have a follow-up intent of built-in type “fallback” in Dialogflow. In order to do that, include one of the following in the path name:
This will create the general fallback path for your design, which can only be one path. If there are more than one fallback paths, Dialogflow will mark that as an error and the export will fail.
Dedicated Fallback Paths
If you want to create a dedicated fallback built-in intent, the following must be included in your intent name:
You can add the name of the path or a desired phrase to that to make an intent name like
followup-fallback-ask-address. You can add as many dedicated repair (fallback) paths as you want.
Note that this intent has to be inside a child path of the path you want to repair. You can have multiple fallback follow-up intents, and each one will be considered a dedicated repair path.
Linking your Dialogflow Account
Authenticate your Google account which is linked with your Dialogflow by clicking on the email and “Allow”. Click “Export” and a pop up window will appear, prompting you to select the appropriate Dialogflow agent and more details.
In this window, choose the welcome path - so the first path in your design; choose the platform equivalent to the one you are designing on Dialogflow (Messenger, Default, Unspecified, etc.).
Selecting an agent
Finally, select the agent you want to export to. Clicking on the agent will begin to process the export. If your export is successful, you can find it on your Dialogflow account. If there have been errors during the export, you should see error messages on the bottom left of the screen with the reason for the failure.
Exporting to Rasa
Botsociety will soon support exporting to RASA, an open-source conversational AI platform.
To export your design, simply click on Export while in the Build page after selecting RASA in the platforms at the top. This will download a ZIP file with your chatbot information, which you can then import into RASA.