Teneo Developers

User Intent

Introduction

The User Intent is where the developer should define which examples of user intent should be covered by the scope of the trigger or transition; the examples of User Intent should include different sentences or requests which end-users would typically use in order to obtain the 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 Intent.

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
    • Generate examples Only available when LLM Settings are defined for the Account - allows to automatically generate positive/negative examples of Intent based on either already existing Intent examples or a description
    • Edit a positive/negative example by either:
      • Double-clicking the example to edit, or
      • Selecting the example and clicking the pencil button
      • When done editing, press Enter
    • Delete a positive/negative example of User Intent by selecting the example and clicking the red cross in the top of the list
    • Filter examples of User Intent by using the text filter (Filter Examples) available below the list of positive/negative examples
    • Include in tests allows to exclude/include the examples of User Intent in tests, i.e., Auto-test and Class Performance (also see Class Manager)

Positive examples of User Intent are meant to cover an end-user's possible input which should be covered by the Flow scope, while the Negative examples are meant to include examples which should not be covered by the current 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 example either click the green + icon or press Enter
  • Generate examples Only available when LLM Settings are defined for the Account - allows to automatically generate positive/negative examples of Intent based on either already existing Intent examples or a description
  • Edit a positive/negative example by either:
    • Double-clicking the example to edit, or
    • Selecting the example and clicking the pencil button
    • When done editing, press Enter
  • Delete a positive/negative example of User Intent by selecting the example and clicking the red cross in the top of the list
  • Filter examples of User Intent by using the text filter (Filter Examples) available below the list of positive/negative examples
  • Include in tests allows to exclude/include the examples of User Intent in tests, i.e., Auto-test and Class Performance (also see Class Manager)

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

Edit User Intent trigger

To edit a 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 example of User Intent by either:
      • Double-clicking the example to edit, or
      • Selecting the example and clicking the pencil button
      • When done editing, press Enter
    • Delete a positive/negative example of User Intent by selecting the example and clicking the red cross in the top of the list
    • Generate examples Only available when LLM Settings are defined for the Account - allows to automatically generate positive/negative examples of Intent based on either already existing Intent examples or a description
    • Filter examples by using the text filter (Filter Examples) available below the list of positive/negative examples
    • Include in tests allows to exclude/include the examples of User Intent in tests, i.e., Auto-test and Class Performance (also see Class Manager)
  • 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.

Generate

The option to Generate User Intent examples is only available if LLM Settings are defined for theAccount

To automatically generate examples of User Intent, follow the below steps:

  • In the open Flow, first select the trigger or transition to open the left-side panel
  • In the panel, go to the User Intent section
  • Click Generate
  • In the pop-up, select if the examples should be generated from existing examples or a description and also how many examples should be generated
  • Click Generate; alternatively click Cancel to abort
  • When the data generation has finished, review the examples in the preview and click Apply to add them to the User Intent
  • Remember to Save the Flow to preserve the changes.

The new examples are highlighted with a yellow border for easy recognizability.

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.

Details

User Intent Examples

Positive examples of User Intent are meant to cover possible inputs which end-users could say to the conversational AI application in order to obtain information related to the scope of the current Flow, i.e., the positive examples should trigger the flow trigger or transition they belong to.
Negative examples of User intent - currently only available in Teneo Studio Desktop -, on the other hand, allows to add examples of inputs which should not be covered by the current User Intent trigger or transition.

Both the positive and negative examples of User Intent are used in other Studio features, such as the draft TLML Syntax (in TLML Syntax Matches), Suggest Ordering and Auto-test, while others, such as Class Performance, make use only of the positive User Intent examples.

If LLM Settings are defined for the Studio Account, examples of User Intent can be generated automatically by use of generative AI allowing to easily add new examples based on either previously added User Intent examples or a description.