Teneo Developers

Format questions and answers

Flow file specifications

Before creating the file to import Question and Answer pairs, please make sure to read thegeneral specifications first.

When performing a Bulk Import of Question & Answer (Q&A) pairs, Teneo Studio will create TODO Intent Triggers when no Match Requirements are defined in the file, it is currently possible to define a Class Match and a TLML Syntax Match, by using the fields <class name> <condition>, respectively.

When no Order group is specified in the csv file, Intent Triggers are added to a "Q & A" Order group created during Bulk Import.

To specify the last optional field, the preceding fields must exist too, even if their values are left empty. For example, to specify a #question Intent Trigger with a Class Match Requirement, it has to be specified as follows:

#question, , , , , ,MY_CLASS_NAME

Importing a flow in its simplest form, only adding the mandatory values looks similar to the below example:

#question_answer, Flow Name #question, , #answer, Answer text

Specifics

To import flows of the type Question and Answer pairs, the csv file needs to contain the fields as visualized in the below table, in the specified order.

TagField 1Field 2Field 3Field 4Field 5Field 6
#question_answer<flow name><description><output url><random answer order [true, false]>
#question<trigger name><positive examples><negative examples><order group><condition><class name>
#answer<answer text><emotion>
#folder<folder name>

Mandatory fields with mandatory values

These fields need to exist in the file and they need to contain values.

  • #question_answer Mandatory tag, Indicates the beginning of a new Flow (Q&A pair)
  • <flow name>Mandatory field, contains the name of the Flow
  • #question Indicates a new Intent Trigger
    • One #question tag is mandatory per Q&A pair in the file
    • Multiple Intent Triggers can be added by adding additional #question tags to the same Q&A pair
  • #answer Mandatory tag, indicates a new answer
    • Multiple answers can be added to a flow by adding additional answer tags
    • Multiple answers are imported to the same Output node
  • <answer text>Mandatory field, contains the answer text

Mandatory fields with optional values

These fields need to exist in the file, but can be left empty/have no value.

  • <trigger name>Mandatory field, optional value, contains the name of the Intent Trigger
  • <positive examples>Mandatory field, optional value, positive examples of User Intents of the Intent Trigger
    • Separate examples with / (slash)

Optional fields with optional values but fixed placement

These fields are optional and so are their values, but if any of the info is added, the placement of the info in the file is fixed (see table above).

  • <description>Optional field, Flow description
  • <output url>Optional field, Output URL
  • <random answer order [true|false]> Optional field
    • Choose whether the answer order is random or not by adding the Boolean value true/false
  • <negative examples> Optional field with fixed placement, negative examples of User Intent of the Intent Trigger
    • Separate examples with / (slash)
  • <order group> Optional field
    • If no order group is specified, Intent Triggers are added to a "Q & A's" Order group created during Bulk Import
  • <condition> Optional field, adds a TLML Syntax Match
  • <class name> Optional field, adds a Class Match
    • If the Class currently doesn't exist in the solution, it will be added to the Class Manager on import, using the intent trigger's positive examples as training data
    • If the file contains multiple references to a not yet existing Class, then the first intent trigger in the file referencing the class will be used to create the Class and its training data. The following references will link to this new Class
    • Note that to create a new Class with Bulk Import, at least 1 positive example needs to be added to the first trigger that references the new Class
  • <emotion> Optional field
    • Name of the emotion to add to the answer
    • Note that the name of the emotion should already exist in the solution, read more here on how to create emotions in Teneo Studio.

Optional tag with optional value

  • #folder <folder name>Optional tag, optional value
    • Folder tag and relative folder path are mandatory if importing to solution root
    • The folder path is relative to the selected folder in Teneo Studio upon Bulk Import
    • To specify a subfolder, each folder should be separated with / (slash).