Stories

These docs are for version 1.x of Rasa Open Source.

User Guide

NLU

Core

Conversation Design

API Reference

Migrate from (beta)

Reference

Glossary

Versions

viewing: 1.10.23

Stories

Rasa stories are a form of training data used to train the Rasa’s dialogue management models.

A story is a representation of a conversation between a user and an AI assistant, converted into a specific format where user inputs are expressed as corresponding intents (and entities where necessary) while the responses of an assistant are expressed as corresponding action names.

A training example for the Rasa Core dialogue system is called a story. This is a guide to the story data format.

Format

Here’s an example of a dialogue in the Rasa story format:

## greet + location/price + cuisine + num people    <!-- name of the story - just for debugging -->
* greet
   - action_ask_howcanhelp
* inform{"location": "rome", "price": "cheap"}  <!-- user utterance, in format intent{entities} -->
   - action_on_it
   - action_ask_cuisine
* inform{"cuisine": "spanish"}
   - action_ask_numpeople        <!-- action that the bot should execute -->
* inform{"people": "six"}
   - action_ack_dosearch

What makes up a story?

A story starts with a name preceded by two hashes ## story_03248462.
The end of a story is denoted by a newline, and then a new story starts again with ##.
Messages sent by the user are shown as lines starting with * in the format intent{"entity1": "value", "entity2": "value"}.
Actions executed by the bot are shown as lines starting with - and contain the name of the action.
Events returned by an action are on lines immediately after that action.

User Messages

While writing stories, you do not have to deal with the specific contents of the messages that the users send. Instead, you can take advantage of the output from the NLU pipeline, which lets you use just the combination of an intent and entities to refer to all the possible messages the users can send to mean the same thing.

Actions

All actions (both utterance actions and custom actions) executed by the bot are shown as lines starting with - followed by the name of the action.

Events

Events such as setting a slot or activating/deactivating a form have to be explicitly written out as part of the stories.

Slot Events

Slot events are written as - slot{"slot_name": "value"}.

End-to-End Story Evaluation Format

The end-to-end story format is a format that combines both NLU and Core training data into a single file for evaluation.