How to create your Agent

icon picker
Export, import, cloning and replacing an Agent

Exporting an Agent

The
@Platform
⁠
implements functions for exporting and importing the
@Agent
⁠
configuration file. With these features, you can save an
@Agent
⁠
file to your computer, forward the file to your colleagues, and upload
@Agent
⁠
files to the
@Platform
⁠
.
To export the
@Agent
⁠
you need to:
Go to the
@Projects Tab
⁠
, open the
@Project
⁠
, find the required
@Agent
⁠
and click on the Export button in the drop-down menu. ​
image.png
⁠
⁠
The agent will be saved in .cfg format. Contents of the exported file:
⁠
@Agent
⁠
@Script
⁠
;
⁠
@Intent
⁠
s used in the
@Script
⁠
;
⁠
@External Request
⁠
s used in the
@Script
⁠
;
The value of the
@Continue Conversation
⁠
option;
The
@Inactivity Timeout
⁠
value in seconds — the time of inactivity of the
@Bot User
⁠
, after which the
@Dialog
⁠
with the
@Agent
⁠
is closed;
Grouping of
@Slot
⁠
s (collapsed
@Script Branch
⁠
es).
Now this
@Agent
⁠
can be imported into any
@Project
⁠
.

Importing an Agent

Process of import

In order to import an
@Agent
⁠
into a new
@Project
⁠
, you must:
Click on the Import agent button in the
@Project
⁠
properties. ​
image.png
⁠
⁠
In the window that appears, click Browse and select the desired file with the extension .cfg, .json. or .xlsx. Provide a name for this
@Agent
⁠
in the new
@Project
⁠
and click Import. ​
image.png
⁠
⁠
The
@Agent
⁠
will appear in the list of Agents for this
@Project
⁠
.
The imported
@Agent
⁠
does not contain any
@Project Channel
⁠
and is not trained.
If you try to download a file with an unsupported extension or invalid structure, an error will appear with the text Couldn’t import agent. ​
image.png
⁠
⁠

Import from Agent configuration file

By importing an
@Agent
⁠
@Script
⁠
from a configuration file, it is possible to create
@Agent
⁠
s with any structure allowed in the
@Platform
⁠
.
The file of this format is the result of exporting the
@Agent
⁠
from the
@Platform
⁠
.

Acceptable file extensions

At the moment, configuration files of the following extensions are available for download:
.cfg
.json

Contents of the imported Agent

When importing an
@Agent
⁠
from a configuration file, the following are imported:
⁠
@Script Tree
⁠
, including grouping of
@Slot
⁠
s (collapsed
@Script Branch
⁠
es);
⁠
@Company
⁠
resources used in the
@Script
⁠
(
@Intent
⁠
s,
@External Request
⁠
s and
@Vocabulary
⁠
), according to the import rules (, , );
The value of the
@Continue Conversation
⁠
option;
@Inactivity Timeout
⁠
value;
In the configuration file, the
@Inactivity Timeout
⁠
value is specified in seconds. After import, the value is displayed on the
@Agent
⁠
card in hours and minutes. ​
image.png
⁠
⁠
If the
@Inactivity Timeout
⁠
value in the configuration file was manually changed to a value that does not result in an integer when converted to minutes, then upon import it will be rounded up to an integer number of minutes.
If the
@Inactivity Timeout
⁠
value in the configuration file was manually changed to a negative number, 0, or a non-number value, the
@Inactivity Timeout
⁠
value will be reset to 15 minutes upon import.
If there is an
@Incoming Request Slot
⁠
in the
@Script
⁠
, a new
@Incoming Request Webhook
⁠
address will be generated for this
@Slot
⁠
, which will work only after the
@Agent
⁠
is trained.
If there is a
@Notification
⁠
@Slot
⁠
in the
@Script
⁠
, a new webhook address will be generated for this
@Slot
⁠
, which will work only after the
@Agent
⁠
is trained.

Imported
@Agent
⁠
settings

In the imported
@Agent
⁠
, the
@Continue Conversation
⁠
option is disabled.
When importing, the standard
@Inactivity Timeout
⁠
value is set to 15 minutes.

Replacement of an
@Agent
⁠
@Script
⁠
⁠

The replacement function replaces the
@Script
⁠
of an existing
@Agent
⁠
with a different
@Script
⁠
, which is contained in the downloaded configuration file. This also changes the
@Inactivity Timeout
⁠
value and the
@Continue Conversation
⁠
option value.
When importing from a configuration file, the values are set in accordance with those specified in the file;
When importing from an Excel file, the standard
@Inactivity Timeout
⁠
value is set to 15 minutes, the
@Continue Conversation
⁠
option is disabled.
The
@Agent
⁠
@Script
⁠
replacement function can be used, for example, to make changes to an
@Agent
⁠
that is already communicating with
@Bot User
⁠
s in
@End Channel
⁠
s.
Export the
@Agent
⁠
configuration file;
Import it into the
@Platform
⁠
;
Make changes to the imported
@Agent
⁠
;
If testing is successful, export the
@Agent
⁠
and replace the working
@Agent
⁠
with this configuration file.
In this way, the
@Agent
⁠
’s existing
@Chat
⁠
s with
@Bot User
⁠
s are preserved and the process of testing and changing the
@Script
⁠
made does not disrupt the process of communication between the
@Agent
⁠
and these
@Bot User
⁠
s.
Replacing the
@Agent
⁠
@Script
⁠
is done as follows:
Click the Replace config button in the
@Agent
⁠
settings menu. ​
image.png
⁠
⁠
In the window that appears, click Browse and select the desired file with the .cfg or .json extension. Click Replace. ​
image.png
⁠
⁠
For the
@Agent
⁠
to work, train it by clicking the Train button in
@BotBuilder
⁠
or on the
@Agent
⁠
card.
During the replacement process, the following will be imported from the configuration file:
⁠
@Script Tree
⁠
, including
@Slot
⁠
s grouping (collapsed
@Script Branch
⁠
);
@Company Resources
⁠
used in the
@Script
⁠
(
@Intent
⁠
s,
@External Request
⁠
s and
@Vocabulary
⁠
), according to the import rules (, , );
The value of the
@Continue Conversation
⁠
option;
⁠
@Inactivity Timeout
⁠
value.
When importing a configuration file with
@Incoming Request Slot
⁠
:
If the
@Script
⁠
already had an
@Incoming Request Slot
⁠
before the replacement, the webhook address of the
@Incoming Request Slot
⁠
in the new
@Script
⁠
will remain the same as before the replacement;
If there was no
@Incoming Request Slot
⁠
in the
@Script
⁠
before the replacement, a new
@Incoming Request Webhook
⁠
address will be generated, which will start working after the
@Agent
⁠
is trained.
When importing a configuration file with
@Notification
⁠
:
If the
@Script
⁠
already had a
@Notification
⁠
@Slot
⁠
before the replacement, the
@Notification
⁠
webhook address in the new
@Script
⁠
will remain the same as before the replacement;
If there was no
@Notification
⁠
@Slot
⁠
in the
@Script
⁠
before the replacement, a new webhook address will be generated for this
@Slot
⁠
, which will start working after the
@Agent
⁠
is trained.
During the replacement process, the following will be imported from an Excel file (similar to creating an
@Agent
⁠
from Excel):
⁠
@Agent
⁠
@Script
⁠
;
⁠
@Agent
⁠
@Intent
⁠
s will be imported into the
@Company Resources
⁠
;
In the imported
@Agent
⁠
, the
@Continue Conversation
⁠
option is disabled;
When importing, the standard
@Inactivity Timeout
⁠
value is set to 15 minutes.
The new
@Script
⁠
will start working only after the
@Agent
⁠
is retrained.

Cloning of an Agent

To clone an
@Agent
⁠
you need to:
Open the
@Agent
⁠
settings by clicking on the button on the
@Agent
⁠
card.
⁠
image.png
⁠
⁠
Click the Duplicate button. ​
image.png
⁠
⁠
After clicking the button, a warning will appear: ​
image.png
⁠
⁠
Confirm the cloning of the
@Agent
⁠
by pressing the YES, I’M SURE button.
After cloning, a new
@Agent
⁠
is created with the name COPY-[name of the cloned agent] and with its own unique identifier
@agent_id
⁠
. ​
image.png
⁠
⁠
When cloning an
@Agent
⁠
, the
@Company Resources
⁠
used in the
@Script
⁠
are cloned according to the import rules(, , ).
When cloning an
@Agent
⁠
, the value of the
@Continue Conversation
⁠
option is saved.
When cloning an
@Agent
⁠
, the
@Inactivity Timeout
⁠
value is saved.
If there is an
@Incoming Request Slot
⁠
, a new webhook address for this
@Slot
⁠
will be generated in the
@Script
⁠
.
The cloned
@Agent
⁠
does not contain any
@Project Channel
⁠
s and is not trained.
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.