# 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.



#### __Teneo Studio Desktop__

__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](media/user-intent/desktop-plus-icon.jpg)

+ 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](user-guide/auto-test/automated-testing)

> 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)](user-guide/flow/match-requirements)
+ Add any needed [After Matches](user-guide/flow/data-actions)
+ In the __Triggering__ section:
  + Select an [Order group](user-guide/ordering/ordering-groups)
  + 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](user-guide/globals/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](user-guide/auto-test/automated-testing)

For more information about settings and options on transitions, please [see here](user-guide/flow/transition?id=transition-specifics).

#### __Teneo Studio Web__

__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



#### __Teneo Studio Desktop__

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](user-guide/auto-test/automated-testing)
+ Add the desired [Matches)](user-guide/flow/match-requirements)
+ Add any needed [After Matches](user-guide/flow/data-actions)
+ In the __Triggering__ section:
  + Select an [Order group](user-guide/ordering/ordering-groups)
  + 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](user-guide/globals/metadata-definitions) 
+ Remember to __Save__ the Flow to preserve the changes.

#### __Teneo Studio Web__

 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



#### __Teneo Studio Desktop__

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.

#### __Teneo Studio Web__

 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.

RELEASE NOTES

Platform Dependencies

Dependencies and Licenses

Prerequisites of Teneo Frontends

Teneo 7.0

Teneo 7.0.1

Teneo 7.0.2

Teneo 7.0.3

Teneo 7.1

Technology and Deployment

Teneo Studio

Technology and deployment

KNOWLEDGE BASE

Bulk Import formats

Format Entities

Format Language Objects

Format Question and Answer pairs

General about format

General

FAQs

Log data

Data model

Metadata

Machine learning

Class Manager

Class Performance

Publish

Solution publish

Resources

Lexical resources

Lexical resources for log data analysis

Teneo naming conventions

Scripts

NLU Variables and Propagation scripts

Predicate scripts

Using scripts

Solution

Localization setup

Multiple Flow Triggers

Skip Conditions

Predefining template solutions

Prompt Triggers

Relative ordering

Resume Prompts

Safetynet and default output

Sub-flows

Teneo Engine

Environment recognition

Output parameters

Processing path

Script and Listener events in the matching process

Stack of active flows

The answering process

TLML Syntax

Limit unused words to

Draft TLML Syntax

Sentence test order and stop testing

TLML Syntax Summary

TLML Syntax Writing

REFERENCE

API reference doc

Teneo Inquire client

Interfacing with API JSPs

Web Socket API

NLP Capabilities

Chinese IP Chain

Japanese IP Chain

Korean IP Chain

Date and Time

Named Entity Recognizer

POS Tagger

Standard IP Chain

Turkish IP Chain

Conversational Modules

Date & Time

Deprecated objects

Pre-built Entities

Flow lists

Named Entity ANNOT objects

POS/Morphology ANNOT objects

Dialogue Resources

Lexical Resources

Offensive Language Detection

Sentiment & Intensity Analysis

Teneo Linguistic Modelling Language (TLML)

Teneo Query Language (TQL)

Auto-test

Auto-test results panel

Automated testing

Class management

Class manager window

Working with Classes and training data

Entity

Entity Basics

Entity Window

Entries Editor

Variables

Flow

Bot Output

After Matches

Flow Basics

Flow Link

Flow Listener

Nodes and elements

Flow Variable

Flow window

Integration

Matches

Prompt

Script

Sub-flow

Transition

User Intent

Globals

Emotions

Global Listeners

Global Scripted Contexts

Global Scripts

Global Variables

Troubleshooting Globals

Import Export

Bulk import

Export/Import of lexical resource

Importing and exporting

Merging solutions

Language Object

Language Object Basics

Language Object Window

Optimization

Class performance

Classifier

Improvement suggestions

Querying log data

Ordering

Ordering groups

Ordering suggestions

Trigger Ordering window

Working with trigger relations

Publish environments

Publish a solution

Integrations

Resource Files

Custom IP Resource File

Troubleshooting Resources

Document Basics

Version Control

Keyboard Shortcuts

Lexical Resource Information

Properties Lists

Localization Structure

Updates From Master

Recycle Bin

Search

Solution Properties

Solution Window

Syntax Editor

Referenced Documents

Teneo Log Data Manager

Augmenters

Teneo Manager

Get Started

Import/Export

Lexical

Solution Basics

Spellcheck

User Permissions

Login

Tryout

Advanced Tryout

Detailed information

TENEO 7.1.0

Table of Contents

User Intent

Introduction

Add new User Intent

Edit User Intent trigger

Delete User Intent trigger