NAV Navbar

Create a project

The first step is to create the project. There are two ways to create a project in Mix.dashboard:

Create a project using Quick Start

The Quick Start option allows you to select one of three ready-to-use project templates to quickly create a new project without having to customize project settings. Project templates are based on predefined channels in Mix. There are three projects templates:

To create a project using Quick Start:

  1. On the Projects bar, click the Add icon Add icon.

    The Create a new project window appears.
  2. Under Quick Start, choose the desired project template.
    create project modal window quick start The right-hand pane shows the channels and modalities from the selected template, and the default language for your Mix environment. You can click Configure under the parameters you would like to change—for example, to customize channels, or choose another use case and languages (see Build your own project for details).
    Note: Project templates have a default General use case.
  3. Name your project.
  4. Click Create.
    The new project appears on your Mix dashboard.

Build your own project

Building your own project involves choosing channels and modalities, a use case, and languages.

To build your own project:

  1. On the Projects bar, click the Add icon Add icon.

    The Create a new project window appears. create project modal window
  2. Click Create new.
    Select the channel and modalities appears. select channel and modalities
  3. Choose the desired organization if this project is meant to be shared with others.
    Note: You must have an owner role in the desired organization to create a project. See organizations for more information.
  4. Select one or more predefined channels or add a custom channel.
  5. Click Next.
    Select a use case & languages appears. select use case and languages
  6. Select the desired use case.
    A use case is a language model which has been trained to be used for a certain scenario. You can select the General use case that will contain information about the general language, or select a particular use case that will contain language tailored for a specific scenario, like Healthcare or TV & Media.
    Note: The set of use cases available for selection depends on the data packs installed in your Mix environment, and on the organization specified for your project.
  7. Select the desired languages and locale versions where applicable.
    Note: Languages with multiple locale versions have a down arrow to the right of the default version. Once you select the language, click the arrow to select a different locale version.
    The selected use case, languages and their locale versions appear in the right-hand pane.
  8. Click Next.
    Name your project appears. name project window
  9. Name your project.
  10. Click Create.
    The new project appears on your Mix dashboard.

Add a custom channel

To add a custom channel:

  1. Click the Add icon Add icon custom channel, above Add a custom channel.
  2. Provide a name for your channel.
  3. Select the modalities for your channel. You must select at least one modality.
    The selected channels appear in the right-hand pane.
    Note: You cannot add/remove modalities after you have created a project.
    Add a custom channel

Predefined channels

When creating a new project, you can select one or more predefined channels to quickly build your project. These predefined channels contain different sets of modalities that determine how your application will exchange information with its users. Predefined channels also provide the base settings of the Quick Start project templates. This table summarizes the predefined channels available when creating a project:

Channel Modalities Description
IVR channel Audio Script, DTMF, TTS An interactive voice response channel for developing telephony applications that perform automated operations and transactions.
Digital VA (text) Interactivity, Rich Text A digital virtual assistant for web chat applications.
Digital VA (voice) Interactivity, Rich Text, TTS A digital virtual assistant for all-purpose conversational applications.

Modalities

A modality specifies a format used to exchange information with the user, such as TTS, audio, text, and so on.

When you create a project, the following options are available:

Organizations

Projects created in an organization are shared with other users in that organization. Each user has a personal organization. Your personal organization name is usually your email address. You can add other users to your personal organization.

Organizations determine the use cases available to you, among those available in your Mix environment, when creating a project.

View project details

To see project details, click the Projects icon, select the project, and click the Details tab.

Versions section

The Versions section lists the different committed project versions that are available for this project. By default, when you create a new project, it has a status of "master", which means that there are no snapshots available. The master version is the current working version of a project.

To see the details for a specific project version, select that version in the Versions area.

Information section

Field Description
Name Name of the project. If it is too long, the name is truncated. Hover over the field to get the complete name.
Project ID ID of the project.
Created Date and time the project was created.
Last Modified Date and time the project was last modified.
Organization(s) Organizations for the project.
Latest Published Version Most recent NLU/Dialog build that was successfully completed.
Channel(s) Channels available for this project; for example, ivr and web. Hover over the number to get the channel names.
Locale(s) Languages used in this project. If more than one language is used, hover over the string Multi to get the list of languages used. For the list of all supported languages, see Languages and Voices.
Domains Number of prebuilt domains available in the project (either imported from the Domains tab or uploaded as .trsx files). Hover over the number to get the domain names.
NLU Sources List of Mix prebuilt domains used in the project. Hover over the number to get the domain names.
Topic Domain Speech recognition engine used for this project.
Data Pack Versions Versions of the NDP and QNLP data packs used in this project. See Working with data packs.

Content section

The Content section lists the number of intents, sample sentences, entities, and literals in the project. Depending on your project and the size of the prebuilt domains you are using, it's good practice to keep track of these values so that you do not exceed certain limits.

See Limits for more information.

The information is organized per locale. If you have more than one locale in your project, the Content section provides a sub-section with the content for each locale. For example:

Manage targets

The targets tab provides information about the locales, channels, and modalities that are defined for a project.

This tab is currently read-only for channels and modalities. It will support additional functionality in the future.

Archive locales

You can archive locales so that they are no longer available from Mix. When you archive a locale:

To archive a locale:

  1. In Mix.dashboard, select the project and click the Targets tab.
  2. In the Locale(s) area, click the Archive switch for the language you want to archive.
    The switch is greyed out.

If you need to use the locale in your project again, you can unarchive it.

Unarchive locales

To unarchive a locale:

  1. In Mix.dashboard, select the project and click the Targets tab.
  2. In the Locale(s) area, click the Unarchive switch for the language you want to unarchive.
    The switch is displayed in green and the locale is now available from Mix.

Channel settings

The Channels area provides information about the channels available in your project. You can see this area in the Targets tab on Mix dashboard for any specific target. The first columns specify the modalities available for the channel, and the last column represents the color associated with the channel.

Each type of channel, whether Omni Channel VA, IVR/Voice VA, Digital VA, or a Custom Channel is represented by a different color.

The main Mix channels are associated with the following colors:

These colors will be visible in Mix.dialog if you are undocking your channels to create channel-specific transitions. Colors help differentiate any channel-specific transitions between undocked channels on your Mix.dialog canvas.

The diagram shows how the colors are associated with each channel in the Channel Dock list, as well as with transitions between undocked channels in Mix.dialog:

Manage your projects

Delete a project

To delete a project:

  1. Select it in Mix.dashboard.
  2. Click the Delete icon delete icon, upper-right corner of Mix.dashboard.
  3. Click Delete to confirm.

This action is permanent. You will not be able to recover your project once you have deleted it.

Note: If you get the error message: "An error occurred during the deletion of the project," make sure that no application configurations are deployed for this project. You cannot delete a project if it has one or more application configurations deployed.

Clone a project

Rename a project

To rename a project:

  1. Select it in Mix.dashboard.
  2. Click the Rename icon rename icon, upper-right corner of Mix.dashboard.
  3. Enter a new name for the project.
  4. Click the checkmark.

When sharing a project link with another user, the behavior of Mix.dashboard depends on the user's organizations:

The shared link will open to the project's Details in both cases.

See Manage your organizations for more information.

Add members

You add members to the project through the Members tab. Members can have one of the following default project roles:

To add members:

  1. In Mix.dashboard, click the Projects icon, select the project, and click the Members tab.
  2. Click Add Member.
  3. In the User field, type the name of the user to find it.
  4. In the Role field, select the role for this user.
  5. Click Save.

To delete a member, hover your cursor over the member name and click the Remove member icon associated with that user.

Note: If you cannot see the Add Member or Delete icon:

Manage your organizations

The Manage tab lists the organizations that are available to you. An organization is a space where you create projects. Projects created in an organization are shared with all the users in this organization. All users also have a personal organization (specified with the email address). Projects that you create in your personal organization can only be seen by you. Note that you cannot move a project from one organization to another.

To display the organizations that are available to you:

  1. Click the Manage tab.
  2. In the left-hand pane, expand the Organizations section.
    The organizations to which you belong are displayed.

For each organization, two tabs are available:

Depending on your role, you may be able to add users to an organization and assign roles.

Understanding roles and permissions in Mix

Permissions are associated with roles at different levels in the Mix user interface. Roles are defined at the following levels:

Organization roles

By default, the following roles are available at the organization level:

Note: Additional roles may have been configured for your organization.

To see the organizations that are available to you, the users that belong to these organizations, and the available roles:

  1. In Mix.dashboard, click the Manage tab.
  2. In the left-hand panel, expand the Organizations section.

For more information, see Manage your organizations

Application roles

By default, the following roles are available at the application level:

To see the users who have access to your applications as well as their roles:

  1. In Mix.dashboard, click the Manage tab.
  2. In the menu on the left, select Applications.
  3. Click the Members tab.

Project roles

By default, there are three main project roles:

Note: If you do not have a specific role for a project, but this project was created in an organization to which you belong, then you will see the project in your list. The permissions that you have for this project will be the ones that you have for the organization.

For more information, see Add members

Change your password

You change your password from your profile page.

Your password must contain:

To change your password:

  1. In Mix.dashboard, click your name and select Profile.
  2. Click Change Password.
  3. In Current Password, enter your current password.
  4. In New Password, enter your new password.
  5. In Confirm New Password, enter your new password again.
  6. Click Save.