Teneo Developers

Advanced Tryout

The options and functionalities described in this page currently only apply toTeneo Studio Desktop

Detailed information

The right side of the advanced Tryout window provides the developer with a lot of detailed information related to the solution and the tested inputs/outputs; the following sections describes the information the developer can obtain while working in Tryout.

Tryout

Input

In the Input section of the Tryout window, the developer is able to find information related to the test input; the provided details - related to the input - are divided into different sections in the view:

  • The top of the section displays the given input
  • Classifications details information about the top predicted Class Intents
    Teneo Learn trains a machine learning model in the solution when Classes and training data are added in the Class Manager; the machine learning model is used at runtime and in Tryout to determine to which of the Classes a user input is most likely related.
    For each input, a confidence score for each and one of the classes is calculated based on the machine learning model and annotations for the most probable intent classes for that input are created (following the scheme <CLASS_NAME>.INTENT). For the class with the highest confidence (i.e. the most probable one), Teneo Predict generates a top-rated annotation tagging it with the TOP_INTENT suffix. Teneo Predict generates a maximum of 5 top intent classes; for more information about the creation of the classification annotations, please see here.

Although the classification is displayed in the Input section, the triggered Flow Trigger might not contain the displayed Class as a Match, the information related to the actually triggered Trigger is displayed under the Path

  • Annotations details the produced annotations
    Linked together with the above point, here the user finds information about the created annotations for a given user input, i.e. the annotations created by Teneo Predict as well as annotations by other Input Processors or by the Teneo Engine (such as System and Standard annotations) as well as info related to custom, project-specific annotations.
    Hoovering over an annotation provides further information, such as detailed descriptions or information related to variables and values. Exporting a Tryout session as text or CSV includes the information related to annotations.
  • Processing details information about, for example, initialized Variables and changed session variables, Input Processor results, as well as information related to Global Scripts in the solution.

Path

The Path section provides information about the different items that crossed Engine's path while processing a request.

View of Path section

The Path can contain one or more of the below information types or events, depending on the path taken from the user input is given and to the final output is provided, furthermore, these are expandable (clicking the arrow icon in the far right side) and allows the user to navigate directly to the location in the solution by clicking the ID.

  • Blue colored edge: Trigger Matches and Trigger elements
    • Match (requirements)
      Specifies which Match was matched by the given user input, e.g. Class, Context, TLML Syntax, Language Object, etc.
      Read more about the different Match types here
    • Trigger
      Displays details related to the triggered Intent Trigger
  • Yellow colored edge: Transition Matches and Transition elements
    • Match (requirements)
      Specifies which Matches were matched by the given user input
      Read more about the different Match types here
    • Transition
      Details information related to the Transition such as the Name and vertex ID, or if the Transition is input consuming
  • Green colored edge: Other elements that occur within the Flow context
    • Raise Flow
      Provides details of the Flow the triggered Intent Trigger belongs to
    • Junction
      Provides details of Junction's ID
    • Output
      Specifies details related to the Output node, such as Revisits, Emotion, Answer ID, URL, and Answer Text
    • Drop Flow
      Specifies details related to the Flow being dropped, including if the Flow was aborted or stuck

Access Path data via scripting

The data displayed in the Path section of Tryout can be access via scripting to perform certain actions and send/receive messages from the Teneo Engine; the main entry point is engineAccess which provides access to the state and functionalities of the Teneo Engine, including dialogue history and input annotations.

The below methods, provided by the engineAccess (and its alias _), gives access to the processing path programmatically:

  • _.getProcessingPath() This method can be used to obtain the path information of the current user input turn

  • _.getDialogHistory()[<history index>].getPath() This method allows to obtain the path information of earlier user input turns that can be picked from the session history.

For more information, please see the Engine Scripting API.

Output

The Output section gives information related to the Output, such as the answer text, emotion, and when applicable, the URL and/or Output parameters.

State

Information related to the state of Global Variables is displayed here. In this view the user will find any Watched Variables in the top of the list for easier control of these selected variables.
To add a Global Variable to the list of Watched Variables, simply click the Eye icon next to the name of the Variable in the list.

Messages

The Messages section provides different information related to the Engine status which depends upon which interaction in the Dialog view is currently selected; selecting an Online message will, for example, display information related to:

  • Solution parsing
  • Engine initialization
  • The solution's machine learning model (model status: update in progress, update completed, update failed)
  • Statistics, such as, number of Flows, Language Objects, and Entities in the solution and any assigned lexical resource
  • Available script engines (such as Groovy Scripting Engine) and the default scripting language
  • Error and warning messages

While a user is working in the solution, information about created and updated Flows, Language Objects, and Entities is also displayed as well as any errors detected during development; and selecting a tested input/output will present the user with information related to the response time, input text and, if available, any input parameters.

Errors and warning messages

The Dialog view of both the simple and the advanced Tryout displays information related to errors and warnings detected in the solution to quickly draw the user's attention to these, and more extended information is available in the Messages section of the advanced Tryout window.

Error messages displayed in the Tryout includes:

  • Errors when starting the Tryout Engine (i.e. HTTP errors when communicating with the server or failing initialization of Engine)
  • Missing/incorrect Language Object/Entity references
  • Disabled Language Objects/Entities used in TLML syntaxes or as entry values
  • Undeclared Variables
  • Script errors in Flows

Read more in the Troubleshooting section