This article applies if your domain is using the LivePerson engine or a third-party NLU engine. Domains using the LivePerson (Legacy) engine don't require training that results in a model version.

Introduction

Use the Versions page in Intent Manager to view and manage the model versions that you create via training of the domain.

The Versions page with callouts to the key features of releasing versions, rolling back to versions, downloading versions, and viewing the audit log

You can create as many model versions as you want. There isn't a limit on this. However, only the latest 100 versions are stored and shown.

Train a domain to create a model version

Training a domain creates a new model version with the results. The process and related info vary depending on which NLU engine the domain uses:

A new model version created from training isn't released automatically. See below for info on this.

Release a model version

When you release a trained model version, it makes the version “live.” That is, it becomes the model version that’s used whenever the domain is referenced: in Conversation Builder, in API calls to the NLU engine, and in analytics.

Whenever you release a model version, it is marked with both a Released badge and Live indicator.

A version, in this case Version 3, with both a Released badge and a Live indicator

As you release subsequent versions, the “Live” indicator changes accordingly:

A list of versions with a callout to one version that was released but is no longer live, and to another version that was released and is live now

If you're adding a pre-built domain, the first model version is already trained, and it's released automatically. In all other cases, releasing a version is a manual step.

Ensure that you test before releasing a model version. You can (and should!) create and test multiple model versions before choosing to release one of them.

To release a model version

  1. Access Intent Manager.
  2. Locate the domain list in the Intent Manager dashboard.
  3. Select the name of the relevant domain, and then select Build from the menu that appears.
  4. Select the Versions page.
  5. Click the Release button for the trained version.

    The Actions column in the table of versions, with a callout to the release button

  6. Review the guidance in the pop-up window. Then click Release.

    The Release version pop-up window where you confirm the action

Roll back to a previously released version

You can roll back to an earlier model version if the domain uses the LivePerson NLU engine. Rolling back makes that earlier version “Live” again. Do this when you want to return Production to a prior state.

Notes

  • Roll back isn't a feature that's available if the domain is using a third-party NLU engine.
  • While rolling back affects which version is live, it doesn’t affect your work-in-progress intents and entities. They’re always built on top of the most recently trained version.

Want to reset your work-in-progress training data to an earlier good state? Download the intents and entities in the desired version, and import it into the domain (you can do so in Domain Settings). This performs an overwrite.

To roll back to a previously released version

  1. Access Intent Manager.
  2. Locate the domain list in the Intent Manager dashboard.
  3. Select the name of the relevant domain, and then select Build from the menu that appears.
  4. Select the Versions page.
  5. Click the Roll back button for the version.

    The Actions column in the table of versions, with a callout to the roll back button

  6. Review the guidance in the pop-up window. Then click Roll back.

    The Roll back to version pop-up window where you confirm the action

Retrain an older version

For performance reasons, we store only the following versions:

  • The Live version
  • 5 additional, most recently released versions
  • 5 most recently trained versions

To test and release an older version, you must retrain it first. This creates a new model version. The new version has exactly the same training data that's in the version that you retrained.

Example

Assume you have versions 1 through 7. You then retrain version 2. This creates version 8. Version 8 has exactly the same training data that's in version 2. And in the Changes column on the Versions page, you'll see info about the differences between (new) version 8 and (previous) version 7.

To retrain an older version

  1. Access Intent Manager.
  2. Locate the domain list in the Intent Manager dashboard.
  3. Select the name of the relevant domain, and then select Build from the menu that appears.
  4. Select the Versions page.
  5. Click the Retrain button for the version.

    The Actions column in the table of versions, with a callout to the retrain button

  6. Review the guidance in the pop-up window. Then click Retrain.

    The Retrain version pop-up window where you confirm the action

View a version's intents and entities

Sometimes you might want to view the intents and entities in a model version that you created, i.e., not those in the training data that’s your work in progress. And you can. But the view is read only, so you can’t make edits.

To view a version's intents and entities

  1. Access Intent Manager.
  2. Locate the domain list in the Intent Manager dashboard.
  3. Select the name of the relevant domain, and then select Build from the menu that appears.
  4. Select the Intents page or Entities page.
  5. Select the version using the selector in the upper-right corner.

    The Intents page that has a selector in the upper-right corner for selecting the version whose intents and entities you want to view

    This displays the intents and entities for the version.

Download a version's intents and entities

  1. Access Intent Manager.
  2. Locate the domain list in the Intent Manager dashboard.
  3. Select the name of the relevant domain, and then select Build from the menu that appears.
  4. Select the Versions page.
  5. Click the Download CSV button for the version.

    The Actions column in the table of versions, with a callout to the download CSV button