| copyright | lastupdated | keywords | subcollection | ||
|---|---|---|---|---|---|
|
2021-07-08 |
import workspace, import JSON, export JSON, upload JSON, download JSON, collaborate |
assistant |
{{site.data.keyword.attribute-definition-list}}
Documentation for the classic {{site.data.keyword.assistant_classic_short}} experience has moved. For the most up-to-date version, see Adding dialog{: external}. {: attention}
{: #skill-dialog-add}
The natural-language processing for the {{site.data.keyword.assistant_classic_short}} service is defined in a dialog skill, which is a container for all of the artifacts that define a conversation flow. {: shortdesc}
You can add one dialog skill to an assistant. See Skill limits for information about limits per plan.
{: #skill-dialog-add-task}
You can create a skill from scratch, use a sample skill that is provided by IBM, or upload a skill from a JSON file.
To add a skill, complete the following steps:
-
From the assistant where you want to add the skill, click Add an actions or dialog skill.
-
Do one of the following:
-
To create a new dialog skill, remain on the Create skill tab.
-
To add the dialog sample skill that is provided with the product as a starting point for your own skill or as an example to explore before you create one yourself, open the Use sample skill tab, and then click the sample labeled TYPE: Dialog. You can skip the remaining steps.
-
To add a skill that was downloaded previously, you can upload it as a JSON file. Open the Upload skill tab. Drag a file or click Drag and drop file here or click to select a file and select the JSON file you want to upload.
The uploaded JSON file must use UTF-8 encoding, without byte order mark (BOM) encoding. The JSON cannot contain tabs, newlines, or carriage returns. {: important}
The maximum size for a skill JSON file is 10 MB. If you need to upload a larger skill, consider using the REST API. For more information, see the API Reference{: external}. {: tip}
Click Upload.
If you have trouble uploading a skill, see Troubleshooting skill upload issues.
-
If you have created a dialog skill already, the Add existing skill tab is displayed, and you can click to add an existing skill.
-
-
Specify the details for the skill:
- Name: A name no more than 64 characters in length. A name is required.
- Description: An optional description no more than 128 characters in length.
- Language: The language of the user input the skill will be trained to understand. The default value is English.
-
For Skill type, choose Dialog.
-
Click Create skill.
After you create the dialog skill, it appears as a tile on the Skills page. Now, you can start identifying the user goals that you want the dialog skill to address.
- To add prebuilt intents to your skill, see Using content catalogs.
- To define your own intents, see Defining intents.
The dialog skill cannot interact with customers until it is added to an assistant and the assistant is deployed. See Creating an assistant.
{: #skill-dialog-add-import-errors}
Here are some solutions to typical upload issues:
-
If you get the message,
Error. Should NOT be shorter than 1 character, then check whether your skill has a name. If not, add one. -
The
@sys-personand@sys-locationsystem entities are no longer supported. If the skill you are uploading references them in its dialog, an error is displayed. Remove these system entities from your dialog. -
If you receive a message that says the skill contains artifacts that exceed the limits imposed by your service plan, complete the following steps to upload the skill successfully:
-
Purchase a plan with higher artifact limits.
-
Create a service instance in the new plan.
-
Upload the skill to the new service instance.
-
If you don't want to keep the higher-level plan, make edits to the skill such that it meets the artifact limit requirements for the plan you want to use going forward.
For information about how to decrease the number of dialog nodes, see How many nodes are in my dialog?.
-
Download the edited skill to export it.
-
Try again to upload the edited skill into the original service instance on the plan you want.
-
{: #skill-dialog-add-to-assistant}
You can add one dialog skill to an assistant. You must open the assistant tile and add the skill to the assistant from the assistant configuration page; you cannot choose the assistant that will use the skill from within the skill configuration page. One dialog skill can be used by more than one assistant.
-
From the Assistants page, click to open the tile for the assistant to which you want to add the skill.
-
Click Add an actions or dialog skill.
-
Click Add existing skill.
Click the skill that you want to add from the available skills that are displayed.
When you add a dialog skill from here, you get the development version. If you want to add a specific skill version, add it from the skill's Versions page instead.
{: #skill-dialog-add-invite-others}
After you create the service instance, you can give other people access to it. Together, you can define the training data and build the dialog.
Only one person can edit an intent, entity, or a dialog node at a time. If multiple people work on the same item at the same time, then the changes made by the person who saves their changes last are the only changes applied. Changes that are made during the same time frame by someone else and are saved first are not retained. Coordinate the updates that you plan to make with your team members to prevent anyone from losing their work. {: important}
To share a dialog skill with other people, you must give them access to the service instance that hosts the skill. Note that the person you invite will be able to access any skill or assistant in this service instance.
-
Click the User
icon in the page header. -
Make a note of the current service instance name, and then select Manage Users from the drop-down.
-
From the navigation pane, click Users.
If you gave someone access to a service instance previously, then the person might be listed as an invited user already. To change the person's level of access to the instance, click the menu next to their name, choose Assign access, and then click Assign access to resources.
-
Click Invite users.
-
Add the email address of the person with whom you want to share the instance. You can add more than one person.
-
Expand the Assign users additional resources section, and then click IAM Services.
-
In the No access field, choose {{site.data.keyword.assistant_classic_short}}.
The Account resource group is used unless you change it.
-
Select at least one region and at least one service instance to share with this user.
Remember, you made a note of the name of the current service instance in an earlier step. You can select it from the list of service instances if you want to give the person access to that service instance only.
-
Give this user the following assignments at a minimum:
- Platform access roles: Viewer
- Service access roles: Writer
For more information about roles, see Understanding roles.
-
Click Add.
You can repeat the previous step to invite other users and apply different roles to them.
-
Click Invite to finish the process.
If you are editing access for an existing user, click Assign access.
When the people you invite next log in to {{site.data.keyword.cloud}}, your account will be included in their list of accounts. If they select your account, they can see your service instance, and open and edit your skills.
With more people contributing to dialog skill development, unintended changes can occur, including skill deletions. Consider creating backup copies of your dialog skill on a regular basis, so you can roll back to an earlier version if necessary. To create a backup, simply download the skill as a JSON file.