use_entities is broken when domain is split

[hsm207]

Rasa Open Source version

2.8.12

Rasa SDK version

2.8.2

Rasa X version

No response

Python version

3.8

What operating system are you using?

Linux

What happened?

Create a domain.yml with the following content:

intents:
  - greet:
      use_entities: [country]
  - goodbye:
      use_entities: []
  - affirm
  - deny
  - mood_great
  - mood_unhappy
  - bot_challenge
 
entities:
  - city
  - country

Create another domain yaml with the following content:

intents:
  - inform:
      use_entities: [city]

Reading the merged domain files using Domain.load shows that the intent inform is still using the entities city and country.

The workaround is to repeat the list of entities in the first domain file in the second domain file i.e.:

intents:
  - inform:
      use_entities: [city]

entities:
  - city
  - country

Here is the code to reproduce this behavior.

Command / Request

No response

Relevant log output

No response

Definition of done

• Fix bug in 2.8 and 3.0
• Create integration test to ensure this works as expected
• Fixed merged into 2.8 and 3.0

[TyDunn]

The fix for this issue will need to be backported to the last minor of the previous major (i.e. Rasa Open Source 2.8)

[raoulvm]

I made a showcase on a possible solution here: raoulvm@17b4d81 in branch https://github.com/raoulvm/rasa/tree/2.8.14-fix-domain_from_directory
based on Rasa 2.8.14. It is no complete PR but a showcase which works with our (Deutsche Telekom) model.

[TyDunn]

@raoulvm Awesome. Thank you so much! This will help us make progress quickly on this issue

[raoulvm]

Happy to help. We are waiting for the fix ...

[carlad]

@raoulvm am working on this right now. I've identified the root cause but need to ensure my fix doesn't break other things ;) I'll message you if I need some help.

[carlad]

@TyDunn I've raised a PR for 2.8.x and added a unit test. I don't think we need an integration test as the bug was isolated to a quirk in one of the shared.core.domain class methods only...

[raoulvm]

I have a bad feeling.
@carlad could you please test with the following two configs:

intents:
  - play:
      use_entities:
        - ball
        - chess
 - stow_away:
     use_entities: true
entities:
  - ball
  - chess

intents:
  - support_banning:
      use_entities:
         - automatic_rifles
         - anti_person_land_mines
  - certify:
      use_entities: true
entities:
  - automatic_rifles
  - anti_person_land_mines
  - tanks

and post the results here?
Thanks

[raoulvm]

Spoiler, that is expected, when using domain.as_yaml(clean_before_dump=True):

version: '2.0'
session_config:
  session_expiration_time: 60
  carry_over_slots_to_new_session: true
intents:
- support_banning:
    use_entities:
    - automatic_rifles
    - anti_person_land_mines
- certify
- play:
    use_entities:
    - ball
    - chess
- stow_away
entities:
- anti_person_land_mines
- automatic_rifles
- ball
- chess
- tanks

[carlad]

This is what I get when I use your rasa_moodbot repo with this PR's fix:

❯ make check-bug
python main.py --domain_folder ./domain/bug
intent: certify
entities used:
  anti_person_land_mines
  automatic_rifles
  ball
  chess
  tanks


intent: play
entities used:
  anti_person_land_mines
  automatic_rifles
  ball
  chess
  tanks


intent: stow_away
entities used:
  anti_person_land_mines
  automatic_rifles
  ball
  chess
  tanks


intent: support_banning
entities used:
  anti_person_land_mines
  automatic_rifles
  ball
  chess

So yeah. There's some additional logic needed. Let me look at your fix.

[raoulvm]

Aside from the moral question if playing with anti_person_land_mines is ok, did you expect that?

[carlad]

Are you able to raise a PR from your branch against 2.8.x

[raoulvm]

You could just copy the code changes. I provided that as an example.

[raoulvm]

There are open topics though: If the domains are not loaded from a directory, but individually listed in CLI, the fix does not apply. The change probably would be similar, but I neither had time nor interest to tackle that.

[carlad]

You linked to the entire branch. Which files did you change?

[raoulvm]

Let me have quick look at the commits.

[raoulvm]

raoulvm@17b4d81
That commit contains the changes.

[carlad]

@raoulvm thanks! Let me add your changes to the PR...

[carlad]

@raoulvm this fix has now been released in 2.8.19: https://pypi.org/project/rasa/2.8.19/