Domain Format¶

The Domain defines the universe in which your bot operates. It specifies the intents, entities, slots, and actions your bot should know about. Optionally, it can also include templates for the things your bot can say.

As an example, the DefaultDomain has the following yaml definition:

# all hashtags are comments :)
intents:
 - greet
 - default
 - goodbye
 - affirm
 - thank_you
 - change_bank_details
 - simple
 - hello
 - why
 - next_intent

entities:
 - name

slots:
  name:
    type: text

templates:
  utter_greet:
    - "hey there {name}!"  # {name} will be filled by slot (same name) or by custom action code
  utter_goodbye:
    - "goodbye 😢"
    - "bye bye 😢"   # multiple templates - bot will randomly pick one of them
  utter_default:
    - "default message"

actions:
  - utter_default
  - utter_greet
  - utter_goodbye

What does this mean?

Your NLU model will define the intents and entities that you need to include in the domain.

slots are the things you want to keep track of during a conversation, see Using Slots . A categorical slot called risk_level would be defined like this:

slots:
   risk_level:
      type: categorical
      values:
      - low
      - medium
      - high

Here is the full list of slot types defined by Rasa Core, along with syntax for including them in your domain file.

actions are the things your bot can actually do. For example, an action can:

respond to a user
make an external API call
query a database

see Actions

For a more complete example domain, check the Quickstart.

Custom Actions and Slots¶

To reference slots in your domain, you need to reference them by their module path. To reference custom actions, use their name. For example, if you have a module called my_actions containing a class MyAwesomeAction, and module my_slots containing MyAwesomeSlot, you would add these lines to the domain file:

actions:
  - my_custom_action
  ...

slots:
  - my_slots.MyAwesomeSlot

The name function of MyAwesomeAction needs to return my_custom_action in this example (for more details, see Actions).

Utterance templates¶

Utterance templates are messages the bot will send back to the user. There are two ways to use these templates:

if the name of the template starts with utter_, the utterance can directly be used like an action. You would add the utterance template to the domain
```
templates:
  utter_greet:
  - text: "Hey! How are you?"
```
Afterwards, you can use the template as if it were an action in the stories:
```
## greet the user
* intent_greet
  - utter_greet
```
When utter_greet is run as an action, it will send the message from the template back to the user.
You can use the templates to generate response messages from your custom actions using the dispatcher: dispatcher.utter_template("utter_greet"). This allows you to separate the logic of generating the messages from the actual copy. In you custom action code, you can send a message based on the template like this:
```
from rasa_core_sdk.actions import Action

class ActionGreet(Action):
  def name(self):
      return 'action_greet'

  def run(self, dispatcher, tracker, domain):
      dispatcher.utter_template("utter_greet")
      return []
```

Images and Buttons¶

Templates defined in a domains yaml file can contain images and buttons as well:

templates:
  utter_greet:
  - text: "Hey! How are you?"
    buttons:
    - title: "great"
      payload: "great"
    - title: "super sad"
      payload: "super sad"
  utter_cheer_up:
  - text: "Here is something to cheer you up:"
    image: "https://cdn77.eatliver.com/wp-content/uploads/2017/10/trump-frog.jpg"

Note

Please keep in mind that it is up to the implementation of the output channel on how to display the defined buttons. E.g. the cmdline interface can not display buttons or images, but tries to mimic them in the command line.

Variables¶

You can also use variables in your templates to insert information collected during the dialogue. You can either do that in your custom python code or by using the automatic slot filling mechanism. E.g if you got a template like this:

templates:
  utter_greet:
  - text: "Hey, {name}. How are you?"

Rasa will automatically fill that variable with a value found in a slot called name.

In custom code, you can retrieve a template by using:

class ActionCustom(Action):
   def name(self):
      return "action_custom"

   def run(self, dispatcher, tracker, domain):
      # send utter default template to user
      dispatcher.utter_template("utter_default", tracker)
      # ... other code
      return []

If the template contains variables denoted with {my_variable} you can supply values for the fields by passing them as key word arguments to utter_template:

dispatcher.utter_template("utter_default", tracker, my_variable="my text")

Variations¶

If you want to randomly vary the response sent to the user, you can list multiple responses and Rasa will randomly pick one of them, e.g.:

templates:
  utter_greeting:
  - text: "Hey, {name}. How are you?"
  - text: "Hey, {name}. How is your day going?"

Ignoring entities for certain intents¶

If you want entities to be ignored for certain intents, you can add the use_entities: false parameter to the intent in your domain file like this:

intents:
  - greet: {use_entities: false}

This means that entities for those intents will be unfeaturized and therefore will not impact the next action predictions. This is useful when you have an intent where you don’t care about the entities being picked up. If you list your intents as normal without this parameter, the entities will be featurized as normal.

Note

If you really want these entities not to influence action prediction we suggest you make the slots with the same name of type unfeaturized

Have questions or feedback?¶

We have a very active support community on Rasa Community Forum that is happy to help you with your questions. If you have any feedback for us or a specific suggestion for improving the docs, feel free to share it by creating an issue on Rasa Core GitHub repository.