Autopilot CLI Plugin (Community Project)
Twilio Autopilot will be shut down on August 25, 2023.
Twilio Autopilot will be disabled for all users on August 25, 2023. After this date, customers won’t be able to access the Autopilot APIs, Console Experience, Studio Widget, and docs. Additionally, Twilio will discontinue including Autopilot support in the new helper library releases and customer support won’t answer tickets or requests regarding Autopilot after Feb 25, 2023. For full details, including migration options, see Autopilot Support at Twilio.
The Autopilot Plugin for the Twilio CLI is an open source community project. While it is not officially supported by Twilio, you can file any issues or pull requests in the github project page to fix bugs or add functionality.
The Autopilot Plugin for the Twilio CLI provides a command line interface for managing your Autopilot bots. It is built using the framework provided by the Twilio CLI, allowing it to use the same core features, like address management and logging for example.
After installing the Plugin, you'll be able to
- Create an assistant from a template.
- Export an existing assistant to a JSON schema file.
- Update an existing assistant with a JSON schema file.
- Delete an assistant.
- Simulate an Assistant.
- Train individual Tasks by uploading samples using a csv file.
- Train individual Custom Field Types by uploading samples using a csv file.
- Bulk upload Field values.
The Plugin enables you to:
- Keep your assistant in a repository with version control.
- Integrate with your CI environment.
- Share schema files and collaborate on development.
Installing the Plugin
1. Install the Twilio CLI
$ npm install -g twilio-cli $ yarn global add twilio-cli
$ brew tap twilio/brew && brew install twilio
2. Install the Plugin
twilio plugins:install @dabblelab/plugin-autopilot
Commands and Usage
Assistants twilio autopilot:create twilio autopilot:delete twilio autopilot:export twilio autopilot:list twilio autopilot:update Fields and Field Types twilio autopilot:fields:create twilio autopilot:fields:delete twilio autopilot:fields:list twilio autopilot:fieldtypes:create twilio autopilot:fieldtypes:list twilio autopilot:fieldtypes:update twilio autopilot:fieldvalues:upload Tasks and Samples twilio autopilot:tasks:create twilio autopilot:tasks:delete twilio autopilot:tasks:list twilio autopilot:tasks:update twilio autopilot:samples:upload Import bots from other platforms twilio autopilot:import [TYPE] Webhooks twilio autopilot:webhooks:create twilio autopilot:webhooks:delete twilio autopilot:webhooks:list twilio autopilot:webhooks:update Other commands twilio autopilot:modelbuilds:create twilio autopilot:simulate twilio autopilot:queries:export twilio help [COMMAND]
For more information on usage, please visit the GitHub page.
A schema file is a JSON document that defines the behavior of an Autopilot assistant. It contains the Tasks, Samples, Actions, Fields, Field Types, Field Values as well as it's Defaults and Stylesheet. Schema files can be created using the
twilio autopilot:create command or by exporting existing Assistants created using the Twilio console or the API with the
twilio autopilot:export command. You can directly edit a schema file and use the
twilio autopilot:update command to update the Assistant.
You can find a few example schema files in Autopilot Templates repo on GitHub.
Importing Dialogflow Agents
twilio autopilot:import command lets you create Autopilot Assistants using existing DialogFlow Agents. After you export an Agent into a ZIP file by following the instructions in the Dialogflow documentation, pass the ZIP file to the
twilio autopilot:import command to create an Autopilot Assistant.
- Intents, Training Phrases and Responses in Dialogflow are converted to Tasks, Samples and Say Actions in Autopilot.
- Developer Entities in Dialogflow are converted to custom Field Types in Autopilot.
- Certain System Entities in Dialogflow are converted into Built-in Field Types in Autopilot as defined in the CLI documentation.
- Dialogflow Contexts are not currently imported to Autopilot.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.