Teneo Developers

Creating a Flow

Introduction

This page provides a step-by-step guide on how to set up a new Flow, with links to more information when relevant. Furthermore, it introduces the user to some of the concepts and areas of dialogue development that is good to bear in mind when creating a new Flow.

Create a Flow

To create a new Flow in Teneo Studio, follow the below steps:

  • Go to the Solution Explorer in the main Teneo Studio window (Home tab)
  • Select the folder, or alternatively create a new folder, where the Flow should be added
  • In the New area of Teneo Studio's top ribbon, click on the Flow button
  • The Flow window opens on the Properties tab
    • Give the Flow a Name
    • Optionally add a Description and a Resume Prompt
  • Click the green Play icon or the back-arrow in the top left corner to go to the main Flow window
  • Select the Trigger node to define the Trigger properties
    • Give the Trigger a Name and Description
    • Add Positive and Negative Examples which should match the trigger
    • Add the required Match Requirements
    • Define any needed Data Actions
  • Select the Output node
    • Give the Output node a Name
    • Optionally add a Description and Hyperlink
    • Click the Answer text field to write the answer text
    • Optionally select an Emotion in the drop-down menu (only available if Emotions have previously been added to the solution)
  • Save the Flow to preserve the changes.

To create a Sub-flow or a Prompt Trigger Flow, click the lower part of theFlow button in Teneo Studio's top ribbon to select either of the options in the drop-down menu.

Intent Triggers

TODO Intent Triggers and Transitions

Intent Triggers and "Match Intent" Transitions (set to Match Intent) without any defined Match Requirements will be marked with a yellow "TODO" label both in the Flow graph and in the Solution Explorer.

This functionality allows the solution designer to sketch the Flows, creating a global structure of Triggers and Transitions before specifying the particular Match Requirements.

The TODO labels do not affect the functionality of the solution at execution time, the only purpose of the labels is to remind the solution developer of the pending implementation of the Intent Triggers and/or Transitions.

An Intent Trigger (or "Match Intent" Transitions) with no Match Requirement defined will never match an input and hence will not be triggered.

TODO label in Solution Explorer

TODO label in Flow graph

Generate

In the Flow Intent Trigger (and "Match Intent" Transition), when the user has added positive Examples, the Generate button will be available for the user providing the option to have the system drafting the Match Requirement implementation based on the provided Examples.

Generate button

Intent Trigger Ordering

Once a Flow has been created, the user needs to ensure that its Intent Trigger(s) is properly ranked in the Intent Trigger Ordering.

New Intent Triggers are added to the Default Order group until the user moves it.

Usually Intent Triggers are placed in different Order groups depending on how accurate or specific their Match Requirements are: the more specific an Intent Trigger, the higher the Intent Trigger should be in the order ranking.

Giving the Intent Trigger a proper name will make it easier to locate the Intent Trigger in the Intent Trigger Ordering window later.

Nodes and Transitions

Add Node to the Flow

It is possible to add one or more nodes, such as a Junction, Script, or Output, to the Flow to design the dialogue as needed; this is done in the Add Node area found in the top ribbon of the Flow by simply clicking the node to add. For more details please see Adding notes and transitions.

Transitions

A Flow with more than one node has Transitions, displayed as arrows between the different nodes in the Flow graph.

When adding new nodes, if another node in the Flow graph is selected, the new node will automatically be linked to the selected one. If no node is selected in the Flow, the user will have to create a transition between the nodes by simply clicking one Flow node, maintaining the mouse button pressed, and drawing an arrow to the following node.

Please see more details here.

Set node as Start Node

To set a node as the starting point of the Flow, right after the Intent Trigger, the user can select the node and click Set Start Node in the top ribbon.

Test the Flow

The user should test new Flows to make sure that the Examples included in the lists of positive and negative Examples behave as expected; Teneo Studio provides an option to run automatic tests as well as an option to test inputs manually in the Try Out.

Auto-test at Flow level

Go to the backstage of the Flow (Flow tab > Auto-test); choose Run Test using Flow Scope.

The default behavior of the Auto-test (Run Flow Test) is to test the Examples of the Current Flow's Intent Trigger(s) against all other Intent Triggers in the solution; however, when selecting Run Test using Flow Scope, the test will ignore the presence of any other Intent Trigger than the one(s) belonging to the current Flow and simply tests if the Flow's Examples match the current Intent Trigger's Match Requirements. If the test at Flow scope fails, update the Match Requirements to cover all the written examples.

Read more about the Auto-test here.

Test in Try Out

A Flow can also be tested in the Try Out to confirm that the Flow is triggered for other user inputs than the ones defined in the Examples; if another Flow is triggered instead, check the Match Requirements of the Flow's Intent Trigger(s) and the Ordering. Maybe the Match Requirements need to be more specific or the Intent Trigger Ordering needs modification for the Intent Trigger to get triggered.

Read more about Try Out here.

Match Requirements
Keyboard shortcuts for working in Studio