Creating a Mix project

Before importing files, a Mix project, or potentially multiple Mix projects, need to be created.

A Mix project can be created via any of three sets of tools:

• Mix dashboard
• Mix.api
• Mix.cli

Considerations before creating a project

There are a few key considerations for creating a Mix project to build DLMs you can use in your application.

Mix projects and DLMs

Each Mix project can generate a maximum of one DLM, one NLU model, and one Dialog model. Often, an application needs more than one DLM to handle multiple different domains. If your application will require multiple DLMs, you will need to create multiple projects and build from them.

Languages

When creating a project, you need to select the languages you expect to use for your application.

For Mix hosted applications, the languages available depend on the geography where you are deploying your application. For more information, see Geographies.

For self-hosted applications, the languages available will depend on the Nuance language data packs that are included in your installation.

Channels and modalities

When creating a project, you also need to indicate channels and modalities. A channel is a medium through which a message is transmitted to your audience, for example a voice virtual assistant or IVR. A modality specifies a format used to exchange information with the user, such as TTS, audio, text, and so on. A project can support multiple channels.

Mix projects, applications, and engine packs

When you create a new Mix project, depending on your organization’s settings, you may have the options to specify an engine pack. An engine pack defines a set of Nuance Mix engine versions that are compatible with each other. The engine pack version for your project must be compatible with the engines you plan to use in your application, so that the Mix resources you build from your project are compatible with your application.

For example, if you intend to use your DLMs in an application that uses hosted Nuance ASRaaS, you need to set your project to the hosted engine pack.

If you want to use your DLMs with self-hosted Krypton, or self-hosted Dialog and Krypton, you need to set your project to the 3.x engine pack that matches your self-hosted engine versions.

If you want to use your DLMs in a Speech Suite 11 IVR application with Dragon Voice—on the Nuance-hosted IVR platform, or in a self-hosted environment—you need to set your project to the 2.x engine pack that matches the intended engine versions for your application.

See Manage engine packs and data packs for more details.

Create project using the dashboard

The Mix create a project document provides details on how to create a new Mix project using the Mix dashboard GUI tooling.

Create project using Mix.api

A new project can also be created using Mix.api using the Create a new project endpoint.

Here is an example of a call to the endpoint using curl. This creates a new project called “My Project” under the organization specified by $ORGID, with two languages—US English and Canadian French. The project allows for a Digital VA Voice channel using rich text, interactivity, and TTS modalities, and an IVR channel using audio script, DTMF, and TTS modalities.

curl -X 'POST' \
  'https://mix.api.nuance.com/v4/organizations/$ORGID/projects' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'authorization: Bearer $TOKEN' \
  -d '{
  "displayName": "My project",
  "languages": [
    "en-US",
    "fr-CA"
  ],
  "languageTopic": "gen",
  "channels": [
    {
      "displayName": "Digital VA Voice",
      "modes": [
        "RICH_TEXT",
        "INTERACTIVITY",
        "TTS"
      ],
      "color": "BLUE"
    },
    {
      "displayName": "IVR",
      "modes": [
        "AUDIO_SCRIPT",
        "DTMF",
        "TTS"
      ],
      "color": "GREEN"
    }
  ],
  "projectDescription": "",
  "isChildDataCompliant": "NO",
  "enginePackId": "d5262497-afa2-4cdf-9d3d-1a3fd70bc0c6"
}'

Create project using Mix.cli

A new project can also be created in Mix.api using the mix projects:create  command.

Here is an example of creating a new project using the command. This creates a new project called “My Project” under the organization specified by $ORGID, with two languages—US English and Canadian French. The project allows for a Digital VA Voice channel using rich text, interactivity, and TTS modalities, and an IVR channel using audio script, DTMF, and TTS modalities.

mix projects:create -c Digital_VA_Voice -L en-US -m "richtext,interactivity,tts" \
    -c IVR -L en-US fr--L fr-CA -m "audioscript,dtmf,tts" \
    -O $ORGID -t gen -n "My project" --engine-pack d5262497-afa2-4cdf-9d3d-1a3fd70bc0c6