Testing Your Assistant

Validating Data and Stories#

Data validation verifies that no mistakes or major inconsistencies appear in your domain, NLU data, or story data. To validate your data, have your CI run this command:

If you pass a max_history value to one or more policies in your config.yml file, provide the smallest of those values as

If data validation results in errors, training a model can also fail or yield bad performance, so it's always good to run this check before training a model. By including the --fail-on-warnings flag, this step will fail on warnings indicating more minor issues.

To read more about the validator and all of the available options, see the documentation for rasa data validate.

Writing Test Stories#

Testing your trained model on test stories is the best way to have confidence in how your assistant will act in certain situations. Written in a modified story format, test stories allow you to provide entire conversations and test that, given certain user input, your model will behave in the expected manner. This is especially important as you start introducing more complicated stories from user conversations.

Test stories are like the stories in your training data, but include the user message as well.

Here are some examples:

By default, the command will run tests on stories from any files with names starting with test_. You can also provide a specific test stories file or directory with the --stories argument. You can test your assistant against them by running:

Conversation testing is only as thorough and accurate as the test cases you include, so you should continue to grow your set of test stories as you make improvements to your assistant. A good rule of thumb to follow is that you should aim for your test stories to be representative of the true distribution of real conversations.

See the CLI documentation on rasa test for more configuration options.

Evaluating an NLU Model#

In addition to testing stories, you can also test the natural language understanding (NLU) model separately. Once your assistant is deployed in the real world, it will be processing messages that it hasn't seen in the training data. To simulate this, you should always set aside some part of your data for testing. You can either:

1) use a held out test set by shuffling and splitting your NLU data

2) use cross-validation, which automatically creates multiple train/test splits

Using a Held-Out Test Set#

If you use the train-test set approach, it is best to shuffle and split your data using rasa data split every time you evaluate your model, as opposed to using a static NLU test set, which can easily become outdated.

You can split your NLU data into train and test sets using:

Next, you can see how well your trained NLU model predicts the data from the test set you generated, using:

Using Cross-Validation#

If you've made significant changes to your NLU training data (e.g. splitting an intent into two intents or adding a lot of training examples), you should run a full NLU evaluation using cross-validation. Cross-validation automatically creates multiple train/test splits and averages the results of evaluations on each train/test split. This means all your data is evaluated during cross-validation, making cross-validation the most thorough way to automatically test your NLU model.

To run NLU testing in cross-validation mode run:

You can specify the number of test/train splits used with the -f/--folds flag:

Note that during cross-validation, the NLU model will be trained for each fold, so cross-validation with a large data set and a high number of folds can be time-consuming. On a small data set, a high number of folds can result in too few examples per intent being available for each test split.

On the other hand, if you specify a low number of folds, your data will be split into much larger chunks, and there will be proportionally less data to train on for each fold.

Choose a number of folds that balances both considerations for your dataset size.

Comparing NLU Pipelines#

To get the most out of your training data, you should train and evaluate your model on different pipelines and different amounts of training data.

To do so, pass multiple configuration files to the rasa test command:

This performs several steps:

1. Create a global 80% train / 20% test split from data/nlu.yml.
2. Exclude a certain percentage of data from the global train split.
3. Train models for each configuration on remaining training data.
4. Evaluate each model on the global test split.

The above process is repeated with different percentages of training data in step 2 to give you an idea of how each pipeline will behave if you increase the amount of training data. Since training is not completely deterministic, the whole process is repeated three times for each configuration specified.

A graph with the mean and standard deviations of f1-scores across all runs is plotted. The f1-score graph, along with all train/test sets, the trained models, classification and error reports, will be saved into a folder called nlu_comparison_results.

Inspecting the f1-score graph can help you understand if you have enough data for your NLU model. If the graph shows that f1-score is still improving when all of the training data is used, it may improve further with more data. But if f1-score has plateaued when all training data is used, adding more data may not help.

If you want to change the number of runs or exclusion percentages, you can:

Interpreting the Output#

Intent Classifiers#

The rasa test script will produce a report (intent_report.json), confusion matrix (intent_confusion_matrix.png) and confidence histogram (intent_histogram.png) for your intent classification model.

The report logs precision, recall and f1-score for each intent, as well as providing an overall average. You can save these reports as JSON files using the --report argument.

The confusion matrix shows which intents are mistaken for others. Any samples which have been incorrectly predicted are logged and saved to a file called errors.json for easier debugging.

The histogram allows you to visualize the confidence for all predictions, with the correct and incorrect predictions being displayed by blue and red bars respectively. Improving the quality of your training data will move the blue histogram bars up the plot and the red histogram bars down the plot. It should also help in reducing the number of red histogram bars itself.

Response Selectors#

rasa test evaluates response selectors in the same way that it evaluates intent classifiers, producing a report (response_selection_report.json), confusion matrix (response_selection_confusion_matrix.png), confidence histogram (response_selection_histogram.png) and errors (response_selection_errors.json). If your pipeline includes multiple response selectors, they are evaluated in a single report.

The report logs precision, recall and f1 measure for each sub-intent of a retrieval intent and provides an overall average. You can save these reports as JSON files using the --report argument.

Entity Extraction#

rasa test reports recall, precision, and f1-score for each entity type that your trainable entity extractors are trained to recognize.

Only trainable entity extractors, such as the DIETClassifier and CRFEntityExtractor are evaluated by rasa test. Pretrained extractors like the DucklingHTTPExtractor are not evaluated.

If you have multiple entity extractors in your pipeline, or use some custom extractors, multiple entities might be associated with the same token. In this case, you can use a list notation in the test files, such as

Entity Scoring#

To evaluate entity extraction we apply a simple tag-based approach. We don't consider BILOU tags exactly, but only the entity type tags on a per token basis. For location entity like “near Alexanderplatz” we expect the labels LOC LOC instead of the BILOU-based B-LOC L-LOC.

Our approach is more lenient when it comes to evaluation, as it rewards partial extraction and does not penalize the splitting of entities. For example, given the aforementioned entity “near Alexanderplatz” and a system that extracts “Alexanderplatz”, our approach rewards the extraction of “Alexanderplatz” and penalizes the missed out word “near”.

The BILOU-based approach, however, would label this as a complete failure since it expects Alexanderplatz to be labeled as a last token in an entity (L-LOC) instead of a single token entity (U-LOC). Note also that a split extraction of “near” and “Alexanderplatz” would get full scores on our approach and zero on the BILOU-based one.

Here's a comparison between the two scoring mechanisms for the phrase “near Alexanderplatz tonight”:

Evaluating a Dialogue Model#

You can evaluate your trained dialogue model on a set of test stories by using the test script:

This will print any failed stories to results/failed_test_stories.yml. A story fails if at least one of the actions was predicted incorrectly.

The test script will also save a confusion matrix to a file called results/story_confmat.pdf. For each action in your domain, the confusion matrix shows how often the action was correctly predicted and how often an incorrect action was predicted instead.

Interpreting the generated warnings#

The test script will also generate a warnings file called results/stories_with_warnings.yml. This file contains all test stories for which action_unlikely_intent was predicted at any conversation turn but all actions from the original story were predicted correctly. However, if a test story originally included an action_unlikely_intent, for example to ensure a rule is designed to trigger the conversation path after an action_unlikely_intent but the ensemble of policies failed to do so, then the corresponding story will end up in results/failed_test_stories.yml as a failed story.

The stories are sorted by the severity of action_unlikely_intent's prediction. This severity is calculated by UnexpecTEDIntentPolicy itself at prediction time. The higher the severity, the more unlikely is the intent and hence reviewing that particular conversation path becomes more critical.

Note, that action_unlikely_intent is predicted by UnexpecTEDIntentPolicy which employs a machine learning based model under the hood and hence can result in false warnings as well. You can choose to ignore such warnings if the conversation paths in these stories are already present in the training stories.

Comparing Policy Configurations#

To choose a configuration for your dialogue model, or to choose hyperparameters for a specific policy, you want to measure how well your dialogue model will generalize to conversations it hasn't seen before. Especially in the beginning of a project, when you don't have a lot of real conversations to train your bot on, you may not want to exclude some to use as a test set.

Rasa has some scripts to help you choose and fine-tune your policy configuration. Once you are happy with it, you can then train your final configuration on your full data set.

To do this, you first have to train models for your different configurations. Create two (or more) config files including the policies you want to compare, and then provide them to the train script to train your models:

Similar to how the NLU model was evaluated, the above command trains the dialogue model on multiple configurations and different amounts of training data. For each config file provided, Rasa will train dialogue models with 0, 5, 25, 50, 70 and 95% of your training stories excluded from the training data. This is repeated three times to ensure consistent results.

Once this script has finished, you can pass multiple models to the test script to compare the models you just trained:

This will evaluate each model on the stories in stories_folder (can be either training or test set) and plot some graphs to show you which policy performs best. Since the previous train command excluded some amount of training data to train each model, the above test command can measure how well your model predicts the held-out stories. To compare single policies, create config files containing only one policy each.

Testing Action Code#

The approach used to test your action code will depend on how it is implemented. For example, if you connect to external APIs, you should write integration tests to ensure that those APIs respond as expected to common inputs. However you test your action code, you should include these tests in your CI pipeline so that they run each time you make changes.

If you have any questions or problems, please share them with us in the dedicated testing section on our forum!

End-To-End Testing#

End-to-end testing is an enhanced and comprehensive CLI-based testing tool that allows you to test conversation scenarios with different pre-configured contexts, execute custom actions, verify response texts or names, and assert when slots are filled.

End-to-end testing is not limited to testing only the NLU or the dialogue model and allows you to design effective acceptance or integration tests. The main features of end-to-end testing are:

• integration with the action server: you can execute custom actions in your tests; the prerequisite is to start the action server in the background.
• test parametrization (e.g. different user profiles or other external factors): you can define multiple test fixtures with different pre-filled slots and re-use them in your tests.
• verifying response texts or names: you can assert that the bot response text (including interpolated responses with slot values and conditional response variations) or utter name is as expected.
• asserting that the bot sets the slot value as expected.

How to write test cases#

To write test cases, you need to create a YAML file inside the tests directory of your project. The name of the file should be e2e_test_cases.yml. You can also create a subdirectory inside the tests directory and place your test case YAML files there. These files will be automatically discovered and run by Rasa Pro, however you need to provide the path to the subdirectory as positional argument to the rasa test e2e command.

Each input file must contain the test_cases required key. The value of this key is a list of test cases. Each test case must include a name given to the test_case key and a list of test steps given to the steps key. A step can be either one of the following:

• user: a user message
• bot: a bot response
• utter: a domain utterance
• slot_was_set: a slot name and the value it was set to

You can also add the optional fixtures top level key if pre-filled slots are required for setting any individual test case context. The fixtures key is a list of fixture names (which must be unique) and each fixture name maps to a list of slot key-value pairs. If one of the test cases requires a pre-filled slot, you can add the fixture name to the test case definition, by adding the fixture name to the optional fixtures key in the test case. The slot key-value pairs will be set before the test case is run.

The following example shows a test case file with fixtures and two test cases that make use of all available steps:

How to run the tests#

To run the end-to-end tests locally or in the CI pipeline, use the rasa test e2e command. The command takes the following arguments:

• positional argument for the path to the test cases file or directory containing the test cases: rasa test e2e <path> If unspecified, the default path is tests/e2e_test_cases.yml.
• optional argument for the trained model: --model <path>
• optional argument for retrieving the trained model from remote storage: --remote-storage <remote-storage-location>
• optional argument for the endpoints.yml file: --endpoints <path>
• optional argument for stopping the test run at first failure: rasa test e2e --fail-fast
• optional argument for exporting the test results to e2e_results.yml file: rasa test e2e -o

Testing custom actions#

If the test cases include custom actions, start the action server first:

How to interpret the output#

By default, the results are always printed to stdout and the command will exit with exit code 0 (if all tests passed) or 1 (in case of test failures).

The output style is inspired by pytest:

• Failed test cases will be stacked, each highlighting the difference in identified mismatches in similar style to git diff: expected messages will be preceded by + prefix, while actual messages will be preceded by - prefix.
• The short test summary includes a list of every failed test case name and file location in a new line.

If -o flag is specified in the command, the results are also written to the tests/e2e_results.yml file, which will contain a list of test results with the following keys:

• name: the name of the test case
• pass_status: the status of the test case, either True or False
• expected_steps: the expected test steps
• difference: a list of differences between the expected and actual test steps