Import Intents

Import Intents via CSV

You can quickly add one or more intents to your knowledge base via a CSV file.
Existing intents can also be edited if the corresponding Intent ID is included.

From the Intents list page, select the More menu (at top right) and choose Import Intents via CSV

Import Intents via CSV

Download a CSV Template

For convenience, you can download a pre-configured CSV Template with the column headers needed.

Click Download CSV Template to download the template file.

Download CSV Template

You can also download this template by clicking here.

Edit a CSV File

Make a copy of the CSV Template file and rename it.

When adding intent data to the file please note the following -

  • All column headers must be present
  • Main Question and Response Text fields must contain values
  • The Start Date and End Date fields must be in UK or System format (see format table below for more detail)
  • The Start Date should not be a date after the End Date in order to avoid that intent being always inactive
  • The Start Time and End Time fields' format must be hh:mm
  • The Alternative Inputs and Keywords fields can contain multiple values, separated by commas. This means that these values, currently, should not contain commas. Any values that do contain commas will be split
  • If editing in Excel, the CSV file must be saved in UTF-8 encoding to ensure that extended characters (£, $ etc.) are uploaded correctly
    (Use the Save As option and select the CSV UTF-8 (comma-delimited) file type)

A full list of valid Intent Field Formats is provided at the end of this section.

Upload a CSV File

Click Upload File to upload your Intents CSV file.

Upload CSV File

The files contents will be validated.

If all intents are valid they will be uploaded to the database and the intents added to the project's knowledge base. You will receive an email once the upload is fully complete.

If any field on any intent is invalid then the entire upload is rejected. All invalid fields will be listed to aid in troubleshooting the errors.

Intent Field Formats

Parameter Description
Intent ID If set it will update existing intents, if left empty will create a new intent.
Main Question Mandatory The main user input for the intent.
Alternative Inputs List of alternative user inputs. Separate with commas (leave no spaces before or after comma) - Known issue Alternative inputs that contain commas will be split
Response Text Mandatory The response of the intent. There is no limit on the length of this field.
Active Sets the intent to active or inactivate. This can either be true or false. Defaults to true if not set.
Folder The name of the folder. If the folder already exists it will add the intent to the existing folder, if it doesn't exist it will create a new folder.
Subfolder The name of the sub folder. If the sub folder exists within the parent folder it will update the existing intents, if it doesn't exist it will create a new folder of that name.
Keywords List of keywords. Separate with commas (leave no spaces before or after comma).
Category The name of the category. If the category exists it will assign the existing category, if the category doesn't exist it will create a new category.
Video URL The URL of the video. Currently, this only supports YouTube videos.
Notes Additional information about the intent for internal use.
Start Date The date that the intent should be available from.
Accepted formats: yyyy/MM/dd, dd/MM/yyyy, dd/MM/yy
Ensure Start Date is before End Date.)
End Date The date that the intent should no longer be available from.
Accepted formats: yyyy/MM/dd, dd/MM/yyyy, dd/MM/yy
Ensure End Date is after Start Date.
Start Time The time of day this intent is able to be surface from. If not set this it will be available at all times. If either Start Time or End Time is set both fields become mandatory.
Accepted format hh:mm
End Time The time of day this intent is able to be surface until. If not set this it will be available at all times. If either Start Time or End Time is set both fields become mandatory.
Accepted format hh:mm
Monday Whether the intent should be active on Mondays. Defaults to true.
Tuesday Whether the intent should be active on Tuesdays. Defaults to true.
Wednesday Whether the intent should be active on Wednesdays. Defaults to true.
Thursday Whether the intent should be active on Thursdays. Defaults to true.
Friday Whether the intent should be active on Fridays. Defaults to true.
Saturday Whether the intent should be active on Saturdays. Defaults to true.
Sunday Whether the intent should be active on Sundays. Defaults to true.
Document ID The source location of the intent contents.

Import Intents via API

You can import intents via our API.

See the Import Intent endpoint documentation for more details.

Still need help? Get in touch!
Last updated on 5th Jun 2020