An Entity describes a characteristic that helps to clarify or quantify the user's Intent. An Entity value may be a name or location, number or color, or any other object that is needed by the Intent to achieve the user's goal.

You create Entities using the IA Domain Editor. When you define an Entity type, you also provide synonyms (words that are similar in meaning) to help the NLP engine match actual user input with that Entity.

For information on how Intents and Entities are used in the IA, see About Intents and Entities.

The IA enables use of both:

  • Pre-Defined System Entities. Objects or characteristics that are in generic use, for example: numbers, dates, colors, country names, etc. For a complete list of System Entities used by the IA, click here. Pre-defined Entities are read-only.
  • Custom Entities. Objects or characteristics that you create specifically for use in an IA Domain. A Custom Entity is visible only to the Domain in which it was created. Before creating a Custom Entity type, carefully review the list of System Entities to ensure that the desired characteristic does not already appear there.

Adding Custom Entities to a Domain

  1. From the Admin Console Intelligent Assistant menu, select Domains. The Account Domains page will be displayed.
  2. At the top of the Domain Editor page for the Domain you wish to edit, click Entities. The Entities list for the Domain will be displayed.
  3. Click Add Custom Entity. The Entity editor will be displayed:



  4. Enter a unique name for the Entity. Entity names are unique for each Domain. Entity names should start with a letter and can contain the following: A-Z, a-z, 0-9, or - (dash). Entity names can be as long as 29 characters.
    Note: An Entity value may be added in multiple languages. Each available language will be displayed in a separate Entity Values section.
  5. In the Entity Values section, create the characteristic values that need to be parsed and mapped to the Domain by the NLP:
    1. Enter a value in the Add Value text box.
    2. In the Synonyms listing field, add words that are similar to the Value Name. Enter any alternative words that your user might naturally use to describe this Entity in the chatbot. Confirm the synonym in this field by pressing 'Enter' or entering a comma. To delete a previously entered synonym, click the 'X' on that synonym's bubble.
    3. Repeat the above Steps until all Entity values are created.
    If more values are needed, click on Add Value to display a new field set.
  6. When you are finished adding values to the Custom Entity, click Save in the lower right corner of the panel. You can exit the operation at anytime without saving the new Entity by clicking Cancel.

Editing Custom Entities

  1. From the Admin Console Intelligent Assistant menu, select Domains. The Account Domains page will be displayed.
  2. Click Edit on the Domain you want to edit. The Domain Editor page will be displayed for that Domain.
  3. At the top of the Domain Editor, click Entities. The Entities list for the Domain will be displayed.
  4. Select and click on the Custom Entity Name you want to edit. The selected Entity parameters are displayed.
    Note: A Search Box is provided in the list to make it easier to locate existing Entities. Enter a few letters from the Entity name into the text field to display all Entities that match your request.
  5. Perform the needed edits on the selected Entity.
  6. When you are finished, click Save in the lower right corner of the page. You can exit the operation at anytime without saving your changes by clicking Cancel.

Deleting Custom Entities

Note: You can only delete an Entity that is currently not in use by any Intent. To delete an Entity that is being used, you first need to delete references to the Entity from each Intent that uses it.

  1. From the Admin Console Intelligent Assistant menu, select Domains. The Account Domains page will be displayed.
  2. Click Edit on the Domain you want to edit. The Domain Editor page will be displayed for that Domain.
  3. At the top of the Domain Editor, click Entities. The Entities list for the Domain will be displayed.
  4. Locate the Custom Entity Name you want to delete.
    Note: A Search Box is provided in the list to make it easier to locate existing Entities. Enter a few letters from the Entity name into the text field to display all Entities that match your request.
  5. Delete the Entity by clicking on the small trashcan symbol () located to the right of the Entity name. A confirmation dialog will be displayed.
  6. To confirm, click Delete. You can exit the operation without deleting anything by clicking Cancel.

 

Revision:

Comments