Skip to main content

Uniphore Customer Portal

Adding, Syncing and Deleting an IA Domain (DialogFlow)

An IA Domain is always associated with a specific Agent in Dialogflow. Example domain names include "Travel" or "Billing Support". You can add multiple Domains in your Account.

Once the IA Domain is added to your account, you can view and synchronize its settings and components (i.e., Intents and Entities) with Dialogflow using the X-Console. However, NLP components are always maintained directly in Dialogflow.

Important

The Intelligent Assistant must be enabled for your account in order to work with an IA Domain. For details, click here.

Adding an IA Domain

You add an IA Domain after its Agent has been configured (usually by the Account Admin) in the Dialogflow NLP engine for your account.

Before you add the IA Domain, ensure the following:

  • you have the Project Private Key .json file that was created on the Google Cloud Platform's Service Accounts page for the associated Dialogflow Agent; and

  • the role Dialogflow API Client already has been assigned to that Agent using the IAM menu Permissions panel.

For detailed information on these prerequisites, see Dialogflow documentation.

Note

To promote ease of usability in your Multi Environment setup, it is best practice to maintain separate Dialogflow Agents for each working environment (e.g., Dev, Test and Prod). When you deploy your environment (e.g., from Dev to Test or Test to Prod), you'll also need to point the deployed IA Domain to the correct Dialogflow Agent maintained for that environment.

  1. From the X-Console U-Self Serve menu, select Domains. The Account Domains page will be displayed.

  2. Click Add New Domain. The IA Domain settings will be displayed:

    360030324292-IAAddDomain-DialogFlow_070619.png

  3. Enter a unique name for the IA Domain in the Domain Name field. In most cases, you'll want a Domain Name to be identical to the name of its associated Agent in Dialogflow. However, it does not need to match the Agent name.

    The name can contain: A-Z, a-z, 0-9, and _ (underscore) characters.

  4. In the Project Private Key field, browse for the unique key file that was created using the Google Cloud Platform's Service Accounts page. This is the .json file that securely identifies the corresponding Agent as a project for API access. The key filename begins with the name of the Dialogflow Agent.

  5. The value of the Project ID field will be entered automatically when you assign the Project Private Key file.

  6. The value(s) of the Supported Languages field will be entered automatically after you synchronize with Dialogflow. On a successful sync, all languages configured for the corresponding Agent will appear here.

  7. When you are finished adding values, click Save in the lower right corner of the panel. You can exit the operation at anytime without saving the new Domain by clicking Cancel.

  8. Before you can start using this IA Domain, you must synchronize the Domain data on X‑Platform with its corresponding data in the NLP engine by clicking on Sync, as described in the next section.

    Note

    The Sync button is enabled only in Dev and unlocked Test environments.

Syncing an IA Domain

All IA Domain data is maintained and managed in the Dialogflow NLP engine at all times. To ensure that the Domain data is completely matched and up-to-date with its associated Dialogflow data, manual synchronization is needed.

A sync is required when a new IA Domain is created. Syncs are also performed manually in order to integrate any changes you make to the NLP engine data. To perform a sync:

  1. Select the IA Domain that you want to synchronize.

  2. Click the Sync button:

    360031094211-IADomainSync-Generic_160619.png

    The IA Domain will be synchronized with its corresponding Agent in Dialogflow.

    A spinner is displayed while the sync operation is being performed. The length of time it takes to complete the sync depends on the number of components as well as the amount of data maintained by the corresponding Agent. Note: To protect data integrity, the Sync button is disabled when working in a locked Test or Prod environment.

  3. When the sync is finished, a completion popup is displayed with details on which IA Domain components have been affected and how they were changed, as shown below:

    115004312191-IASyncSuccessMessage-Details_271217.png

    When a sync operation is only partially successful, a message will display which IA Domain components failed to synchronize and also provide some details on the reason(s) for the failure.

    The sync operation always analyzes and synchronizes data for all Intents and Entities of the IA Domain, no matter where you have clicked the sync button.

  4. After a sync is performed successfully, the Last sync time field is updated to reflect the precise time and date of the sync.

Deleting an IA Domain

When you delete an IA Domain, you are not deleting its corresponding Agent or any data that is maintained in the Dialogflow NLP engine.

Note

In order to also delete Enum variables which have been associated with an IA Domain, you need to remove all references to these variables from X-Designer elements before deleting the Domain.

You can delete an IA Domain at any time using the Delete button:

  1. Select and display the IA Domain that you want to delete.

  2. Click the Trashcan icon delete-button.png.

    360031094191-IADomainDelete-Generic_160619.png

    A warning message will be displayed.

    Note

    To protect data integrity, the Delete button is disabled when working in a locked Test or Prod environment.

  3. Click Delete Domain. The selected IA Domain will be deleted and a completion message will be displayed.

In this section: