Tutorial: Building Assistants
Tutorial: Building Assistants
After following the basics of setting up an assistant in the Rasa Tutorial, we’ll now walk through building a basic FAQ chatbot and then build a bot that can handle contextual conversations.
Building a simple FAQ assistant
FAQ assistants are the simplest assistants to build and a good place to get started. These assistants allow the user to ask a simple question and get a response. We’re going to build a basic FAQ assistant using features of Rasa designed specifically for this type of assistant.
In this section we’re going to cover the following topics:
- Responding to simple intents with the MemoizationPolicy
- Handling FAQs using the ResponseSelector
We’re going to use content from Sara, the Rasa assistant that, amongst other things, helps the user get started with the Rasa products. You should first install Rasa using the Step-by-step Installation Guide and then follow the Rasa Tutorial to make sure you know the basics.
To prepare for this tutorial, we’re going to create a new directory and start a new Rasa project.
mkdir rasa-assistant
rasa init
Let’s remove the default content from this bot, so that the nlu.md, stories.md and domain.yml files are empty.
Memoization Policy
The MemoizationPolicy remembers examples from training stories for up to a max_history of turns. The number of “turns” includes messages the user sent, and actions the assistant performed. For the purpose of a simple, context-less FAQ bot, we only need to pay attention to the last message the user sent, and therefore we’ll set that to 1.
You can do this by editing your config.yml file as follows (you can remove TEDPolicy for now):
policies:
- name: MemoizationPolicy
max_history: 1
- name: MappingPolicy
Now that we’ve defined our policies, we can add some stories for the goodbye, thank and greet intents to the stories.md file:
## greet
* greet
- utter_greet
## thank
* thank
- utter_noworries
## goodbye
* bye
- utter_bye
We’ll also need to add the intents, actions and responses to our domain.yml file in the following sections:
intents:
- greet
- bye
- thank
responses:
utter_noworries:
- text: No worries!
utter_greet:
- text: Hi
utter_bye:
- text: Bye!
Finally, we’ll copy over some NLU data from Sara into our nlu.md file:
## intent:greet
- Hi
- Hey
- Hi bot
- Hey bot
- Hello
- Good morning
- hi again
- hi folks
## intent:bye
- goodbye
- goodnight
- good bye
- good night
- see ya
- toodle-oo
- bye bye
- gotta go
- farewell
## intent:thank
- Thanks
- Thank you
- Thank you so much
- Thanks bot
- Thanks for that
- cheers
You can now train a first model and test the bot, by running the following commands:
rasa train
rasa shell
This bot should now be able to reply to the intents we defined consistently, and in any order.
Response Selectors
The ResponseSelector NLU component is designed to make it easier to handle dialogue elements like Small Talk and FAQ messages in a simple manner. By using the ResponseSelector, you only need one story to handle all FAQs, instead of adding new stories every time you want to increase your bot’s scope.
People often ask Sara different questions surrounding the Rasa products, so let’s start with three intents: ask_channels, ask_languages, and ask_rasax. We’re going to copy over some NLU data from the Sara training data into our nlu.md. It’s important that these intents have an faq/ prefix, so they’re recognised as the faq intent by the ResponseSelector:
## intent: faq/ask_channels
- What channels of communication does rasa support?
- what channels do you support?
- what chat channels does rasa uses
- channels supported by Rasa
- which messaging channels does rasa support?
## intent: faq/ask_languages
- what language does rasa support?
- which language do you support?
- which languages supports rasa
- can I use rasa also for another laguage?
- languages supported
## intent: faq/ask_rasax
- I want information about rasa x
- i want to learn more about Rasa X
- what is rasa x?
- Can you tell me about rasa x?
- Tell me about rasa x
- tell me what is rasa x
Next, we’ll define the responses associated with these FAQs in a new file called responses.md in the data/ directory:
## ask channels
* faq/ask_channels
- We have a comprehensive list of [supported connectors](/content/docs/core/connectors/index.html), but if you don't see the one you're looking for, you can always create a custom connector by following [this guide](/content/docs/rasa/user-guide/connectors/custom-connectors/index.html).
## ask languages
* faq/ask_languages
- You can use Rasa to build assistants in any language you want!
## ask rasa x
* faq/ask_rasax
- Rasa X is a tool to learn from real conversations and improve your assistant. Read more [here](/content/docs/rasa-x/index.html)
The ResponseSelector should already be at the end of the NLU pipeline in our config.yml:
language: en
pipeline:
- name: WhitespaceTokenizer
- name: RegexFeaturizer
- name: LexicalSyntacticFeaturizer
- name: CountVectorsFeaturizer
- name: CountVectorsFeaturizer
analyzer: "char_wb"
min_ngram: 1
max_ngram: 4
- name: DIETClassifier
epochs: 100
- name: EntitySynonymMapper
- name: ResponseSelector
epochs: 100
Now that we’ve defined the NLU side, we need to make Core aware of these changes. Open your domain.yml file and add the faq intent:
intents:
- greet
- bye
- thank
- faq
We’ll also need to add a retrieval action, which takes care of sending the response predicted from the ResponseSelector back to the user, to the list of actions. These actions always have to start with the respond_ prefix:
actions:
- respond_faq
Next we’ll write a story so that Core knows which action to predict:
## Some question from FAQ
* faq
- respond_faq
After all of the changes are done, train a new model and test the modified FAQs:
rasa train
rasa shell
At this point, you already have a working form, so let’s try it out. Make sure to uncomment the action_endpoint in your endpoints.yml to make Rasa aware of the action server that will run our form:
action_endpoint:
url: "http://localhost:5055/webhook"
Then start the action server in a new terminal window:
rasa run actions
Then you can retrain and talk to your bot:
rasa train
rasa shell
Using the features we described in this tutorial, you can easily build a context-less assistant. When you’re ready to enhance your assistant with context, check out Building a contextual assistant.