Teneo Developers

User Intent

Introduction

The User Intent is the place where the developer is able to define which user intents should be covered by the scope of the trigger or transition; this is done by adding examples of User Intent which covers intents that an end-user of the Conversational AI application would typically say in order to obtain information related to the scope.
In the below sections please find step-by-step guides on how to work with and define properties of User Intents.

Add new User Intent

Below please find step-by-step guides on how to add User Intent to a Flow.

Trigger

To add a new User Intent trigger at the beginning of the Flow, follow the below steps:

  • In the Flow window, click the Plus icon available in the top of the Flow (next to any existing trigger) and select Add Trigger, alternatively use the Add Trigger button available in the top ribbon

Plus icon

  • Next, select the new trigger in the Flow editor to open the right-side Trigger panel
    Should the panel not open when selecting the trigger, click Trigger in the right-side of the window to open the panel
  • In the Trigger section of the right-side panel, optionally, Add name and/or Add description of the trigger
  • In the User Intent section of the right-side panel:
    • Add positive/negative examples of User Intent by writing in the text field (Enter an Example), next either click the green + (plus) button or press Enter
    • Edit a positive/negative Intent by either:
      • Double-clicking the Intent to edit, or
      • Selecting the Intent and clicking the pencil button
      • When done editing, press Enter
    • Delete a positive/negative Intent by selecting the Intent and clicking the red cross in the top of the Intents list
    • Filter Intents by using the text filter (Filter Examples) available below the list of positive/negative Intents
    • Include in Auto-tests allows to exclude/include the Intents of the User Intent when running Flow and Solution Auto-tests

Positive Intents are meant to cover the end-user's intents/inputs which should be covered by the Flow scope, while the Negative Intents are meant to include intents which should not be covered by this Flow nor should they trigger it.

  • Add the desired Match(es)
  • Add any needed After Matches
  • In the Triggering section:
    • Select an Order group
    • Open the Trigger Ordering window by using the Ordering icon
    • Under Advanced Options, specify:
      • Trigger only once per session
        Indicates if the trigger should be executed just once per session or may be repeated
      • Test sentences from either Last to first (default) or First to last
        By default, sentences in the end-user's input are tested "last to first", but this setting allows to set the testing from "first to last" and to test sentences in the same order as they appear in the end-user's input
  • Under Metadata add any needed Metadata definitions
  • Remember to Save the Flow to preserve the changes.

Transition

To add User Intent to a transition in Teneo Studio Desktop, follow the below steps:

  • Select the transition in the Flow editor, the right-side Transition panel will open Should the panel not open when selecting the transition, click Transition in the right-side of the window to open the panel
  • Now, under User Intent, click Add
  • Add positive/negative examples of User Intent by writing in the text field (Enter an Example), when finished writing an Intent either click the green + icon or press Enter
  • Edit a positive/negative Intent by either:
    • Double-clicking the Intent to edit, or
    • Selecting the Intent and clicking the pencil button
    • When done editing, press Enter
  • Delete a positive/negative Intent by selecting it and clicking the red cross in the top of the User Intents list
  • Filter Intents by using the text filter (Filter Examples) available below the list of positive/negative Intents
  • Include in Auto-tests allows to exclude/include the examples of the User Intent when running Flow and Solution Auto-tests

For more information about settings and options on transitions, please see here.

Add User Intent before the Raise label

To add a new User Intent to beginning of the Flow, follow the below steps:

  • In the Flow editor, click the Plus icon available before the raise label
  • Next, click Trigger based on end user Intent in the input
  • In the new User Intent trigger:
    • Next to "Intent", optionally, click to add a name to the User Intent
    • Click Edit to start adding positive Intents
    • Click Add to add more positive Intents to the list
    • Hover over an Intent to delete it, by clicking the recycle bin at the end of the line
    • Click Close when finished
  • Remember to Save the Flow to preserve the changes

Examples of User Intent are meant to cover the end-user's intent/inputs which should be covered by the Flow scope.

Add User Intent after the Raise label

To add a new User Intent in another location of the Flow editor, the user should - depending on the expected behavior - click the Plus icon in the wanted spot and select either:

  • Continue with > a transaction element to interact with the end user > expect an end user Intent, or
  • Split path > to a transaction element to interact with the end user > expect an end user Intent.

In the new User Intent node, follow the steps described below to edit the properties.

Edit User Intent trigger

To edit an User Intent trigger, see below editing options:

  • First, select the trigger in the Flow editor to open the right-side panel
    Should the panel not open when selecting the trigger, click Trigger in the right-side of the window to open the panel
  • In the Trigger section of the right-side panel, optionally, Add name and/or Add description of the trigger
  • In the User Intent section of the right-side panel:
    • Edit a positive/negative Intent by either:
      • Double-clicking the Intent to edit, or
      • Selecting the Intent and clicking the pencil button
      • When done editing, press Enter
    • Delete a positive/negative Intent by selecting the Intent and clicking the red cross in the top of the Intents list
    • Filter Intents by using the text filter (Filter Examples) available below the list of positive/negative Intents
    • Include in Auto-tests allows to exclude/include the Intents of the Intent Trigger when running Flow and Solution Auto-tests
  • Add the desired Matches)
  • Add any needed After Matches
  • In the Triggering section:
    • Select an Order group
    • Open the Trigger Ordering window by using the Ordering icon
    • Under Advanced Options, specify:
      • Trigger only once per session
        Indicates if the trigger should be executed just once per session or may be repeated
      • Test sentences from either Last to first (default) or First to last
        By default, sentences in the end-user's input are tested "last to first", but this setting allows to set the testing from "first to last" and to test sentences in the same order as they appear in the end-user's input
  • Under Metadata add any needed Metadata definitions
  • Remember to Save the Flow to preserve the changes.

In the new User Intent box:

  • Click Edit to start adding positive Intents
  • Click Add to add more positive Intents to the list
  • Hover over an Intent to delete it, by clicking the recycle bin at the end of the line
  • Click Close when finished
  • Remember to Save the Flow to preserve the changes

Delete User Intent trigger

To delete an Intent Trigger, follow the below steps:

  • Select the Intent Trigger in the Flow editor
  • In the top ribbon, click Delete
  • Remember to Save the Flow to preserve the changes

A Flow needs to have at least one User Intent trigger and Teneo Studio will prevent save if the deletion of a User Intent trigger leaves the Flow without any trigger.

To delete an User Intent, follow the below steps:

  • In the User Intent, click the three vertical lines in the top right corner
  • Click Delete node
  • Remember to Save the Flow to preserve the changes.

A Flow needs to have a least one User Intent trigger and Teneo Studio will prevent the deletion of the User Intent if it would leave the Flow without any trigger.