optional slot mappings #7171

wochinge · 2020-11-03T14:06:01Z

Proposed changes:

fix Allow forms without default slot mappings / only custom slots mappings #7068
forms do not have to have slot mappings any more. They can be empty instead which allows moving all slot mappings to the custom validate action.
the usage of the Rasa Open Source 2 FormAction can be overridden by defining a custom action with the name of the form. This can e.g. be used to use the deprecated FormAction from the Rasa SDK.
When a Domain defines forms as a list of strings (Rasa Open Source 1 format) then it's assumed that the user wants to use the deprecated FormAction as well. A warning is printed.

Status (please check what you already did):

added some tests for the functionality
updated the documentation
updated the changelog (please check changelog for instructions)
reformat files using black (please check Readme for instructions)

Ghostvv · 2020-11-04T09:11:07Z

what is the difference between defining forms as list of strings vs list of dicts with no values?

wochinge · 2020-11-04T09:54:36Z

what is the difference between defining forms as list of strings vs list of dicts with no values?

The list format is the old format for the forms: section which was used in Rasa Open Source.
Rasa Open Source expects the forms: section to be provided as Dict

Ghostvv · 2020-11-04T11:16:17Z

how does it look from user point of view in domain file? Should we document that?

wochinge · 2020-11-04T12:09:52Z

how does it look from user point of view in domain file? Should we document that?

What exactly do you mean? I don't think we should document an outdated format. Handling that is just a failsafe for users who haven't migrated their domain format yet. I can add another section to the documentation which describes how they can use the old SDK FormAction with a bunch of warnings 👍

Ghostvv · 2020-11-04T12:21:38Z

what I mean is. If I were to define a bunch of forms without slot mappings, I'd put them in domain file similar as actions. How would it look different if I need to define them as a list of dicts

wochinge · 2020-11-04T13:20:11Z

f I were to define a bunch of forms without slot mappings, I'd put them in domain file similar as actions. How would it look different if I need to define them as a list of dicts

I made an example of forms without slot mappings in the changelog. It's simply as you would usually define forms - just that you leave apart the slot mappings. The old format within Rasa Open Source 1 was:

forms:
- form1
- form2

Ghostvv · 2020-11-04T13:33:02Z

now I'm confused, sorry 🙈 but then it is a list of strings. But I'd like to use 2.0 forms

wochinge · 2020-11-04T13:36:15Z

That's a Rasa Open Source 2.0 forms without slot mapping

forms:
  my_form:
    # no slot mappings

@akelad updated the migration guide with instructions

Ghostvv · 2020-11-04T14:27:16Z

so

forms:
  form1:
  form2:

or do I have to add a comment?

wochinge · 2020-11-04T14:39:21Z

or do I have to add a comment?

No comment needed

Ghostvv · 2020-11-04T15:58:42Z

that is very weird format to me, but ok

federicotdn

👍 👍

federicotdn · 2020-11-04T16:51:00Z

rasa/shared/core/domain.py

+                "The `forms` section in the domain used the old Rasa Open Source 1 "
+                "list format to define forms. Rasa Open Source will be configured to "
+                "use the deprecated `FormAction` within the Rasa SDK. If you want to "
+                "use the new Rasa Open Source 2 `FormAction` adapt your `forms` "
+                "section as described in the documentation. Support for the "
+                "deprecated `FormAction` in the Rasa SDK will be removed in Rasa Open "
+                "Source 3.0.",


Suggested change

"The `forms` section in the domain used the old Rasa Open Source 1 "

"list format to define forms. Rasa Open Source will be configured to "

"use the deprecated `FormAction` within the Rasa SDK. If you want to "

"use the new Rasa Open Source 2 `FormAction` adapt your `forms` "

"section as described in the documentation. Support for the "

"deprecated `FormAction` in the Rasa SDK will be removed in Rasa Open "

"Source 3.0.",

"The `forms` section in the domain used the old Rasa Open Source 1.0 "

"list format to define forms. Rasa Open Source will be configured to "

"use the deprecated `FormAction` within the Rasa SDK. If you want to "

"use the new Rasa Open Source 2.0 `FormAction` adapt your `forms` "

"section as described in the documentation. Support for the "

"deprecated `FormAction` in the Rasa SDK will be removed in Rasa Open "

"Source 3.0.",

why do we need the .0? It was not only part of Rasa Open Source 1.0, but of all Rasa Open Source 1.x versions, right? Same for 2.0: It's part of 2.x

federicotdn · 2020-11-04T16:56:29Z

rasa/core/actions/action.py

+    is_form = name in domain.form_names
+    # Users can override the form by defining an action with the same name as the form
+    user_overrode_form_action = is_form and name in domain.user_actions
+    if is_form and not user_overrode_form_action:


if is_form and not user_overrode_form_action:

is equivalent to (X and not (X and Y)):

if is_form and not (is_form and name in domain.user_actions):

which in turn is equivalent to (X and not Y):

if is_form and name not in domain.user_actions:

So then maybe we could just write:

if name in domain.form_names and name not in domain.user_actions:

I assigned names to the single checks to make their meaning more explicit.

Developers might wonder what name not in domain.user_actions means while user_overrode_form_action conveys way more information about this. What do you think?

wochinge · 2020-11-04T17:12:18Z

@melindaloubser1 Could you please have a look at the docs?

indam23

Just some phrasing changes

docs/docs/default-actions.mdx

docs/docs/migration-guide.mdx

docs/docs/default-actions.mdx

Co-authored-by: Melinda Loubser <32034278+melindaloubser1@users.noreply.github.com>

wochinge · 2020-11-06T08:27:18Z

@Ghostvv @Ghostvv Do you want to have another look or can I merge?

Ghostvv

I don't think the format:

forms:
  form1:
  form2:

is intuitive or clear, the need or no need of - in yaml is a mess. Otherwise looks good to me

SuunnyyGoo · 2021-03-01T19:44:29Z

Hello Everybody,

First thanks for your job, Rasa is a great toolbox, it helps us a lot !

I am facing the current issue and i dont found it clear, i'm using dist 0.37.0 | 2.3.1 | 2.3.1 with gke rasa-x-helm install.

I have a form used to meet the user, at first I started with slot mapping from the domain, but looking for more accuracy, I created a validate_form class in my custom action server to improve slot extraction. One by one I finnally added all my slots mappings in my custom action but now the form is still called but not effective anymore.
I read this topic and the linked ones but i'm still confused about the use of the FormAction which is said as a way to manage depreciation, is that case one sort of depreciation ? Because i don't want te create a whole FormAction, i just want to find out my validate_form class

So I tried to implement a FormAction inherited from Rasa Core with only the name and the required slots (keeping the validate_form class nearby, this FormAction might call it ?..), but it is not registred when starting the action server and my form is achieved right after starting (without asking questions).

So I tried to implement a FormAction from Rasa_sdk (which is commented as deprecated) with overides for the name, the required slots and the submit methods. Actions my_form and validate_my_form are well reguistred ! But when my form is accessed it isn't able to use the nlu extraction and always run in fallback, stucking on 1st question or getting out the form.

My domain contains :

actions:
- my_form
- validate_my_form
forms:
  my_form: null
  other_form:
    slot:(...)

The "null" is added by Rasa X.

How do I reach validate_my_form when there are no commun mapping ? Which FormAction must i use to explicit the form's slots and access the validate_form (inside action server, i guess the core's one, but i only achieve register sdk's one).

Do i have to make my class inherit from both FormAction and FormValidationAction ?

Thank you a lot for reading, let's give a nudge to your karma by helping me ! :D

wochinge · 2021-03-05T16:09:45Z

@SuunnyyGoo Please ask usage questions in Rasa forum

travelmail26 · 2021-03-15T00:02:34Z

Hi, rasa newbie here. Is there an example of what this looks like somewhere? thanks!

indam23 · 2021-03-15T07:41:19Z

@travelmail26 Please ask usage questions in Rasa forum.
You can also look at these docs

wochinge added 6 commits November 3, 2020 14:19

fix typo

49acec2

add missing types

bd7e116

make forms overridable

cea6483

describe form overriding

d278dea

polish

432771f

drop retrieval intent parameter

2830354

wochinge force-pushed the optional-mappings branch from a649b57 to 2830354 Compare November 3, 2020 17:00

wochinge marked this pull request as ready for review November 3, 2020 17:00

wochinge requested review from a team, federicotdn and Ghostvv and removed request for a team November 3, 2020 17:00

explain how to migrate forms iteratively

bfd4a20

federicotdn approved these changes Nov 4, 2020

View reviewed changes

wochinge requested a review from indam23 November 4, 2020 17:12

indam23 suggested changes Nov 5, 2020

View reviewed changes

docs/docs/default-actions.mdx Outdated Show resolved Hide resolved

docs/docs/migration-guide.mdx Outdated Show resolved Hide resolved

docs/docs/migration-guide.mdx Outdated Show resolved Hide resolved

docs/docs/default-actions.mdx Outdated Show resolved Hide resolved

Apply suggestions from code review

7a69d60

Co-authored-by: Melinda Loubser <32034278+melindaloubser1@users.noreply.github.com>

wochinge force-pushed the optional-mappings branch from e13a5fa to 7a69d60 Compare November 5, 2020 15:58

adapt Domain.empty to new format

9f029a3

wochinge requested review from indam23 and federicotdn November 5, 2020 16:03

indam23 approved these changes Nov 5, 2020

View reviewed changes

Ghostvv approved these changes Nov 6, 2020

View reviewed changes

wochinge added the status:ready-to-merge label Nov 6, 2020

rasabot and others added 3 commits November 6, 2020 12:06

Merge branch 'master' into optional-mappings

7373ae2

initialize form with Dict by default

2cc9220

Merge branch 'master' into optional-mappings

f17978e

rasabot merged commit f2b05c4 into master Nov 6, 2020

rasabot deleted the optional-mappings branch November 6, 2020 12:41

wochinge mentioned this pull request Nov 20, 2020

utter end-to-end responses #7325

Merged

4 tasks

wochinge mentioned this pull request Jul 16, 2021

Allow forms without default slot mappings / only custom slots mappings #7068

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

optional slot mappings #7171

optional slot mappings #7171

wochinge commented Nov 3, 2020 •

edited

Loading

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

federicotdn left a comment

federicotdn Nov 4, 2020

wochinge Nov 4, 2020

federicotdn Nov 4, 2020

wochinge Nov 4, 2020

wochinge commented Nov 4, 2020

indam23 left a comment

wochinge commented Nov 6, 2020

Ghostvv left a comment

SuunnyyGoo commented Mar 1, 2021

wochinge commented Mar 5, 2021 •

edited

Loading

travelmail26 commented Mar 15, 2021

indam23 commented Mar 15, 2021

optional slot mappings #7171

optional slot mappings #7171

Conversation

wochinge commented Nov 3, 2020 • edited Loading

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

wochinge commented Nov 4, 2020

Ghostvv commented Nov 4, 2020

federicotdn left a comment

Choose a reason for hiding this comment

federicotdn Nov 4, 2020

Choose a reason for hiding this comment

wochinge Nov 4, 2020

Choose a reason for hiding this comment

federicotdn Nov 4, 2020

Choose a reason for hiding this comment

wochinge Nov 4, 2020

Choose a reason for hiding this comment

wochinge commented Nov 4, 2020

indam23 left a comment

Choose a reason for hiding this comment

wochinge commented Nov 6, 2020

Ghostvv left a comment

Choose a reason for hiding this comment

SuunnyyGoo commented Mar 1, 2021

wochinge commented Mar 5, 2021 • edited Loading

travelmail26 commented Mar 15, 2021

indam23 commented Mar 15, 2021

wochinge commented Nov 3, 2020 •

edited

Loading

wochinge commented Mar 5, 2021 •

edited

Loading