Node groups are primarily used for defining a group of nodes and representing them on the dialog canvas. Note that it is not a part of the dialog flow.
Node groups can be used to improve the user experience with follow-ups, digressions, and amending entity values. For a use case example, refer here.
Add a Node Group
To add a node group to the dialog task, follow the below steps:
- Open the Dialog Task where you want to add the Group node.
- Group the nodes. For steps in grouping nodes, refer here.
- Once created, you cannot add or remove specific nodes from the group.
- Any node you add is added outside the group.
- Any node you delete is deleted from the entire dialog.
- Deleting a group will not delete the nodes within the group from the dialog.
- If you want to change the nodes contained within a group, you need to delete the respective group, then to recreate it.
Configure a Node Group
The Group Node functionality includes the following:
- Scoping of Intents – ability to define the sub-intents to be made available when the user is waiting at any of the nodes in the group;
- Sub-intent Training – the ability to train the sub-intent;
- Sub-intent Properties – ability to define the behavior of the sub-intent.
Using Node Groups you can scope the sub-intents that are to be allowed to be identified from the user utterance and executed while the user is at one of the nodes within the group.
- Hover over the group you want to scope the intents for and click the settings (gear) icon.
- From the Node Group window, select Add Intent to add intents that should be part of this group’s scope.
- From the Add Intent window, select the intent to be scoped as a sub-intent for this Node Group. This would be the intent that a user might ask for when the conversation is at any of the nodes in this group. For example, asking “How is the weather at XYZ city” when prompted for the destination entity or asking for “Flight times” when prompted for the travel date.
- You can choose to add new sub-intents using the Create Intent button.
- Once added you can train, set behavioral properties and/or delete a scoped intent.
- From the Group settings page, select the sub-intent you want to train.
- You can train the sub-intent with the following:
- Machine Learning – Add the user utterances that should identify this sub-intent. You can also use the NER approach to annotate entities in the utterances.
- Patterns – Identify patterns in the user utterance related to this sub-intent.
- Rules – Define intent identification rules to trigger this intent.
- You can also set the Intent Preconditions i.e. the sub-intent would get identified only when any of the preconditions defined is available in the context at the time of intent detection. These pre-conditions will be considered as instance levels and would take precedence over the component level pre-conditions.
Once added, each of the sub-intent can be trained for recognition within this group. This would ensure that the sub-intent is identified in the group’s context.
The fulfillment section can be used to define the actions when this particular sub-intent is identified from the user input. It includes the following properties:
- Context Variables – Set the key-value pairs to define the session or context variables to be updated when this sub-intent is identified. If you want to reset the values, you need to use the keyword “null”, spaces would be ignored by the platform.
- Context Output – Define the context tags to be set when this intent is identified. The intent name is always set as output context by the system. If you want to reset the values, you need to use the keyword “null”, spaces would be ignored by the platform.
- Transition Flow – Use this option to define how the dialog should resume after executing this sub-intent. There are two behaviors you can define:
- Jump To A Node – The dialog will resume from the node selected here.
- Resume The Dialog – The dialog will resume from the node where this intent was identified.
Following are the changes in sub-intent behavior within a group:
- For every sub-intent identified, the context object will be updated with an array of objects with the identified sub-intent details with the latest at the top. The following information is captured:
- Name of the sub-intent;
- Entities that are identified along with the sub-intent;
- Name of the group to which the sub-intent belongs, where applicable;
- Name of the node at which the sub-intent is identified.
- The intent would be executed if the sub-intent identified from the user utterance is within the group scope and all the input preconditions are satisfied and the transition flow directs to the concerned node.
- The execution of sub-intents would involve:
- Updated context variables as per the defined mapping,
- Setting the Output Context as per the defined mapping,
- Presenting the message to the user, if applicable.
- The current dialog execution should continue as per the transition flow defined.
- Jump to the specified node; or
- Resume from the point where the sub-intent was identified.
"intent": "Change Destination",
"groupName": "Entity Group",
"intent": "Weather Report",
"groupName": "Entity Group",