Overview of BotBuilder and its tabs

icon picker
Vocabularies tab

The Vocabularies tab is a tab where you can create and edit
@Vocabulary
⁠
s for use in
@Agent
⁠
s.
A
@Vocabulary
⁠
is a table of data that is loaded into an
@Agent
⁠
. It is used in conjunction with the
@Synonym Slot
⁠
(more details: ).
A
@Vocabulary
⁠
is an object that that can be used in any
@Agent
⁠
within the
@Company
⁠
.

Navigating to the Vocabularies tab

There are two ways to navigate to the Vocabularies tab:
Go to the Resources tab and click on the Vocabularies button.
Go to the Agent Designer and open the Vocabularies tab.

List of Vocabularies

The Vocabularies tab presents a list of all the
@Vocabulary
⁠
s: ​
image.png
⁠
⁠
Name displays the name of the
@Vocabulary
⁠
. ​
image.png
⁠
⁠
⁠
@Vocabulary
⁠
s can be sorted alphabetically. ​
image.png
⁠
⁠
Clicking the sort button changes the sorting order: from the beginning of the alphabet to the end and vice versa.
In use displays the usage of
@Vocabulary
⁠
s in the
@Agent
⁠
s. ​
image.png
⁠
⁠
Next to each
@Agent
⁠
where the
@Vocabulary
⁠
is used, there is a checkmark and a Clarify button.
Clicking the Clarify button displays icons of
@Agent
⁠
s that use this
@Vocabulary
⁠
​
image.png
⁠
⁠
The
@Limit on the number of Vocabularys in a Company
⁠
is 40. When attempting to upload the 41st
@Vocabulary
⁠
to the
@Company Resources
⁠
, an error will occur with the text You have exceeded the maximum number (40) of vocabularies. and the
@Vocabulary
⁠
will not be uploaded to the
@Platform
⁠
.
When attempting to import an
@Agent
⁠
with a
@Vocabulary
⁠
, if the sum of the number of
@Vocabulary
⁠
s in the
@Company
⁠
and in the imported
@Agent
⁠
exceeds 40, an import error will occur.

Searching for Vocabularies

Searching by Vocabulary Name

To search for
@Vocabulary
⁠
s by name, enter the desired value in the search field.
The list will display only the
@Vocabulary
⁠
s that contain the search string in their name. ​
image.png
⁠
⁠

Searching by Vocabulary Usage

Searching by
@Vocabulary
⁠
usage in the
@Agent
⁠
s is done using the In use and Not in use filters:
Clicking the In use button displays only the
@Vocabulary
⁠
s that are used in the
@Agent
⁠
s. ​
image.png
⁠
⁠
Clicking the In use button replaces the Not in use filter with the Agent filter — a filter by
@Agent
⁠
s.
Clicking the Agent button opens the search panel by
@Agent
⁠
s. ​
image.png
⁠
⁠
To find
@Vocabulary
⁠
s used in specific
@Agent
⁠
s, click on the desired
@Agent
⁠
s in the list.
Clicking the Not in use button displays the
@Vocabulary
⁠
s that are not used in the
@Agent
⁠
s. ​
image.png
⁠
⁠

Searching by Vocabulary Language

Searching for
@Vocabulary
⁠
s based on their language can be done using the Language filter:
Clicking on the Language button opens a dropdown list of languages. ​
image.png
⁠
⁠
Clicking on one or more items in the list:
Selects the language(s) with a checkbox.
Filters and displays only
@Vocabulary
⁠
s in the selected language(s) on the tab. ​
image.png
⁠
⁠

Creating, Editing, and Deleting Vocabularies

Preparing the Vocabulary Table

The file uploaded as a
@Vocabulary
⁠
must have the following characteristics: ​
image.png
⁠
⁠
CSV format.
File content:
The first column — name: 'entity', content:
@Entity
⁠
names (
@Entity
⁠
is a set of
@Synonym
⁠
s).
The second column — name ‘synonyms', content:
@Synonym
⁠
s separated by commas.
⁠
@Entity
⁠
names can be repeated.
⁠
@Synonym
⁠
s within different
@Entity
⁠
s can be repeated.
The case of
@Synonym
⁠
s does not affect the recognition result.
If there are "duplicates" in a
@Vocabulary
⁠
— rows where the
@Entity
⁠
name and sets of
@Synonym
⁠
s are the same (even with different order of these
@Synonym
⁠
s in the rows) — only the first of the “duplicates” will be imported during the
@Vocabulary
⁠
import process.
⁠
@Entity
⁠
recognition works qualitatively and flexibly only for the languages specified in the table , i.e. different word forms of
@Synonym
⁠
s are recognized, not just exact matches. In other languages (if the
@Vocabulary
⁠
is in a different language or multiple languages are mixed), recognition will only occur based on the exact match of the search string with items in the
@Vocabulary
⁠
(without inflections, declensions, etc.).
There is a
@Limit on the number of Entitys in a Vocabulary
⁠
: When attempting to upload a
@Vocabulary
⁠
with more than 10,000
@Entity
⁠
s in the
@Company Resources
⁠
, an error will occur with the text Entity count must be less than 10,000. and the
@Vocabulary
⁠
will not be uploaded to the
@Platform
⁠
. ​
Screenshot_27.png
⁠
⁠
There is a
@Limit on the number of Synonyms in an Entity in a Vocabulary
⁠
: When attempting to upload a
@Vocabulary
⁠
with more than 500
@Synonym
⁠
s in at least one
@Entity
⁠
in the
@Company Resources
⁠
, an error will occur with the text Synonym count must be less than 500 (row <row number containing more than 500 synonyms>. and the
@Vocabulary
⁠
will not be uploaded to the
@Platform
⁠
. ​
Synonym count must be less than 500 (row 2).png
⁠
⁠
Languages available in Vocabularies
4
Language
Abbreviation in the dropdown list
1
Russian
image.png
2
English
image.png
3
Portuguese
image.png
4
Ukrainian
image.png
5
Spanish
image.png
6
Thai
image.png
No results from filter
⁠


Creating a New Vocabulary in Company Resources

To create a new
@Vocabulary
⁠
, follow these steps:
Go to the list of
@Vocabulary
⁠
s.
Click on the Create new button. ​
image.png
⁠
⁠
Enter the
@Vocabulary
⁠
name in the Name field. The maximum length of the field is 1000 characters. Once the maximum value is reached, additional characters cannot be entered into the field. ​
image.png
⁠
⁠
It is possible to upload multiple
@Vocabulary
⁠
s with the same name.
Specify the
@Vocabulary
⁠
language by selecting it from the dropdown list in the Language field. Available languages are listed in the
Broken link
⁠
table. ​
image.png
⁠
⁠
The Language field becomes disabled for editing after the
@Vocabulary
⁠
is saved.
Upload the file for the
@Vocabulary
⁠
by clicking the Upload your vocabulary button or by dragging the file into the window.
It is possible to upload the same
@Vocabulary
⁠
file multiple times.
Save the entered data by clicking the CREATE button.

Editing a Vocabulary

You can edit a loaded
@Vocabulary
⁠
by following these steps:
Go to the list of
@Vocabulary
⁠
s.
Open the settings of the
@Vocabulary
⁠
by clicking on its name in the list. ​
image.png
⁠
⁠
The following changes can be made to the
@Vocabulary
⁠
:
The
@Vocabulary
⁠
name can be changed in the Name field. It is editable.
The Language field cannot be changed after the
@Vocabulary
⁠
is saved.
To update the file for the
@Vocabulary
⁠
, upload a new file by clicking the Upload your vocabulary button or by dragging the file into the window.
Save the entered data by clicking the SAVE button.
The changes will take effect after the
@Agent
⁠
is trained.

Deleting a Vocabulary

To delete a single
@Vocabulary
⁠
, follow these steps:
Go to the list of
@Vocabulary
⁠
s.
Select the
@Vocabulary
⁠
by clicking on its name or using the selector.
Click on the Delete or Delete vocabulary button. ​
image.png
⁠
​
image.png
⁠
⁠
Confirm the action in the modal window by clicking the DELETE VOCABULARY button. ​
image.png
⁠
⁠
If a
@Vocabulary
⁠
is being used in one or more
@Agent
⁠
s, a warning will appear indicating that it needs to be removed from the
@Agent
⁠
s first. ​
image.png
⁠
⁠
If the
@Vocabulary
⁠
is not being used in any
@Agent
⁠
s, it will be deleted.

Exporting a Vocabulary File

To download a
@Vocabulary
⁠
file to your computer, follow these steps:
Go to the list of
@Vocabulary
⁠
s.
Select the
@Vocabulary
⁠
by clicking on its name or using the selector.
Click on the Download or Download vocabulary button. ​
image.png
⁠
​
image.png
⁠
⁠
After clicking the button, the
@Vocabulary
⁠
file will be downloaded to your computer.
The file has the format name vocabulary_<Vocabulary ID in the Platform>
Example: vocabulary_281
The file has the .csv extension.

Bulk Actions with Vocabularies

The Vocabularies tab supports multiple selection and bulk actions that can be applied to a group of
@Vocabulary
⁠
s.

Multiple Selection

Multiple selection of
@Vocabulary
⁠
s can be done in the following ways:
Check the checkboxes next to the desired
@Vocabulary
⁠
s manually. ​
image.png
⁠
⁠
Check the checkbox in the mass selection selector — this will select all
@Vocabulary
⁠
s on the page. ​
image.png
⁠
⁠
Select one of the
@Vocabulary
⁠
groups. Clicking on the arrow opens a dropdown list. ​
image.png
⁠
⁠
The dropdown list presents the following options, clicking on one of them will select the corresponding group of
@Vocabulary
⁠
s: ​
image.png
⁠
⁠
All — all
@Vocabulary
⁠
s.
In use — only
@Vocabulary
⁠
s used in
@Agent
⁠
s.
Not in use — only
@Vocabulary
⁠
s not used in
@Agent
⁠
s.

Deselecting Vocabularies

To deselect the selected
@Vocabulary
⁠
s, use one of the following methods:
Remove the checkboxes manually.
Use the deselect option in the mass selection selector. ​
image.png
⁠
⁠
Select the Clear selection option in the dropdown list. ​
image.png
⁠
⁠

Bulk Deletion of Vocabularies

To delete multiple
@Vocabulary
⁠
s at once, follow these steps:
Select multiple
@Vocabulary
⁠
s as described in the section.
Click on the Delete vocabularies button. ​
image.png
⁠
⁠
Confirm the action in the modal window by clicking the DELETE VOCABULARIES button. ​
image.png
⁠
⁠
If any of the selected
@Vocabulary
⁠
s are being used in one or more
@Agent
⁠
s, a warning will appear indicating that the
@Vocabulary
⁠
s were not deleted. ​
image.png
⁠
⁠

Exporting and Importing Vocabularies during Agent Export and Import

When exporting an
@Agent
⁠
, all
@Vocabulary
⁠
s contained within it are also exported. The
@Agent
⁠
file with the included
@Vocabulary
⁠
s is exported as a .cfg file.
When importing an
@Agent
⁠
, the
@Vocabulary
⁠
s used in the
@Agent
⁠
are also imported. The following rules apply:
If a
@Vocabulary
⁠
with an identical file exists in the
@Company
⁠
, the
@Vocabulary
⁠
will not be duplicated. Instead, the existing
@Vocabulary
⁠
from the
@Company Resources
⁠
will be used.
If a
@Vocabulary
⁠
with the same name but a different file exists in the
@Company
⁠
, the
@Vocabulary
⁠
will be imported: ​
image.png
⁠
⁠
If there is no such
@Vocabulary
⁠
in the
@Company
⁠
, it will be imported and appear in the list of
@Vocabulary
⁠
s.
If, taking into account points 1-3, the total number of
@Vocabulary
⁠
s in the
@Company
⁠
after importing the
@Agent
⁠
should exceed 40, then an import error will occur. ​
image.png
⁠
⁠
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.