I have a RASA form which takes multiple from_text inputs and I need to set a condition to deactivate the form based on a user input. How do I do this in the actions file?

Hi @ChrisRahme , To deactivate a form, you can simply return this from a validate_{slot} method: return { "requested_slot": None} That will deactivate the Form. The dictionary of slots returned from a validate_<slot_name> will be converted into SlotSet events by the caller before it is sent back to Rasa. Note that it is not needed to also return an ActiveLoop(None) event. Just setting the requested_slot to None is sufficient. If you do nothing else, the bot will just go and listen, which might confuse the user. We implemented something similar in the financial-demo starter pack, but went a little further, to support this logic: Keep track of the number of repeated validation failures, using a special slot After a certain number of failures: explain the slot to the user reset the counter ask if they want to continue with the form If the user answers yes, keep going If the user answers no, deactivate the form When the form is deactivated, a rule calls a custom action that confirms that the form was stopped This way, the bot is always trying to help the user, and provides a nice option to exit a form. This logic was abstracted away in a CustomFormValidationAction . If you want to use this logic in your bot, you can do so with minimal effort by: copy the custom_forms.py & customForms_config.yml Follow the instructions given in the CustomFormValidationAction docstring. use CustomFormValidationAction as the base class for your own validation class, like here :class ValidatePayCCForm(CustomFormValidationAction): add optional explain_{slot} methods, like here :async def explain_credit_card(...)

You can do this in the slot validation action by returning an ActionExecuted event with the action action_deactivate_form. Read more about this here

Actually, I’m realising now that you can’t do this with the standard form validation action as it expects a dictionary of slots and their values, not a list of events like some of the other actions. Sorry about the confusion. I think the better way to do this is handle this with a story: stories: - story: User interrupts the form and doesn't want to continue steps: - intent: request_restaurant - action: restaurant_form - active_loop: restaurant_form - intent: stop - action: utter_ask_continue - intent: stop - action: action_deactivate_loop - active_loop: null

My slot handles a from_text input, so using stories didn’t seem to work for me

What if you got around this with another slot? It could be a boolean, for example: slots: quit_form: type: bool influence_conversation: true Then in your validation action, you could do something like this for your from_text slot. def validate_other_slot( self, value: Text, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[Text, Any], ) -> Dict[Text, Any]: """Validate num_people value.""" if "quit" in other_slot: return {"quit_form": True} else: # do other validation here return {"other_slot": value} Add a story: stories: - story: User interrupts the form and doesn't want to continue steps: - intent: request_restaurant - action: restaurant_form - active_loop: restaurant_form - intent: inform - slot_was_set: - quit: True - action: utter_ask_continue - intent: deny - action: action_deactivate_loop - active_loop: null

Note I haven’t run this code, so there may be typos or syntax errors. It should just give you a general idea.

For some reason I keep getting the TimeOut error when I implement that? I read somewhere that returning ActiveLoop to None might work

That would look something like this: class ValidateForm(FormValidationAction): """Example of a form validation action.""" def name(self) -> Text: return "validate_your_form" async def run( self, dispatcher: "CollectingDispatcher", tracker: "Tracker", domain: "DomainDict", ) -> List[EventType]: if "quit" in tracker.latest_message.get("text"): return [ActiveLoop(None), SlotSet(REQUESTED_SLOT, None)] await super().run(dispatcher, tracker, domain)

Yes, this option seemed to work for me, but for some reason running that code doesn’t help me validate my other slots. for example when I set a slot to {‘Course’: None}, the bot skips validation and asks for the next slot

Well yes, this was assuming you want to quit the form and skip validating the other slots. It returns ActiveLoop(None), SlotSet(REQUESTED_SLOT, None) before validation happens. You can also return this after validation. I’m not sure what you mean by this: when I set a slot to {‘Course’: None} Are you setting the slot in a validation method? Or in run?

How do I deactivate a form during validation?

Rasa Open Source

natsucr7 (Natsucr7) February 14, 2021, 3:43pm 3

Hi, could you show me an example of the implementation?

Topic		Replies	Views
Rasa 2.0 - How to deactivate a form during validation? Rasa Open Source	28	3891	January 5, 2022
Form deactivation inside validate function Rasa Open Source	15	4359	January 8, 2021
Cannot deactivate a form Rasa Open Source	7	1856	January 17, 2020
Deactivate form in the FormValidation method (validate_slot_name)) Rasa Open Source	2	278	January 11, 2023
Deactivate the form in middle of Form Validation when an intent is triggered Rasa Open Source	0	326	April 13, 2023

How do I deactivate a form during validation?

Related topics