vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Creating an assistant 

Create an assistant with the skills it needs to address the business goals of your customers.

Follow these steps to create an assistant:



1. Click the Assistants icon ![Assistants menu icon](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/nav-ass-icon.png).

1.3: Click the Assistants tab. If you don't see the Assistants tab, click the breadcrumb link in the page header.
2. Click Create assistant.
3. Add details about the new assistant:



* Name: A name no more than 100 characters in length. A name is required.
* Description: An optional description no more than 200 characters in length.



1.5: With the 1.5.0 release, if your assistant has a skill associated with it, the following integrations are created for you automatically unless you choose not to enable them:



* Web chat: Creates a chat widget that you can embed in your company website to deploy your assistant in minutes.
* Preview link: Creates an IBM-branded public web page that you and your team can use to test your assistant.



You cannot enable the integrations from the assistant creation page unless a skill (dialog or search) exists.
4. Click Create assistant.
5. Add a skill to the assistant by choosing one of the following skill types to add.

Note: You can choose to add an existing skill or create a new one.



* Add Dialog Skill: Uses Watson natural language processing and machine learning technologies to understand user questions and requests, and respond to them with answers that are authored by you.

When you add a dialog skill from here, you get the development version. If you want to add a specific dialog skill version, add it from the skill's Versions page instead.
* Add Search Skill: For a given user query, uses the IBM Watson® Discovery service to retrieve information from a data source that you identify and shares any relevant information that it finds as the response to the user.
See [Changing the inactivity timeout setting](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings) for more information on the subject.

You can connect one skill of each type to your assistant. The number of skills you can build differs depending on the plan you have. See [Skill limits](https://cloud.ibm.com/docs/assistant?topic=assistant-skill-addskill-add-limits) for more details.

If you want to create an assistant in a different service instance, you can switch to another service instance. See [Switching the service instance](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settingsassistant-settings-switch-instance).





 Deleting an assistant 

When you delete an assistant, any integrations that you defined for the assistant are automatically deleted also. Skills that you added to the assistant are not deleted.

To delete an assistant, follow these steps:



1. From the Assistants page, find the assistant that you want to delete.
2. Click the ![open and close list of options](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/kebab.png) icon, and then choose Delete. Confirm the deletion.







 Renaming an assistant 

You can change the name of an assistant and its associated description after you create the assistant.

To rename an assistant, follow these steps:



1. From the Assistants page, find the assistant that you want to rename.
2. Click the ![open and close list of options](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/kebab.png) icon, and then choose Rename.
3.
[Skills menu icon](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/nav-skills-icon.png).

v1.3: Click the Skills tab. If you don't see the Skills tab, click the breadcrumb link in the page header.
2. Click Create skill.
3. Click the Search skill option, and then click Next.
4. Specify the details for the new skill:



* Name: A name no more than 100 characters in length. A name is required.

Currently, you cannot rename your search skill later.
* Description: An optional description no more than 200 characters in length.



5. Click Continue.
6. Choose the Discovery for IBM Cloud Pak for Data instance that you want to extract information from.

If no instances are available, ask an administrator whether Discovery is deployed in your environment. If so, ask to be given access to the Discovery instance. If not, you cannot create a search skill.
7. Choose the project that you want to use, by doing one of the following things:



* Choose an existing project, and then click Configure. Skip to the [Configure the search](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-skill-search-addsearch-skill-add-configure) procedure.
* If you do not have a project or do not want to use any of the projects that are listed, click Create a new project to add one. Follow the procedure in [Create a data collection](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-skill-search-addsearch-skill-add-create-discovery-collection).









 Create a data collection 

When the Discovery application opens in a new browser tab or window, the Projects page might be displayed briefly. You do not need to create a project.
This documentation is for the classic Watson Assistant experience. To see the documentation for the new Watson Assistant, please go [here](https://cloud.ibm.com/docs/watson-assistant).



 Working with skills 

Perform common tasks, such as renaming or deleting a skill.



 Renaming a skill 

You can change the name of a skill and its associated description after you create the skill.

To rename a skill, follow these steps:



1. From the Skills page, find the skill that you want to rename.
2. Click the ![open and close list of options](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/kebab.png) icon, and then choose Rename.
3. Edit the name, and then click Save.







 Duplicating a skill 

You can duplicate a skill to make a copy of it.

To duplicate a skill, follow these steps:



1. From the Skills page, find the skill that you want to duplicate.
2. Click the ![open and close list of options](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/kebab.png) icon, and then choose Duplicate. The copied skill has the word copy added to the end of its name.







 Deleting a skill 

You can delete any skill that you can access, unless it is being used by an assistant. If it is in use, you must remove it from the assistant that is using it before you can delete it.

Be sure to check with anyone else who might be using the skill before you delete it.

To delete a skill, complete the following steps:



1. Find out whether the skill is being used by any assistants.
* For details about the available system entities, see [System entities](https://cloud.ibm.com/docs/assistant?topic=assistant-system-entities).



3. Set the switch for each system entity that you want to use to On.



After you enable system entities, Watson Assistant begins to retrain. After training is complete, you can use the entities.





 Entity limits 

The number of entities, entity values, and synonyms that you can create depends on your Watson Assistant service plan:



Plan details

 Plan Entities per skill Entity values per skill Entity synonyms per skill 

 Enterprise 1,000 100,000 100,000 
 Premium (legacy) 1,000 100,000 100,000 
 Plus 1,000 100,000 100,000 
 Lite, Trial 100 100,000 100,000 



System entities that you enable for use count toward your plan usage totals.



Plan details continued

 Plan Contextual entities and annotations 

 Enterprise 150 contextual entities with 3000 annotations 
 Premium (legacy) 150 contextual entities with 3000 annotations 
 Plus 100 contextual entities with 2000 annotations 
 Lite, Trial 10 contextual entities with 1000 annotations 







 Editing entities 

You can click any entity in the list to open it for editing. You can rename or delete entities, and you can add, edit, or delete values, synonyms, or patterns.

If you change the entity type from synonym to pattern, or vice versa, the existing values are converted, but might not be useful as-is.





 Searching entities 

Use the Search feature to find entity names, values, and synonyms.



1. From the Entities page, click the Search icon.

![Search icon in the Intents page header](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/entities-search-icon.png)

System entities are not searchable.
2. Enter a search term or phrase.
If you already have Discovery for IBM Cloud Pak for Data installed and an instance provisioned, you can mine your existing data collections for source material that you can share with customers to address their questions.

The following diagram illustrates how user input is processed when both a dialog skill and a search skill are added to an assistant. Any questions that the dialog is not designed to answer are sent to the search skill, which finds a relevant response from a Discovery data collection.

![Diagram of how a question is sent to the Discovery service from a search skill.](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/search-skill-diagram.png)

For help creating a search skill, see [Creating a search skill](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-skill-search-add).





 Create the skill 

You can add one skill of each skill type to an assistant.



* [Dialog Skill](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-skill-dialog-add)
* [Search Skill](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-skill-search-add)







 Skill limits 



Skill limit details

 Skills per service instance 

 50 



Skill versions do not count toward the skill limit.





 Deleting a skill 

You can delete any skill that you can access, unless it is being used by an assistant. If it is in use, you must remove it from the assistant that is using it before you can delete it.

Be sure to check with anyone else who might be using the skill before you delete it.

To delete a skill, complete the following steps:



1. Find out whether the skill is being used by any assistants. From the Skills page, find the tile for the skill that you want to delete. The Assistants field lists the assistants that currently use the skill.
2.
Intents that are added from a content catalog are distinguishable from other intents by their names. Each intent name is prepended with the content catalog name.
3. Add a content catalog to your dialog skill by clicking the Add to skill button.
4. Go to the Intents page to see the intents that you added from the catalog listed.



Your skill trains itself on the new data.

After you add a catalog to your skill, the intents become part of your training data. If IBM makes subsequent updates to a content catalog, the changes are not automatically applied to any intents you added from a catalog.





 Editing content catalog intents 

Like any other intent, after you add content catalog intents to your skill, you can make the following changes to them:



* Rename intents
* Delete intents
* Add, edit, or delete intent user examples
* Move an example to a different intent
To create a backup, [download the skill as a JSON file](https://cloud.ibm.com/docs/services/assistant?topic=assistant-skill-tasksskill-tasks-download). If you use an actions skill, each team member can work on a single action at a time.





 Popular role assignments 

To get you started quickly, consider applying these roles at first.



* To give someone the same level of access to a Watson Assistant service instance as you have, assign the user to the following roles:



* Instance platform role: Administrator
* Instance service role: Manager



* To give someone manager access to a specific set of resources, but read-only access to everything else, assign the user to the following roles:



* Instance platform role: Viewer
* Instance service role: Reader



Then, for each assistant or skill that you want the person to be able to manage, add another role assignment like this:



* Instance platform role: Viewer
* For an individual assistant or skill, assign the Manager role.









 Understanding roles 

Access to Watson Assistant, its service instances and all of the resources that are used by the service is managed by IBM Cloud®. To share a service instance with other users and control access to the instance, you must use the IBM Cloud Identity and Access Management user interface.

IBM Cloud breaks down access definitions into the following role types:



* Instance-level platform roles
* Instance-level service roles
* Resource-level service roles



An instance-level access role is a role that applies to a service instance and all of the resources that are created as part of the instance. A resource-level service role gives you the ability to apply a finer-tuned level of access control to a single skill or assistant in an instance.



 Platform roles 

A platform role controls a person's ability to access a service instance in IBM Cloud. Choose a platform role to assign to the user.



Table 1. Global platform role details

 Role Privileges of the users in this role 

 Administrator Access and change all resources for the instance, and invite other people to access the instance. 
 Viewer View the service instance, but cannot invite others to access the instance. 



The Editor and Operator platform roles are equivalent to the Administrator role.
Why can't I create a project? 

  What’s happening 

You cannot create a project in your resource group.

  Why it’s happening 

If you cannot create a project in your resource group, determine whether one of the following cases is true.



1.  Your project name must be unique in the region.
2.  You might not have the proper platform access to create a project.
3.  The number of projects exceeds the maximum number of projects that you can create per region.



  How to fix it 

Try one of these solutions.



1.  If you receive a warning message about your project name not being unique, select a different name.
2.  To create a project, you must have Administrator set for Platform Access and Reader for Service Access. For more information, see [Managing user access](https://cloud.ibm.com/docs/codeengine?topic=codeengine-iam).
3.  The maximum number of Code Engine projects that you can create per region is 20. The maximum number of projects includes projects that are active and any projects that are not permanently deleted, such as projects that are soft deleted. For more information about limits for projects, see [Project quotas](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limitsproject_quotas). Use the [project list](https://cloud.ibm.com/docs/codeengine?topic=codeengine-clicli-project-list) command to display all your projects across all regions and the status of these projects. See [deleting a project](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-projectdelete-project) for more information about projects that are hard deleted and soft deleted.



If these solutions do not solve your issue, try one of the resources in [getting support](https://cloud.ibm.com/docs/codeengine?topic=codeengine-get-support).
Adding a good description will help you to distinguish multiple versions from one another later.

Add the date you deploy the version to its description to make it easier to filter logs by version from the Analytics page later. For more information, see [Picking a data source](https://cloud.ibm.com/docs/assistant?topic=assistant-logslogs-pick-data-source).
2. Click Save.



A snapshot is taken of the current skill and saved as a new version. You remain in the development version of the skill. Any changes you make continue to be applied to the development version, not the version you saved. To access the version you saved, go to the Versions page.

If you have trouble creating the version, check that your skill does not have any entities with large numbers of values (such as 10,000 or more synonyms for a single entity). If it does, try to break the entity into many, more categorized entities, or consider using a contextual entity instead.





 Deploying a skill version 



1. From the skill menu, click Versions.
2. Click the ![Click to view actions](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/kebab.png) icon from the version you want to deploy, and then choose Assign.

A list of assistants to which you can link this version is displayed. The list is limited to those assistants that don't have any skills associated with them, or that are associated with a different version of this skill.
3. Click the checkbox for one or more of the assistants, and then click Assign.



Keep track of when this version is deployed to an assistant and for how long. It is likely that you will want to analyze user conversations that occur between users and this specific version of the skill. You can get this information from the Analytics page. However, when you pick a data source, versions are not listed. You must choose the name of the assistant to which you deployed this version.
Creating a search skill 

An assistant uses a search skill to route complex customer inquiries to IBM Watson® Discovery for IBM Cloud Pak® for Data. Discovery treats the user input as a search query. It finds information that is relevant to the query from a configured data source and returns it to the assistant.

Add a search skill to your assistant to prevent the assistant from having to say things like, I'm sorry. I can't help you with that. Instead, the assistant can query existing company documents or data to see whether any useful information can be found and shared with the customer.

![Shows a search result in the preview link integration](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/search-skill-preview-link.png)

You must have Discovery for IBM Cloud Pak for Data installed and an instance provisioned before you can complete this procedure to create a search skill. The search skill can connect only to an existing Discovery for IBM Cloud Pak for Data instance.

Your search skill can connect to a single Discovery project. The project can contain multiple collections.

To learn more about how search skill can benefit your business, [read this blog post](https://medium.com/ibm-watson/adding-search-to-watson-assistant-99e4e81839e5).



 How it works 

The search skill searches for information from one or more data collections that you create by using Discovery for IBM Cloud Pak for Data.

Discovery for IBM Cloud Pak for Data crawls, converts, and normalizes your unstructured data. The product applies data analysis and cognitive intuition to enrich your data such that you can more easily find and retrieve meaningful information from it later. To read more about Discovery, see the [product documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-about).

Typically, the type of data collection you add to Discovery and access from your assistant contains information that is owned by your company.
This documentation is for the classic Watson Assistant experience. To see the documentation for the new Watson Assistant, please go [here](https://cloud.ibm.com/docs/watson-assistant).



 Working with your assistant 

Learn how to find and open assistants and skills that you created or can access.

Assistants and skills are created within a Watson Assistant service instance. To continue working with a skill or assistant, open the service instance that contains the skill or assistant. If you can't remember the service instance name, you can switch between instances from within the Watson Assistant user interface.



1. Go to the [IBM Cloud Resource list](https://cloud.ibm.com).
2. Log in.

A list of the service instances that you own or were given access to is displayed.
3. Click a service instance to open it.
4. Click Launch Watson Assistant from the service instance details page to open the product in a new browser tab or window.
5. Click the appropriate icon from the navigation pane to see a list of your assistants or skills.



* ![Assistants menu icon](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/nav-ass-icon.png) Assistants
* ![Skills menu icon](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/nav-skills-icon.png) Skills





If you do not see the skill or assistant you are looking for, you can look for it in a different service instance.



 Switching the service instance 

To switch to a different Watson Assistant service instance, complete the following steps:



1. From the header of any page in the current instance, click the User icon !
Go to the [Discovery](https://cloud.ibm.com/catalog/services/watson-discovery) page in the IBM Cloud catalog and create a Plus plan service instance.



If you decide not to continue using the Plus plan and don't want to pay for it, delete the Plus plan service instance before the 30-day trial period ends.





 Create the search skill 



1. From the assistant where you want to add the skill, click Add search skill.

You can only add a search skill if you are a user with a paid plan.
2. Take one of the following actions:



* To create a new search skill, stay on the Create skill tab.
* If you have created a search skill already, the Add existing skill tab is displayed, and you can click to add an existing skill.



3. Specify the details for the new 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.



Next, you will connect to a Discovery service instance.
4. Click Continue.







 Connect to an existing Watson Discovery instance 



1. Choose the Discovery instance that you want to connect to.

If you see a warning that some of your Discovery service instances do not have credentials set, it means that you can access at least one instance that you never opened from the IBM Cloud dashboard directly yourself. You must access a service instance for credentials to be created for it, and credentials must exist before Watson Assistant can establish a connection to the Discovery service instance on your behalf. If you think a Discovery service instance is missing from the list, open the instance from the IBM Cloud® dashboard directly to generate credentials for it.
2. Indicate the collection to use, by doing one of the following things:



* Choose an existing project.

You can click the Open Discovery icon to review the configuration of a project before you decide which one to use.

Go to [Configure the search](https://cloud.ibm.com/docs/assistant?topic=assistant-skill-search-addskill-search-add-configure) and follow the remaining steps.