# Training Data Format

## Data Formats
You can provide training data as Markdown or as JSON, as a single file or as a directory containing multiple files.
Note that Markdown is usually easier to work with.

### Markdown Format
Markdown is the easiest Rasa NLU format for humans to read and write.
Examples are listed using the unordered list syntax, e.g. minus `-`, asterisk `*`, or plus `+`.

Examples are grouped by intent, and entities are annotated as Markdown links,
e.g. `"[<entity text>](<entity name>)",` or by using the following syntax `"[<entity-text>] {"entity": "<entity name>"}"`.
Using the latter syntax, you can also assign synonyms, roles, or groups to an entity, e.g.
`"[<entity-text>] {"entity": "<entity name>", "role": "<role name>", "group": "<group name>", "value": "<entity synonym>"}"`.
The keywords `role`, `group`, and `value` are optional in this notation.
To understand what the labels `role` and `group` are for, see section [Entities Roles and Groups](https://legacy-docs-v1.rasa.com/1.10.19/nlu/entity-extraction/#entities-roles-groups).

```
## intent:check_balance
- what is my balance <!-- no entity -->
- how much do I have on my [savings](source_account) <!-- entity "source_account" has value "savings" -->
- how much do I have on my [savings account]{"entity": "source_account", "value": "savings"} <!-- synonyms, method 1-->
- Could I pay in [yen](currency)?  <!-- entity matched by lookup table -->

## intent:greet
- hey
- hello

## synonym:savings   <!-- synonyms, method 2 -->
- pink pig

## regex:zipcode
- [0-9]{5}

## lookup:additional_currencies  <!-- specify lookup tables in an external file -->
path/to/currencies.txt
```

The training data for Rasa NLU is structured into different parts:

- common examples
- synonyms
- regex features and
- lookup tables

While common examples is the only part that is mandatory, including the others will help the NLU model
learn the domain with fewer examples and also help it be more confident of its predictions.

Synonyms will map extracted entities to the same name, for example mapping “my savings account” to simply “savings”.
However, this only happens _after_ the entities have been extracted, so you need to provide examples with the synonyms
present so that Rasa can learn to pick them up.

Lookup tables may be specified as plain text files containing newline-separated words or
phrases. Upon loading the training data, these files are used to generate
case-insensitive regex patterns that are added to the regex features.

## JSON Format
The JSON format consists of a top-level object called `rasa_nlu_data`, with the keys
`common_examples`, `entity_synonyms` and `regex_features`.
The most important one is `common_examples`.

```
{
    "rasa_nlu_data": {
        "common_examples": [],
        "regex_features" : [],
        "lookup_tables"  : [],
        "entity_synonyms": []
    }
}
```

The `common_examples` are used to train your model. You should put all of your training
examples in the `common_examples` array.
Regex features are a tool to help the classifier detect entities or intents and improve the performance.

## Improving Intent Classification and Entity Recognition
### Common Examples
Common examples have three components: `text`, `intent` and `entities`. The first two are strings while the last
one is an array.

> - The _text_ is the user message \[required\]
>
> - The _intent_ is the intent that should be associated with the text \[optional\]
>
> - The _entities_ are specific parts of the text which need to be identified \[optional\]

Entities are specified with a `start` and an `end` value, which together make a range
to apply to the string, e.g. in the example below, with `text="show me chinese restaurants"`, then
`text[8:15] == 'chinese'`.
Entities can span multiple words, and in
fact the `value` field does not have to correspond exactly to the substring in your example.
That way you can map synonyms, or misspellings, to the same `value`.

```
## intent:restaurant_search
- show me [chinese](cuisine) restaurants
```

### Regular Expression Features
Regular expressions can be used to support the intent classification and entity extraction. For example, if your entity
has a deterministic structure (like a zipcode or an email address), you can use a regular expression to ease detection
of that entity. For the zipcode example it might look like this:

```
## regex:zipcode
- [0-9]{5}
```

The name doesn’t define the entity nor the intent, it is just a human readable description for you to remember what
this regex is used for and is the title of the corresponding pattern feature. As you can see in the above example, you
can also use the regex features to improve the intent classification performance.

### Lookup Tables
Lookup tables provide a convenient way to supply a list of entity examples.
The supplied lookup table files must be in a newline-delimited format.
For example, `data/test/lookup_tables/plates.txt` may contain:

```
tacos
beef
mapo tofu
burrito
lettuce wrap
```

And can be loaded and used as shown here:

```
## lookup:plates
data/test/lookup_tables/plates.txt

## intent:food_request
- I'd like beef [tacos](plates) and a [burrito](plates)
- How about some [mapo tofu](plates)
```

When lookup tables are supplied in training data, the contents are combined
into a large, case-insensitive regex pattern that looks for exact matches in
the training examples.