Assistant Basics

Creating an Assistant

The first step in designing an Assistant within AI Studio is to create a new one using the New Assistant button in Assistants:

After creating the Assistant provide it with a name:

📘

You can override the default agent Id by using the Change button next to the agent preview

Next, you'll need to select whether you'd like to create your assistant from scratch or from a template, you can read more about templates here:

Once created, you'll be dropped into the Flow Editorfor your newly created assistant.

Assistant Detail

Click into an assistant will bring you to the Assistant detail page:

From here, you can modify your assistant status, view your assistant revision history, download assistant statistics, and more.

Status

The status of your assistant determines whether or not it's able to receive conversations and respond to users on the channels it's available on. You can modify your assistant status by selecting it's current availability and updating as necessarily:

Versioning

Each assistant has it's revision history that can be access via the See All Revision button:

This allows you to track changes over time and easily revert back to previous versions of your assistant, or create a new draft from a previous version.

Edit Details

You can use the Edit Details button to modify your assistant's name, email and role:

Publishing

📘

Active Conversations & Versions

When a conversation is assigned to your assistant, it will be associated with whichever revision is currently live and will stay with that revision of the assistant until the assistant reassigns or closes the conversation. This insures that your assistant never has downtime.

Reviewing

The Review button enables you to compare changes between the version of an assistant your looking at, and the previous version:

Changes between versions can be viewed either side by side, or line by line using the Output Format option.

Any of the Panels (Flow, Configuration, Function, etc) that have changed since the previous version will show up under File . You also have the ability to view the raw output of all differences:

Additionally, you can use Diff to view changes between versions, or view changes since your last save, which can be helpful when working in an active draft & checking what you've done since you last saved:

📘

The review button can be found both within an assistant, and when viewing revisions, enabling you to compare changes between previous versions of your assistant.

Exporting and Importing

You can export any version of an assistant. The downloaded assistant definition file can then be imported, either to another assistant, or into another tenant to migrate changes made in a staging tenant to production.

Export

An Export button is displayed for each version on the Version History page, as well as on the Assistant Details page in the More menu. Both the current Draft and Live versions, as well as previously published versions, can be exported:

Selecting the Export button will download a .json file locally containing the assistant definition. The file name is in the format QUIQBOT_botuser_YYYYMMDDHHMISS.json, where botuser is the assistant username and the date/time is the time the file was downloaded.

When exporting an assistant, you, you have the option to include Test Sets associated with the Assistant.

🚧

Do not edit this file. If this file is edited in any way, you will not be able to import it.

Import

A previously exported Quiq Assistant definition can then be imported into a Quiq Assistant to the Draft version. If a Draft version already exists, an Import button is available which will overwrite the existing draft with the definition in the export file. If no Draft version currently exists, then a Import Into Draft button exists which will create a new draft version with the definition from the export file:

After selecting the Import button, you will be prompted for the assistant definition file to import. You can drag a file into the box, or click and select one from the file manager.

When importing, you have the option to decide whether or not you'd like to include Test Sets, and whether or not you'd like to Merge Test Sets:

📘

If importing into a different tenant than that the Assistant was exported from, if the custom fields referenced in the export bot definition are not exactly the same between the tenants, you may also get a message stating that the references to the custom fields need to be removed, and the Bot exported again before it can be imported.

Dependencies

After selecting a valid assistant export .json file, depending on the behaviors that are configured in the exported assistant definition, you may need to reset some dependencies. Dependencies are references to objects (things like Contact Points, Queues, Agents, etc). Some dependencies may exist in the exporting tenant, but not the importing tenant.

There are 3 types of dependencies: Required (red), Warning (yellow) and Optional (gray).

• Required dependencies must be set to continue. You will be required to map a dependency when you have a Decision Condition that references an object that doesn’t exist on the importing tenant.

• Warning dependencies may be reset, but you are able to continue without setting them. If you do not set warning dependencies, after import you will have validation errors on the assistant that need to be manually corrected.

• Optional dependencies are indicating that the object referenced in some behavior does exist on the importing tenant, but you can change the reference to something else if desired.

After selecting the Finish Import button, you are taken to the Flow Panel and the draft version of the assistant contains the definition from the export file.

Things to note:

• Exported assets are only available for 5 days after export. When assistant export file containing assets is imported into a different tenant (that does not contain those assets) after the 5-day expiration window, the import will succeed but the assets will be missing. A pop-up notification in AI Astudio will alert the Admin if this occurs.

• If the exported assistant definition file has behaviors that contain Decision Conditions on a custom field, and that custom field is missing or incompatible on the importing tenant, the Bot cannot be imported.

• If the exported assistant definition file has behaviors that contain Set Field or Increment Field Actions on a custom field, and that custom field is missing or incompatible on the importing tenant, the assistant can be imported. However there will be validation errors that will need to be manually corrected.

Search

When working in an assistant, there is a persistent Search option that enables you to search for and navigate to a range of content within your assistant.

Search can be accessed via the Search button at the top of an Assistant when editing or reviewing:

Search includes much more than just Behaviors, below is a list of some of the content you can search for:

• Panels
• Behaviors
• Functions
• Prompts
• Fields
• Text within a behavior
• Special Events