Self Help Online Studio - Dictionary Management

Last modified on 2023/07/27 10:45

Note: Only for domain administrators

Dictionaries are used by the virtual agent to analyze user questions and to select the most relevant content related to the request. They are also used to correct spelling errors.

  • A dictionary is associated with a given language.
  • It is a CSV file comprising a list of terms or entities, as well as their existing links. Open url.png See Description of the Excel file

Notes

  • A dictionary is associated with one or more Self Help projects  for a virtual agent belonging to the same domain.
  • Default_... dictionaries are installed with the Online Studio for each of the languages supported by Self Help. They are managed by EasyVista. 
  • Customers can add their own dictionaries. Open url.png See the procedure

Caution

  • You must not modify Default ... dictionaries managed by EasyVista. This is because all modifications will be overwritten in the event of a patch installation, version upgrade or platform migration.

Best Practice

  • You can export the list of terms in a dictionary to a CSV file. This enables you to view and modify it easily in Excel. You can then import the file to update the dictionary on the server. Open url.png See the procedure
  • If you only want to modify the description of the dictionary, the domain or the associated Self Help projects, you can switch to update mode. Open url.png See the procedure

Menu access

Online Studio > AI > Dictionaries

Screens description

Dictionary

         Dictionary.png

Name: Dictionary name.

Language: Dictionary language.

  • You must specify the language code in the following format, xx_XX.

example  English --> en_EN; English US --> en_US

Description: Description of the dictionary.

Domain List / Project List: List of domains and Self Help projects in the scope of the dictionary.

Entity list

Access: Click Magnifying glass icon.png (Entities) in the dictionary's form

         Dictionary - Entity.png

  • (1)  Type of term, i.e. noun, verb, onomatopoeia, adjective, preposition
  • (2)  Parent terms
  • (3)  Term (displayed on a blue background) and its synonyms
  • (4)  Child terms

Description of the Excel dictionary file

     Open url.png See the description

Procedures

How to add a new dictionary

Step 1: Add the new dictionary

1. Select AI > Dictionaries in the Online Studio menu.

2. Click + Add.

3. Enter a name for the new dictionary.
 

Step 2: Import the CSV file

1. Select the CSV file to be imported.

2. Specify the language code of the new dictionary in the following format, xx_XX.

3. (optional) Add a description of the dictionary's characteristics.
 

Step 3: Select the domains and Self Help projects

1. Select the domains and Self Help projects associated with the new dictionary.
 

Step 4: Import the CSV file

1. Click Import.

The new dictionary will appear in the list of dictionaries available on the server.

How to modify dictionary contents using an Excel export/import file

Step 1: Export the dictionary contents to an Excel file

1. Select AI > Dictionaries in the Online Studio menu.

2. Select the dictionary to be modified.

3. Click Export icon.png (Export) in the top banner.

A CSV file will be generated.
 

Step 2: Modify the contents of the Excel file

1. Open the CSV file in Excel.

2. Make the required modifications.

3. Save the file.
 

Step 3: Import the Excel file

1. Select AI > Dictionaries in the Online Studio menu.

2. Select the dictionary to be updated.

3. Click Import icon.png (Import) in the top banner.

4. If you want to overwrite the existing dictionary with the terms in the CSV import file, tick the Replace existing dictionary box.

or

If you want to keep the existing dictionary terms and simply add the new or modified terms, do not tick the Replace existing dictionary box.

5. Click Import.

The dictionary will be updated on the server with the contents of the Excel file.

How to modify the dictionary description and associated Self Help projects

Step 1: Select the dictionary

1. Select AI > Dictionaries in the Online Studio menu.

2. Select the dictionary to be modified.

3. Click Update icon.png (Update) in the top banner.
 

Step 2: Modify the dictionary's information

1. Modify the required information, e.g. name, language, description, etc.

2. Select the domains and Self Help projects associated with the dictionary.

3. Click Update.

The information on the dictionary will be updated on the server.

Tags:
Powered by XWiki © EasyVista 2024