diff --git a/access-control.md b/access-control.md index 43d5c0bc..d181b661 100755 --- a/access-control.md +++ b/access-control.md @@ -8,21 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} +{{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 [Managing access](/docs/watson-assistant?topic=watson-assistant-access-control){: external}. +{: attention} # Managing access {: #access-control} @@ -83,7 +72,7 @@ For each person to whom you grant access to your {{site.data.keyword.assistant_c 1. Click **Invite** to finish the process. -When more people contribute to the development of a dialog skill, unintended changes can occur, including skill deletions. 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 that are made by the person who saves their changes last are the only changes applied. Changes that are made at the same time by someone else and that 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. Also, consider creating backup copies of your dialog skill regularly, so you can roll back to an earlier version if necessary. To create a backup, [download the skill as a JSON file](/docs/services/assistant?topic=assistant-skill-tasks#skill-tasks-download). If you use an actions skill, each team member can work on a single action at a time. +When more people contribute to the development of a dialog skill, unintended changes can occur, including skill deletions. 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 that are made by the person who saves their changes last are the only changes applied. Changes that are made at the same time by someone else and that 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. Also, consider creating backup copies of your dialog skill regularly, so you can roll back to an earlier version if necessary. {: tip} ## Popular role assignments @@ -221,7 +210,7 @@ N/A stands for no assignment, meaning no role of the type is assigned. The {{site.data.keyword.assistant_classic_short}} user interface and API comply with the access roles that are defined for a service instance. When someone logs in to the user interface, it adjusts to show only what the current user can access, and it disables functions that the user does not have permissions to do. (For example, a person who is assigned to the Reader role for a dialog skill cannot create or edit entities, intents, or dialog nodes in the skill because the **Create {resource}** and **Edit** functions are disabled.) Similarly, the API allows access only to resources and methods that are permitted for the role that is associated with the specified API key. -If you cannot access the API Details page for a skill or assistant, you might not have the access that is required to use the instance-level API credentials. You can use a personal API key instead. For more information, see [Getting API information](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-api-details). +If you cannot access the API Details page for a skill or assistant, you might not have the access that is required to use the instance-level API credentials. You can use a personal API key instead. {: note} The following table shows the UI and API actions that can be performed by different resource-level service roles. diff --git a/api-dialog-modify.md b/api-dialog-modify.md index 31375376..fc0f0423 100644 --- a/api-dialog-modify.md +++ b/api-dialog-modify.md @@ -19,7 +19,7 @@ Documentation for the **classic {{site.data.keyword.assistant_classic_short}}** The {{site.data.keyword.assistant_classic_short}} REST API supports modifying your dialog programmatically, without using the {{site.data.keyword.assistant_classic_short}} tool. You can use the /dialog_nodes API to create, delete, or modify dialog nodes. -Remember that the dialog is a tree of interconnected nodes, and that it must conform to certain rules in order to be valid. This means that any change you make to a dialog node might have cascading effects on other nodes, or on the structure of your dialog. Before using the /dialog_nodes API to modify your dialog, make sure you understand how your changes will affect the rest of the dialog. You can make a backup copy of the current dialog by exporting the conversational skill in which it resides. See [Downloading a skill](/docs/assistant?topic=assistant-skill-tasks#skill-tasks-download) for details. +Remember that the dialog is a tree of interconnected nodes, and that it must conform to certain rules in order to be valid. This means that any change you make to a dialog node might have cascading effects on other nodes, or on the structure of your dialog. Before using the /dialog_nodes API to modify your dialog, make sure you understand how your changes will affect the rest of the dialog. You can make a backup copy of the current dialog by exporting the conversational skill in which it resides. A valid dialog always satisfies the following criteria: diff --git a/api-migration.md b/api-migration.md index 0e015126..b86f7e46 100755 --- a/api-migration.md +++ b/api-migration.md @@ -154,7 +154,7 @@ After you have created an assistant, you can update your client application to u {: codeblock} {: java} - If you do not explicitly delete the session, it will be automatically deleted after the configured timeout interval. (The timeout duration depends on your plan; for more information, see [Session limits](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-session-limits).) + If you do not explicitly delete the session, it will be automatically deleted after the configured timeout interval. To see examples of the v2 APIs in the context of a simple client application, see [Building a client application](/docs/assistant?topic=assistant-api-client). diff --git a/assistant-add.md b/assistant-add.md index 27691bb6..d772113e 100644 --- a/assistant-add.md +++ b/assistant-add.md @@ -45,11 +45,11 @@ Follow these steps to create an assistant: The number of assistants you can create depends on your {{site.data.keyword.assistant_classic_short}} [plan type](https://www.ibm.com/products/watsonx-assistant/pricing){: external}. -After 30 days of inactivity, an unused assistant in a Lite plan service instance might be deleted to free up space. See [Changing the inactivity timeout setting](/docs/assistant?topic=assistant-assistant-settings) for more information on the subject. +After 30 days of inactivity, an unused assistant in a Lite plan service instance might be deleted to free up space. 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](/docs/assistant?topic=assistant-skill-add#skill-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](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-switch-instance). +If you want to create an assistant in a different service instance, you can switch to another service instance. ## Deleting an assistant {: #assistant-add-delete} diff --git a/assistant-language.md b/assistant-language.md index bf77de83..5fe425d4 100644 --- a/assistant-language.md +++ b/assistant-language.md @@ -10,24 +10,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:gif: data-image-type='gif'} -{:video: .video} - -{{site.data.content.newlink}} +{{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 support for global audiences](/docs/watson-assistant?topic=watson-assistant-admin-language-support){: external}. +{: attention} # Adding support for global audiences {: #assistant-language} @@ -70,8 +56,6 @@ To create a skill that uses the universal language model, complete the following 1. Choose to create either a dialog or actions skill, and then click **Next**. - For more information, see [Choosing a conversational skill](/docs/assistant?topic=assistant-skills-choose). - 1. Name your skill, and optionally add a description. From the *Language* field, choose **Another language**. Remember, if the language you want to support is listed individually, choose it instead of using the universal model. The built-in language models provide optimal language support. @@ -87,7 +71,7 @@ To create a skill that uses the universal language model, complete the following Next, start building your conversation. -As you follow the normal steps to design a conversational flow, you teach the universal language model about the language you want your skill to support. It is by adding training data that is written in the target language that the universal model is constructed. For an actions skill, add actions. For a dialog skill, add intents, intent user examples, and entities. The universal language model adapts to understand and support your language of choice. +As you follow the normal steps to design a conversational flow, you teach the universal language model about the language you want your skill to support. It is by adding training data that is written in the target language that the universal model is constructed. The universal language model adapts to understand and support your language of choice. ## Integration considerations {: #assistant-language-integrations} diff --git a/assistant-settings.md b/assistant-settings.md deleted file mode 100644 index 76e0cc55..00000000 --- a/assistant-settings.md +++ /dev/null @@ -1,107 +0,0 @@ ---- - -copyright: - years: 2018, 2021 -lastupdated: "2021-03-19" - -subcollection: assistant - ---- - -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} - -# Working with your assistant -{: #assistant-settings} - -Learn how to find and open assistants and skills that you created or can access. -{: shortdesc} - -Assistants and skills are created within a {{site.data.keyword.assistant_classic_short}} 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 {{site.data.keyword.assistant_classic_short}} user interface. - -1. Go to the [{{site.data.keyword.Bluemix_notm}} Resource list](https://cloud.ibm.com){: external}. - -1. Log in. - - A list of the service instances that you own or were given access to is displayed. - -1. Click a service instance to open it. - -1. Click **Launch {{site.data.keyword.assistant_classic_short}}** from the service instance details page to open the product in a new browser tab or window. - -1. Click the appropriate icon from the navigation pane to see a list of your assistants or skills. - - - ![Assistants menu icon](images/nav-ass-icon.png) Assistants - - ![Skills menu icon](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 -{: #assistant-settings-switch-instance} - -To switch to a different {{site.data.keyword.assistant_classic_short}} service instance, complete the following steps: - -1. From the header of any page in the current instance, click the User icon ![user icon](images/user-icon.png). -1. Choose **Switch instance** from the menu. -1. A list of the available service instances is displayed. Click a different service instance to open it. - -## Getting API information -{: #assistant-settings-api-details} - -Get information, such as the assistant ID and skill ID and credentials that you need before you can use the API. - -- For an assistant, click the overflow menu, and then choose **Settings**. Click **API Details**. -- For a skill, click the overflow menu, and then choose **View API Details**. - - You can find the ID of the workspace that is associated with a dialog skill on the *Skill API Details* page also. It is included in the Legacy v1 workspace URL, after the `/workspaces/` segment. - {: note} - -If you cannot view the API details or service credentials, it is likely that you do not have Manager access to the service instance in which the resource was created. Only people with Manager service access to the instance can use the service credentials. - -If you have a Writer or Reader service access role to the instance and want to use the API, you can create a personal API key. Go to the [IBM Cloud API keys](https://cloud.ibm.com/iam/apikeys){: external} page to create an IBM Cloud API key to use to authenticate your API requests. For more information, see [Managing user API keys](/docs/account?topic=account-userapikey){: external}. With the personal key, you can make API requests that you have the appropriate privileges to complete. For more information about API privileges per access role, see [Resource-level role impact on available actions](/docs/assistant?topic=assistant-access-control#access-control-ui-impact). - -If the assistant ID is not displayed, you can copy it from the URL of the assistant web page. The assistant ID is listed just after `/assistants/{assistantID}`. Similarly, you can get the skill ID from the URL of the skill page. The skill ID is listed just after `/skills/{skillID}`. -{: tip} - -## Changing the inactivity timeout setting -{: #assistant-settings-change-timeout} - -When a user interacts with your assistant through one of the built-in integrations, the chat session ends after a specific period of time passes in which the user does not interact with the assistant. You can specify the amount of time to wait before a chat session is reset by changing the inactivity timeout setting. - -When a chat session is reset, the dialog loses any contextual information that it saved during the previous exchange with the user. For example, if the dialog asks for the user's name and then calls the user by that name throughout the rest of the conversation, then after the chat session ends and a new one begins, the dialog will start by asking for the user's name again. - -To change the timeout, complete the following steps: - -1. Click the menu for your assistant ![open and close list of options](images/kebab.png), and then choose **Settings**. - -1. Change the time specified in the **Timeout limit** field. The choices and maximum timeout vary depending on your plan. - -1. Close the settings page. Your change is saved automatically. - -## Session limits -{: #assistant-settings-session-limits} - -The length allowed for an inactivity timeout differs by service instance plan type. The following table lists the limits. - -| Service plan | Chat session default inactivity period | Chat session maximum inactivity period | -|--------------|--------------------------------:|----------------------------:| -| Enterprise | 1 hour | 168 hours (7 days) | -| Premium (legacy) | 1 hour | 168 hours (7 days) | -| Plus | 1 hour | 24 hours | -| Trial | 5 minutes | 5 minutes | -| Lite | 5 minutes | 5 minutes | -{: caption="Service plan details" caption-side="top"} diff --git a/assistants.md b/assistants.md index 782abd70..36af5713 100644 --- a/assistants.md +++ b/assistants.md @@ -8,22 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} +{{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 [Planning your assistant](/docs/watson-assistant?topic=watson-assistant-plan-assistant){: external}. +{: attention} # Plan your assistant {: #assistants} @@ -68,8 +56,6 @@ Deploy your assistant where customers can find it with ease. For example, you ca While the conversational skill is defined in text, customers can talk with your assistant over the phone when you deploy it by using the phone integration. -For more information about ways to deploy the assistant, see [Adding integrations](/docs/assistant?topic=assistant-deploy-integration-add). - Understanding where you will deploy the assistant before you begin can help you author the right types of answers for a given channel or platform. ## What languages does your assistant speak? @@ -87,16 +73,10 @@ Never misrepresent the assistant as being a human. If users believe the assistan ## Who will build your assistant? {: #assistants-plan-conversation} -Assemble a team with people who understand your customers and their needs, people who know how to interact with customers to reach the best outcomes. These subject matter experts can focus on designing an engaging conversational flow. In fact, the actions skill is designed with this type of expert in mind. The team can simultaneously build a conversational flow by defining discrete actions. +Assemble a team with people who understand your customers and their needs, people who know how to interact with customers to reach the best outcomes. These subject matter experts can focus on designing an engaging conversational flow. If you have data scientists or team members with programming skills, you can take advantage of some advanced capabilities that require varying levels of development expertise. This set of users might prefer to build the conversational flow with a dialog skill because there is greater visibility into the individual components that make up the training data. -So, which conversational skill type *should* you use? - -Use both. Leverage advanced capabilities that are available from a dialog skill and build individual actions to perform finite tasks that you want to support. You can call the actions in your actions skill from your dialog skill. - -For more information, see [Choosing a conversational skill](/docs/assistant?topic=assistant-skills-choose). - ## Do you have existing content to leverage? {: #assistants-plan-search} diff --git a/backup.md b/backup.md index b7f057fd..1764fce8 100644 --- a/backup.md +++ b/backup.md @@ -95,8 +95,6 @@ After you create the skill, it appears as a tile on the Skills page. You can now re-create your assistant. You can then link your uploaded skills to the assistant, and configure integrations for it. -See [Creating an assistant](/docs/assistant?topic=assistant-assistant-add) and [Adding integrations](/docs/assistant?topic=assistant-deploy-integration-add#deploy-integration-add-task) for more details. - ## Update your client applications {: #backup-update-api} diff --git a/deploy-facebook.md b/deploy-facebook.md index 9b07c183..8979937b 100644 --- a/deploy-facebook.md +++ b/deploy-facebook.md @@ -9,22 +9,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} +{{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 [Integrating with Facebook Messenger](/docs/watson-assistant?topic=watson-assistant-deploy-facebook){: external}. +{: attention} # Integrating with Facebook Messenger {: #deploy-facebook} diff --git a/deploy-integration-add.md b/deploy-integration-add.md deleted file mode 100644 index 40167762..00000000 --- a/deploy-integration-add.md +++ /dev/null @@ -1,105 +0,0 @@ ---- - -copyright: - years: 2015, 2023 -lastupdated: "2023-02-20" - -keywords: deploy, deploying - -subcollection: assistant - ---- - -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} - -# Adding integrations -{: #deploy-integration-add} - -To deploy your skill, add it to an assistant, and then add integrations to the assistant that publish your bot to the channels where your customers go for help. -{: shortdesc} - -## Add an integration -{: #deploy-integration-add-task} - -Follow these steps to add integrations to your assistant: - -1. Click the **Assistants** icon ![Assistants menu icon](images/nav-ass-icon.png). - -1. Click to open the tile for the assistant that you want to deploy. - -1. Go to the Integrations section. - - **Why do I have the *Web chat* integration?** This integration is provisioned and added automatically to your first assistant only. - - The web chat is a chat window that you can embed in one or more pages on your website to share your assistant with your customers. - -1. Click **Add integration**. - -1. Click the tile for the channel with which you want to integrate the assistant. The options include: - - - [Web chat](/docs/assistant?topic=assistant-deploy-web-chat) - - [Facebook Messenger](/docs/assistant?topic=assistant-deploy-facebook) - - [Slack](/docs/assistant?topic=assistant-deploy-slack) - - [Phone](/docs/assistant?topic=assistant-deploy-phone) - - [SMS with Twilio](/docs/assistant?topic=assistant-deploy-sms) - - [WhatsApp with Twilio](/docs/assistant?topic=assistant-deploy-whatsapp) - - [Custom application](/docs/assistant?topic=assistant-deploy-custom-app) - - Built-in service desk integrations: - - - [Intercom](/docs/assistant?topic=assistant-deploy-intercom) - - [Web chat with Salesforce support](/docs/assistant?topic=assistant-deploy-salesforce) - - [Web chat with Zendesk support](/docs/assistant?topic=assistant-deploy-zendesk) - - Web chat service desk reference implementations: - - - [Genesys Cloud](https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/genesys/webChat){: external} - - [NICE inContact](https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/incontact/webChat){: external} - - [Twilio Flex](https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/flex/webChat){: external} - - [Bring your own (starter kit)](https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter){: external} - -1. Follow the instructions that are provided on the screen to complete the integration process. - -After you integrate the assistant, test it from the target channel to ensure that the assistant works as expected. - -![Plus or higher plans only](images/plus.png) For environments where private endpoints are in use, keep in mind that these integrations send traffic over the internet. For more information, see [Private network endpoints](https://cloud.ibm.com/docs/assistant?topic=assistant-security#security-private-endpoints). -{: note} - -## How service desk platform integrations work -{: #deploy-integration-service-desk-integrations} - -Watch a 4-minute video about integrating your assistant with a live agent integration, such as Zendesk: - -![Zendesk Integration: {{site.data.keyword.assistant_classic_short}}](https://video.ibm.com/embed/channel/23952663/video/wa-zendesk){: video output="iframe" data-script="none" id="watsonmediaplayer" width="480" height="270" scrolling="no" allowfullscreen webkitallowfullscreen mozAllowFullScreen frameborder="0" style="border: 0 none transparent;"} - -To learn about how service desk integrations with your assistant can benefit your business, [read this blog post](https://medium.com/ibm-watson/contact-center-post-394dff427c8){: external}. - -## Integration limits -{: #deploy-integration-add-limits} - -The number of integrations you can create in a single service instance depends on your {{site.data.keyword.assistant_classic_short}} plan. - -| Service plan | Integrations per assistant | -|------------------|---------------------------:| -| Enterprise | 100 | -| Premium (legacy) | 100 | -| Plus | 100 | -| Trial | 100 | -| Lite | 100 | -{: caption="Service plan details" caption-side="top"} diff --git a/deploy-phone-flex.md b/deploy-phone-flex.md index 5fc3b304..356b0720 100644 --- a/deploy-phone-flex.md +++ b/deploy-phone-flex.md @@ -8,24 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:preview: .preview} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} +{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 [Integrating with phone and Twilio Flex](/docs/watson-assistant?topic=watson-assistant-deploy-phone-flex){: external}. +{: attention} # Integrating with phone and Twilio Flex {: #deploy-phone-flex} diff --git a/deploy-phone.md b/deploy-phone.md index d6afd6a6..41cbffec 100644 --- a/deploy-phone.md +++ b/deploy-phone.md @@ -9,22 +9,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} +{{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 [Integrating with phone](/docs/watson-assistant?topic=watson-assistant-deploy-phone){: external}. +{: attention} # Integrating with phone ![Plus or higher plans only](images/plus.png) {: #deploy-phone} diff --git a/deploy-salesforce.md b/deploy-salesforce.md index acfb8f2b..b374f1fc 100644 --- a/deploy-salesforce.md +++ b/deploy-salesforce.md @@ -8,24 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:preview: .preview} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} +{{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 [Integrating with Salesforce](/docs/watson-assistant?topic=watson-assistant-deploy-salesforce){: external}. +{: attention} # Integrating with Salesforce {: #deploy-salesforce} diff --git a/deploy-slack.md b/deploy-slack.md index 11d3f9e1..e6a1a38a 100644 --- a/deploy-slack.md +++ b/deploy-slack.md @@ -8,22 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} +{{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 [Integrating with Slack](/docs/watson-assistant?topic=watson-assistant-deploy-slack){: external}. +{: attention} # Integrating with Slack {: #deploy-slack} diff --git a/deploy-sms.md b/deploy-sms.md index 9dc994f5..9a5715e8 100644 --- a/deploy-sms.md +++ b/deploy-sms.md @@ -8,22 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} +{{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 [Integrating with SMS](/docs/watson-assistant?topic=watson-assistant-deploy-sms){: external}. +{: attention} # Integrating with *SMS with Twilio* {: #deploy-sms} diff --git a/deploy-web-chat.md b/deploy-web-chat.md index 6612e789..d6727aca 100644 --- a/deploy-web-chat.md +++ b/deploy-web-chat.md @@ -8,24 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:preview: .preview} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} +{{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 [Web chat overview](/docs/watson-assistant?topic=watson-assistant-web-chat-overview){: external}. +{: attention} # Adding the web chat to your website {: #deploy-web-chat} diff --git a/deploy-web-link.md b/deploy-web-link.md deleted file mode 100644 index df09edd4..00000000 --- a/deploy-web-link.md +++ /dev/null @@ -1,80 +0,0 @@ ---- - -copyright: - years: 2015, 2021 -lastupdated: "2022-04-28" - -subcollection: assistant - ---- - -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} - -# Testing your assistant -{: #deploy-web-link} - -Use the assistant preview to test your assistant. -{: shortdesc} - -The assistant preview renders your assistant as a web chat embedded in a preview web page. You can test the skills that you added to the assistant by entering text into the chat window. You can copy and paste the web page URL into a web browser and share the page with others to enlist help in testing and getting feedback about the assistant. - -Unlike when you test a skill using the "Try it out" pane, any API calls that result from your interactions with the assistant hosted by the assistant preview might incur charges. - -## Using the assistant preview to test your assistant -{: #deploy-web-link-try} - -To test the assistant from a web-hosted chat widget, complete the following steps: - -1. From the Assistants page, click to open the assistant tile that you want to test. - -1. Click **Preview**. - - ![Preview button](images/preview-button.png) - - ![Plus or higher plans only](images/plus.png) For environments where private endpoints are in use, keep in mind that the preview sends traffic over the internet. For more information, see [Private network endpoints](/docs/assistant?topic=assistant-security#security-private-endpoints). - {: note} - -1. In the "Assistant preview" pane, submit test utterances to see how the assistant responds. - - If the *Connect to agent* response is displayed, it means you do not have a conversational skill added to your assistant. You must add one before you can chat with the assistant. - {: important} - -1. You can click the **Restart conversation** button to start a conversation over. - - This action is useful if you want to test different routes through a single conversational flow. Or if you set or change context variable values in a dialog skill and want to see how specifying different values affects the conversation. - - The conversation is restarted after the assistant's inactivity period elapses. The inactivity period can range from 5 minutes to 7 days depending on what you configure for your service plan type. After the intactivity time frame passes, any context variable values that were set during the conversation are set to null or back to their default values. For more information, see [Changing the inactivity timeout setting](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-change-timeout). - -1. To test the assistant from a separate web page, copy and paste the *Share this link* URL into a web browser. - - A simple IBM-branded web page is displayed that contains a chat window where you can interact with your assistant. You can share the page with others by sending them the *Share this link* URL. If necessary, you can click the toggle on the Preview page to disable the link. - - Previewing your assistant within the {{site.data.keyword.assistant_classic_short}} user interface does not incur any charges. If you use the *Share this link* URL to preview the assistant from elsewhere, you might be charged for messages that you submit, according to the terms of your plan. You can review metrics about the test user conversations from the Analytics page. - {: important} - -1. Click **X** to close the Preview page. - -## Dialog considerations -{: #deploy-web-link-dialog} - -The rich responses that you add to a dialog are displayed in the web-hosted chat widget as expected, with the following exceptions: - -- **Connect to human agent**: This response type is ignored. - -- **Pause**: This response type pauses the assistant's activity in the chat widget. However, activity does not resume after the pause until another response is triggered. Whenever you include a `pause` response type, add another, different response type, such as `text`, after it. - -See [Rich responses](/docs/assistant?topic=assistant-dialog-overview#dialog-overview-multimedia) for more information about response types. diff --git a/deploy-whatsapp.md b/deploy-whatsapp.md index 4844082b..623e8811 100644 --- a/deploy-whatsapp.md +++ b/deploy-whatsapp.md @@ -10,7 +10,7 @@ subcollection: 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 [Integrating with WhatsApp](/docs/watson-assistant?topic=watson-assistant-deploy-whatsapp){: external}. To see all documentation for the new {{site.data.keassistant_classic_shortnshort}}, please go [here](https://cloud.ibm.com/docs/watson-assistant){: external}. +Documentation for the **classic {{site.data.keyword.assistant_classic_short}}** experience has moved. For the most up-to-date version, see [Integrating with WhatsApp](/docs/watson-assistant?topic=watson-assistant-deploy-whatsapp){: external}. {: attention} # Integrating with WhatsApp diff --git a/deploy-zendesk.md b/deploy-zendesk.md index efe2b47d..326524f9 100644 --- a/deploy-zendesk.md +++ b/deploy-zendesk.md @@ -8,24 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:preview: .preview} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} +{{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 [Integrating with Zendesk](/docs/watson-assistant?topic=watson-assistant-deploy-zendesk){: external}. +{: attention} # Integrating with Zendesk {: #deploy-zendesk} diff --git a/dialog-call-action.md b/dialog-call-action.md index e24a5973..e3a2a77e 100644 --- a/dialog-call-action.md +++ b/dialog-call-action.md @@ -117,7 +117,7 @@ To take an action that is defined in an actions skill, complete the following st 1. Click **X** to close the dialog node. Your changes are saved automatically. -Test the interaction between the skills. You cannot test from the "Try it out" pane of the dialog skill, nor from the Preview pane of the action skill. You must use the *Preview* button for the assistant. For more information, see [Testing your assistant from a web page](/docs/assistant?topic=assistant-deploy-web-link). +Test the interaction between the skills. You cannot test from the "Try it out" pane of the dialog skill, nor from the Preview pane of the action skill. You must use the *Preview* button for the assistant. ## When to call an action from a dialog skill {: dialog-call-action-when} diff --git a/dialog-integrations.md b/dialog-integrations.md index 902fae5b..576a5641 100644 --- a/dialog-integrations.md +++ b/dialog-integrations.md @@ -93,7 +93,6 @@ The rich response types often behave differently when they are displayed in diff - [SMS with Twilio](/docs/assistant?topic=assistant-deploy-sms#deploy-sms-dialog) -- [Assistant preview](/docs/assistant?topic=assistant-deploy-web-link#deploy-web-link-dialog) If you need to provide customized responses for different channels, and you do not need to modify your dialog flow based on which integration is in use, you can also use the `channels` array to target your responses to specific integrations. For more information, see [Targeting specific integrations](/docs/assistant?topic=assistant-dialog-responses-json#dialog-responses-json-target-integrations). {: note} diff --git a/dialog-overview.md b/dialog-overview.md index ac437711..84b0bd4f 100644 --- a/dialog-overview.md +++ b/dialog-overview.md @@ -786,7 +786,7 @@ To add a *Pause* response type, complete the following steps: Add another response type, such as a text response type, after the pause to clearly denote that the pause is over. {: tip} -This response type does not render in the "Try it out" pane. You must access a node that uses this response type from a test deployment to see how your users will experience it. For more information, see [Testing your assistant from a web page](/docs/assistant?topic=assistant-deploy-web-link). +This response type does not render in the "Try it out" pane. You must access a node that uses this response type from a test deployment to see how your users will experience it. ### Adding a *Search skill* response type ![Plus or higher plan only](images/plus.png) {: #dialog-overview-add-search-skill} @@ -847,7 +847,7 @@ To add a *Search skill* response type, complete the following steps: ``` {: codeblock} -Test this response type from the assistant *Preview*. You cannot test it from the dialog skill's "Try it out" pane. For more information about testing dialog and search skills together, see [Testing your assistant from a web page](/docs/assistant?topic=assistant-deploy-web-link). +Test this response type from the assistant *Preview*. You cannot test it from the dialog skill's "Try it out" pane. ### Conditional responses {: #dialog-overview-multiple} diff --git a/dialog-runtime.md b/dialog-runtime.md index daa7a9c4..b703a0b9 100644 --- a/dialog-runtime.md +++ b/dialog-runtime.md @@ -54,8 +54,6 @@ Learn more - [Handling none of the above](#dialog-runtime-handle-none) - [Testing disambiguation](#dialog-runtime-disambig-test) -For information about how disambiguation works with actions skills, see [Disambiguation](/docs/assistant?topic=assistant-actions#actions-disambiguation). - ### Disambiguation example {: #dialog-runtime-disambig-example} diff --git a/dialog-tasks.md b/dialog-tasks.md index e4d4f281..8827bc3e 100644 --- a/dialog-tasks.md +++ b/dialog-tasks.md @@ -86,8 +86,6 @@ Make changes to the dialog to address issues you see when testing: - If you determine that the wrong intents or entities are being recognized, you might need to modify your intent or entity definitions. - If the correct intents and entities are being recognized, but the wrong nodes are being triggered in your dialog, make sure your conditions are written properly. -If you are ready to put the conversation to work helping your users, integrate your assistant with a messaging platform or custom application. See [Adding integrations](/docs/assistant?topic=assistant-deploy-integration-add). - ## Searching your dialog {: #dialog-tasks-search} diff --git a/dialog-tips.md b/dialog-tips.md index 06505568..c104b3c1 100644 --- a/dialog-tips.md +++ b/dialog-tips.md @@ -45,7 +45,7 @@ Get tips about ways to address common tasks. - Avoid overusing buttons. Encouraging users to pick predefined options from a set of buttons is less like a real conversation, and decreases your ability to learn what users really want to do. When you let real users ask for things in their own words, you can use the input to train the system and derive better intents. - Avoid using a bunch of nodes when one node will do. For example, add multiple conditional responses to a single node to return different responses depending on details provided by the user. See [Conditional responses](/docs/assistant?topic=assistant-dialog-overview#dialog-overview-multiple). - Word your responses carefully. You can change how someone reacts to your system based simply on how you phrase a response. Changing one line of text can prevent you from having to write multiple lines of code to implement a complex programmatic solution. -- Back up your skill frequently. See [Downloading a skill](/docs/assistant?topic=assistant-skill-tasks#skill-tasks-download). +- Back up your skill frequently. ## Tips for capturing information from user input {: #dialog-tips-user-input} diff --git a/faqs.md b/faqs.md index 76c6cbb3..1fe5a142 100644 --- a/faqs.md +++ b/faqs.md @@ -12,7 +12,7 @@ content-type: faq {{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 [FAQs for {{site.data.keyword.conversationfull}}](/docs/watson-assistant?topic=watson-assistant-watson-assistant-faqs) and [Glossary](/docs/watson-assistant?topic=watson-assistant-glossary){: external}. +Documentation for the **classic {{site.data.keyword.assistant_classic_short}}** experience has moved. For the most up-to-date version, see [FAQs for {{site.data.keyword.conversationfull}}](/docs/watson-assistant?topic=watson-assistant-watson-assistant-faqs){: external} and [Glossary](/docs/watson-assistant?topic=watson-assistant-glossary){: external}. {: attention} # FAQ @@ -27,7 +27,6 @@ Find answers to frequently-asked questions and quick fixes for common problems. | Term | Definition | |------|------------| -| Action | An action that you add to an actions skill represents a discrete task or question that your assistant is designed to help customers with. [Learn more](/docs/assistant?topic=assistant-actions-overview#actions-overview-actions). | | Assistant | Container for your skills. You add skills to an assistant, and then deploy the assistant when you are ready to start helping your customers. [Learn more](/docs/assistant?topic=assistant-assistants). | | Condition | Logic that is defined in the *If assistant recognizes* section of a dialog node that determines whether the node is processed. The dialog node conditions is equivalent to an If statement in If-Then-Else programming logic. | Content catalog | A set of prebuilt intents that are categorized by subject, such as customer care. You can add these intents to your skill and start using them immediately. Or you can edit them to complement other intents that you create. [Learn more](/docs/assistant?topic=assistant-catalog). | @@ -36,19 +35,19 @@ Find answers to frequently-asked questions and quick fixes for common problems. | Digression | A feature that gives the user the power to direct the conversation. It prevents customers from getting stuck in a dialog thread; they can switch topics whenever they choose. [Learn more](/docs/assistant?topic=assistant-dialog-runtime#dialog-runtime-digressions). | | Disambiguation | A feature that enables the assistant to ask customers to clarify their meaning when the assistant isn't sure what a user wants to do next. [Learn more](/docs/assistant?topic=assistant-dialog-runtime#dialog-runtime-disambiguation). | | Entity | Information in the user input that is related to the user's purpose. An intent represents the action a user wants to do. An entity represents the object of that action. [Learn more](/docs/assistant?topic=assistant-entities). | -| Integrations | Ways you can deploy your assistant to existing platforms or social media channels. [Learn more](/docs/assistant?topic=assistant-deploy-integration-add). | +| Integrations | Ways you can deploy your assistant to existing platforms or social media channels. | | Intent | The goal that is expressed in the user input, such as answering a question or processing a bill payment. [Learn more](/docs/assistant?topic=assistant-intents). | | Message | A single turn within a conversation that includes a single call to the `/message` API endpoint and its corresponding response. | | Monthly active user (MAU) | A single unique user who interacts with an assistant one or many times in a given month. | -| Preview | Embeds your assistant in a chat window that is displayed on an IBM-branded web page. From the preview, you can test how a conversation flows through any and all skills that are attached to your assistant, from end to end. [Learn more](/docs/assistant?topic=assistant-deploy-web-link). | +| Preview | Embeds your assistant in a chat window that is displayed on an IBM-branded web page. From the preview, you can test how a conversation flows through any and all skills that are attached to your assistant, from end to end. | | Response | Logic that is defined in the *Assistant responds* section of a dialog node that determines how the assistant responds to the user. When the node's condition evaluates to true, the response is processed. The response can consist of an answer, a follow-up question, a webhook that sends a programmatic request to an external service, or slots which represent pieces of information that you need the user to provide before the assistant can help. The dialog node response is equivalent to a Then statement in If-Then-Else programming logic. | -| Skill | Does the work of the assistant. A dialog skill has the training data and dialog that your assistant uses to chat with customers. An actions skill is a new way to build a conversation. Actions offer step-by-step flows for a conversations and are made so that anybody can build them. A search skill is configured to search the appropriate external data sources for answers to customer questions. [Learn more](/docs/assistant?topic=assistant-skill-add). | +| Skill | Does the work of the assistant. A dialog skill has the training data and dialog that your assistant uses to chat with customers. A search skill is configured to search the appropriate external data sources for answers to customer questions. [Learn more](/docs/assistant?topic=assistant-skill-add). | | Skill version | Versions are snapshots of a skill that you can create at key points during the development lifecycle. You can deploy one version to production, while you continue to make and test improvements that you make to another version of the skill. [Learn more](/docs/assistant?topic=assistant-versions). | | Slots | A special set of fields that you can add to a dialog node that enable the assistant to collect necessary pieces of information from the customer. For example, the assistant can require a customer to provide valid date and location details before it gets weather forecast information on the customer's behalf. [Learn more](/docs/assistant?topic=assistant-dialog-slots). | | Step | A step that you add to an action represents a single interaction or exchange of information with a customer, a turn in the conversation. [Learn more](/docs/assistant?topic=assistant-actions-overview#actions-overview-steps). | | System entity | Prebuilt entities that recognize references to common things like dates and numbers. You can add these to your skill and start using them immediately. [Learn more](/docs/assistant?topic=assistant-system-entities). | | Try it out | A chat window that you use to test as you build. For example, from the dialog skill's "Try it out" pane, you can mimic the behavior of a customer and enter a query to see how the assistant responds. You can test only the current skill; you cannot test your assistant and all attached skills from end to end. [Learn more](/docs/assistant?topic=assistant-dialog-tasks). | -| Variable | A variable is data that a customer shares with the assistant, which is collected and saved so it can be referenced later. In an actions skill, you can collect *action* and *session* variables. [Learn more](/docs/assistant?topic=assistant-actions-overview#actions-overview-step-variables). | +| Variable | A variable is data that a customer shares with the assistant, which is collected and saved so it can be referenced later. [Learn more](/docs/assistant?topic=assistant-actions-overview#actions-overview-step-variables). | | Web chat | An integration that you can use to embed your assistant in your company website. [Learn more](/docs/assistant?topic=assistant-deploy-web-chat). | | Webhook | A mechanism for calling out to an external program during a conversation. For example, your assistant can call an external service to translate a string from English to French and back again in the course of the conversation. [Learn more](/docs/assistant?topic=assistant-webhook-overview). | @@ -112,7 +111,7 @@ To view the Analytics page, you must have a service role of Manager and a platfo {: #faqs-view-api-details} {: faq} -If you cannot view the API details or service credentials, it is likely that you do not have Manager access to the service instance in which the resource was created. Only people with Manager service access to the instance can use the service credentials. For more information, see [Getting API information](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-api-details). +If you cannot view the API details or service credentials, it is likely that you do not have Manager access to the service instance in which the resource was created. Only people with Manager service access to the instance can use the service credentials. ## I can't edit intents, entities, or dialog nodes {: #faqs-edit-skill} diff --git a/gs-actions.md b/gs-actions.md deleted file mode 100644 index d56b3bed..00000000 --- a/gs-actions.md +++ /dev/null @@ -1,189 +0,0 @@ ---- - -copyright: - years: 2015, 2022 -lastupdated: "2022-04-01" - -subcollection: assistant -content-type: tutorial -account-plan: lite -completion-time: 10m - ---- - -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:hide-dashboard: .hide-dashboard} -{:download: .download} -{:video: .video} -{:step: data-tutorial-type='step'} - -{{site.data.content.newlink}} - -# Getting started with an actions skill -{: #gs-actions} -{: toc-content-type="tutorial"} -{: toc-completion-time="10m"} - -In this short tutorial, we help you use an actions skill to build your first conversation. -{: shortdesc} - -An *actions skill* contains actions that represent the tasks you want your assistant to help your customers with. - -## Add an action -{: #gs-actions-add-action-hello} -{: step} - -Each *action* contains a series of *steps* that represent individual exchanges with a customer. In the first action step, you define the user goal that the action will satisfy. - -1. Click **Create a new action**. - -1. We are going to keep it simple and just exchange greetings with the customer. - - To recognize when a customer is just saying hello, add some examples of ways in which a person might do so. - - Add the following examples: - - - `Hi` - - `Hello` - - `Good morning.` - - `Good afternoon!` - - `Good evening` - - `Howdy!` - - `Yo, what's up?` - -1. Notice that the action has been given a name automatically. Our first example was used to name the skill `Hi`. Let's change it. - - In the field at the start of the page, change `Hi` to `Hello`. - -1. Click **Save** to save your action. - -## Add a step -{: #gs-actions-add-step-hello} -{: step} - -In the step you add, you'll define the greeting that your assistant will return to the customer. - -1. In the navigation pane, click **New step**. - -1. In the **Assistant says** field, enter `Good day to you!` - - Because we want to end the exchange of greetings there, let's end the action without adding any more steps. -1. In the **And then** field, choose *End the action*. - -1. Click **Save**. - -Congratulations! You created a simple turn in a conversation. Now, let's see if it works. - -## Test the action -{: #gs-actions-test-say-hello} -{: step} - -You test the action by entering a salutation into the "Preview" pane, which simulates what the customer's experience would be if they were interacting with the assistant. - -1. In the text field of the "Preview" pane, type `hello there`, and then submit it. - - You are submitting a greeting that doesn't exactly match any of the training examples you added earlier. However, the examples you provided should have taught your assistant to understand what a typical greeting looks like. - - The assistant responds with `Good day to you!` The preview also identifies the action that was recognized, by returning *Hello*. - -You did it! - -Next, we'll add an action that understands when a customer says goodbye. - -## Add a goodbye action -{: #gs-actions-add-action-goodbye} -{: step} - -Let's make sure your assistant is able to say goodbye to your customers when appropriate. We will add a new action that can understand customer messages that aim to end the conversation. - -1. Click **Close** to exit the *Say hello* action that you created successfully. - - You are returned to a page where you can see your new *Hello* action listed in an Actions table. - -1. Minimize the "Preview" panel, and then click **New action**. - -1. Add examples of phrases that customers might use to indicate that they want to end the conversation. - - Add the following examples: - - - `Goodbye` - - `I'm all set now.` - - `Thanks.` - - `Have a good day` - - `Thank you for your help` - - `I'm done.` - - `Bye` - -This time, the action is named `Goodbye`, which is a good name, so we won't bother changing it. - -## Add the assistant's farewell -{: #gs-actions-add-step-goodbye} -{: step} - -1. In the navigation pane, click **New step**. - -1. In the **Assistant says** field, enter `Farewell!` - - Again, let's end the action without adding any more steps. -1. In the **And then** field, choose *End the action*. - -1. Click **Save**. - -## Test the farewell action -{: #gs-actions-test-say-goodbye} -{: step} - -Let's make sure the action is able to recognize when a customer wants to end the conversation. - -1. Click **Preview** to open the "Preview" panel. - -1. Click the refresh icon ![Refresh icon](images/preview-refresh-icon.png) to restart the conversation. - -1. In the text field, type `I'm finished`, and then submit it. - - The assistant responds with `Farewell!` and indicates that it recognized the *Goodbye* action. - -1. Click **Close**. - -You have successfully created two actions that understand two different customer intentions and can respond to them properly. - -## Preview the assistant -{: #gs-actions-integrate-assistant} -{: step} - -Now that you have an actions skill that can maintain a simple conversational exchange, let's see how it works in the assistant. - -1. Click the **Assistants** icon ![Assistants menu icon](images/nav-ass-icon.png) to open a list of your assistants. -1. Find the *My first assistant* assistant, and open it. -1. Click **Preview** to open the Preview page, which shows your assistant embedded in a simple IBM-hosted web page. - - You can also use the URL displayed under **Share this link** to preview the assistant from another browser window or another computer. Previewing the assistant using this URL might incur charges, depending on your service plan. For more information, see [Testing your assistant](/docs/assistant?topic=assistant-deploy-web-link). - {: note} - -1. In the "Assistant preview" pane, type `hello` into the text field. Press Enter, and watch your assistant respond. - - ![The widget in the assistant preview, showing a single dialog exchange.](images/gs-test-from-preview-link.png) - - You can share the URL with others who might want to try out your assistant. - -1. After testing, click the **X** to close the Preview page. - -## Next steps -{: #gs-actions-next-steps} - -This tutorial is built around a simple example. For a real application, you need to define some more complex exchanges. When you have a polished version of the assistant, you can integrate it with web sites or channels, such as Slack, that your customers already use. As traffic increases between the assistant and your customers, you can use the tools that are provided in the **Analytics** page to analyze real conversations, and identify areas for improvement. - -- Check out more [sample apps](/docs/assistant?topic=assistant-sample-apps) to get ideas. diff --git a/index.md b/index.md index 30a96306..9541bd4a 100644 --- a/index.md +++ b/index.md @@ -10,22 +10,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} +{{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 [About {{site.data.keyword.conversationshort}}](/docs/watson-assistant?topic=watson-assistant-about){: external}. +{: attention} # About {{site.data.keyword.assistant_classic_short}} {: #index} @@ -74,12 +62,6 @@ To see how {{site.data.keyword.assistant_classic_short}} is helping enterprises This documentation describes managed instances of {{site.data.keyword.assistant_classic_short}} that are offered in IBM Cloud or in Cloud Pak for Data as a Service. If you are interested in on-premises or installed deployments, see [this documentation](/docs/assistant-data?topic=assistant-data-index). {: note} -Read more about these implementation steps by following these links: - -- [Creating an assistant](/docs/assistant?topic=assistant-assistant-add) -- [Adding skills to your assistant](/docs/assistant?topic=assistant-skill-add) -- [Deploying your assistant](/docs/assistant?topic=assistant-deploy-integration-add) - ## Browser support {: #index-browser-support} diff --git a/language-support.md b/language-support.md index 6b716c1d..e7e8e6f4 100755 --- a/language-support.md +++ b/language-support.md @@ -55,22 +55,22 @@ In the following tables, the level of language and feature support is indicated ### Skill support details {: #language-support-skills} -| Language | [**Actions skill**](/docs/assistant?topic=assistant-skill-actions-add) | [**Dialog skill**](/docs/assistant?topic=assistant-skill-dialog-add) | [**Search skill**](/docs/assistant?topic=assistant-skill-search-add) | +| Language | [**Dialog skill**](/docs/assistant?topic=assistant-skill-dialog-add) | [**Search skill**](/docs/assistant?topic=assistant-skill-search-add) | |:---|:---:|:---:|:---:| -| **English (en)** | GA | GA | GA | -| **Arabic (ar)** | GA | GA | GA | -| **Chinese (Simplified) (zh-cn)** | GA | GA | GA | -| **Chinese (Traditional) (zh-tw)** | GA | GA | GA | -| **Czech (cs)** | GA | GA | GA | -| **Dutch (nl)** | GA | GA | GA | -| **French (fr)** | GA | GA | GA | -| **German (de)** | GA | GA | GA | -| **Italian (it)** | GA | GA | GA | -| **Japanese (ja)** | GA | GA | GA | -| **Korean (ko)** | GA | GA | GA | -| **Portuguese (Brazilian) (pt-br)** | GA | GA | GA | -| **Spanish (es)** | GA | GA | GA | -| **Universal (xx)** | GA | GA | GA | +| **English (en)** | GA | GA | +| **Arabic (ar)** | GA | GA | +| **Chinese (Simplified) (zh-cn)** | GA | GA | +| **Chinese (Traditional) (zh-tw)** | GA | GA | +| **Czech (cs)** | GA | GA | +| **Dutch (nl)** | GA | GA | +| **French (fr)** | GA | GA | +| **German (de)** | GA | GA | +| **Italian (it)** | GA | GA | +| **Japanese (ja)** | GA | GA | +| **Korean (ko)** | GA | GA | +| **Portuguese (Brazilian) (pt-br)** | GA | GA | +| **Spanish (es)** | GA | GA | +| **Universal (xx)** | GA | GA | {: caption="Table 2. Skill support details" caption-side="bottom"} ### Intent feature support details diff --git a/release-notes.md b/release-notes.md index d6325834..8c3831a3 100644 --- a/release-notes.md +++ b/release-notes.md @@ -219,7 +219,7 @@ Enhanced intent detection available for Portuguese, German, and Simplified Chine {: release-note} Assistant preview link can be disabled -: Assistant preview now includes a toggle to disable the preview link. This allows you to stop access to the preview link if necessary. For more information, see [Using the assistant preview to test your assistant](/docs/assistant?topic=assistant-deploy-web-link#deploy-web-link-try). +: Assistant preview now includes a toggle to disable the preview link. This allows you to stop access to the preview link if necessary. ## 5 April 2022 {: #assistant-apr052022} @@ -821,7 +821,7 @@ The *Phone* and *SMS with Twilio* integrations are now generally available! - [Integrating with *SMS with Twilio*](/docs/assistant?topic=assistant-deploy-sms) *Preview link* change -: When you create a preview link, you can now test your skill from a chat window that is embedded in the page. You can also copy the URL that is provided, and open it in a web browser to see an IBM-branded web page with the web chat embedded in it. You can share the URL to the public IBM web page with others to get help with testing or for demoing purposes. For more information, see [Testing your assistant](/docs/assistant?topic=assistant-deploy-web-link). +: When you create a preview link, you can now test your skill from a chat window that is embedded in the page. You can also copy the URL that is provided, and open it in a web browser to see an IBM-branded web page with the web chat embedded in it. You can share the URL to the public IBM web page with others to get help with testing or for demoing purposes. Import and export UI changes : The label on buttons for importing skills changed from *Import* to *Upload*, and the label on buttons for exporting skills changed from *Export* to *Download*. @@ -1055,7 +1055,7 @@ The @sys-location and @sys-person system entities were removed Skill menu actions moved : The menu that was displayed in the header of the skill while you were working with a skill was removed. The actions that were available from the menu, such as import and export, are still available. Go to the Skills page, and click the menu on the skill tile. - The import skill process was updated to support overwriting an existing skill on import. For more information, see [Overwriting a skill](/docs/assistant?topic=assistant-skill-tasks#skill-tasks-overwrite). + The import skill process was updated to support overwriting an existing skill on import. Dialog issues were addressed : These dialog issues were addressed: @@ -1198,7 +1198,7 @@ New and improved access control Can't see Analytics anymore? If you cannot do things that you could do before, you might not have appropriate access. Ask the service instance owner to change your service access role. For more information, see [How to keep your access](/docs/assistant?topic=assistant-access-control#access-control-prep). - If you can't access the API Details for a skill or assistant anymore, you might not have the access role that is required to use the instance-level API credentials. You can use a personal API key instead. For more information, see [Getting API information](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-api-details). + If you can't access the API Details for a skill or assistant anymore, you might not have the access role that is required to use the instance-level API credentials. You can use a personal API key instead. ## 1 April 2020 {: #assistant-apr012020} @@ -1487,9 +1487,6 @@ UI changes Rich response types are supported in a dialog node with slots : You can display a list of options for a user to choose from as the prompt for a slot, for example. -Change to switching service instances -: Where you go to switch service instances has changed. See [Switching the service instance](/docs/assistant?topic=assistant-assistant-settings#assistant-settings-switch-instance). - Known issue: Cannot rename search skills : You currently cannot rename a search skill after you create it. @@ -1516,7 +1513,7 @@ Dallas updates {: release-note} Inactivity timeout increase -: The maximum inactivity timeout can now be extended to up to 7 days for Premium plans. See [Changing the inactivity timeout setting](/docs/assistant?topic=assistant-assistant-settings). +: The maximum inactivity timeout can now be extended to up to 7 days for Premium plans. Pattern entity fix : A change that was introduced in the previous release which changed all alphabetic characters to lowercase at the time an entity value was added has been fixed. The case of any alphabetic characters that are part of a pattern entity value are no longer changed when the value is added. @@ -1829,7 +1826,7 @@ Major user interface revision - **Assistants**: You can now publish your skill in just two steps. Add your skill to an assistant, and then set up one or more integrations with which to deploy your skill. The assistant adds a layer of function to your skill that enables {{site.data.keyword.assistant_classic_short}} to orchestrate and manage the flow of information for you. See [Assistants](/docs/assistant?topic=assistant-assistants). - - **Built-in integrations**: Instead of going to the **Deploy** tab to deploy your workspace, you add your dialog skill to an assistant, and add integrations to the assistant through which the skill is made available to your users. You do not need to build a custom front-end application and manage the conversation state from one call to the next. However, you can still do so if you want to. See [Adding integrations](/docs/assistant?topic=assistant-deploy-integration-add) for more information. + - **Built-in integrations**: Instead of going to the **Deploy** tab to deploy your workspace, you add your dialog skill to an assistant, and add integrations to the assistant through which the skill is made available to your users. You do not need to build a custom front-end application and manage the conversation state from one call to the next. However, you can still do so if you want to. - **New major API version**: A V2 version of the API is available. This version provides access to methods you can use to interact with an assistant at run time. No more passing context with each API call; the session state is managed for you as part of the assistant layer. diff --git a/skill-tasks.md b/skill-tasks.md deleted file mode 100644 index b3b66fb6..00000000 --- a/skill-tasks.md +++ /dev/null @@ -1,124 +0,0 @@ ---- - -copyright: - years: 2018, 2021 -lastupdated: "2022-04-29" - -subcollection: assistant - ---- - -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} - -{{site.data.content.newlink}} - -# Working with skills -{: #skill-tasks} - -Perform common tasks, such as renaming or deleting a skill. -{: shortdesc} - -## Renaming a skill -{: #skill-tasks-rename} - -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. - -1. Click the ![open and close list of options](images/kebab.png) icon, and then choose **Rename**. - -1. Edit the name, and then click **Save**. - -## Duplicating a skill -{: #skill-tasks-duplicate} - -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. - -1. Click the ![open and close list of options](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 -{: #skill-tasks-delete} - -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. -{: tip} - -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. - -1. If the skill you want to delete is associated with an assistant, then remove it from the assistant by completing the following steps: - - - Check with the owner of the assistant that is using the skill before you remove the skill from it. - - Open the Assistants page, and then click to open the assistant tile. - - Find the tile for the skill that you want to delete. Click the ![open and close list of options](images/kebab.png) icon, and then choose **Remove**. - - Repeat the previous steps for any other assistants that use the skill. - - Return to the Skills page and find the tile for the skill that you want to delete. - -1. Click the ![open and close list of options](images/kebab.png) icon, and then choose **Delete**. Confirm the deletion. - -## Downloading a skill -{: #skill-tasks-download} - -You can download a dialog or actions skill in JSON format. You might want to download a skill if you want to use the same skill in a different instance of the {{site.data.keyword.assistant_classic_short}} service. You can download a dialog skill from one instance and upload it to another instance as a new skill, for example. - -You cannot download a search skill. - -To download a skill, complete the following steps: - -1. Find the skill tile on the Skills page or on the configuration page of an assistant that uses the skill. - -1. Click the ![open and close list of options](images/kebab.png) icon, and then choose **Download**. - -1. Specify a name for the JSON file and where to save it, and then click **Save**. - -For dialog skills only: - -- You can download a dialog skill by using the API also. Include the `export=true` parameter with the request. See the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1#getworkspace){: external} for more details. -- For information about how to download a specific dialog skill version, see [Downloading a skill version](/docs/assistant?topic=assistant-versions#versions-export). - -## Overwriting a skill -{: #skill-tasks-overwrite} - -To overwrite or replace an existing skill, upload the new version of the skill as a JSON file into the existing skill. - -You can overwrite a dialog or actions skill. You cannot overwrite a search skill. - -To overwrite a skill, complete the following steps: - -1. Click the **Skills** icon ![Skills menu icon](images/nav-skills-icon.png) to open the Skills page. - -1. Find the skill that you want to replace. - -1. Click the ![open and close list of options](images/kebab.png) icon, and then choose **Upload**. - -1. Drag a file or click **Drag and drop file here or click to select a file** and select the JSON file you want to overwrite your skill with. - - 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} - - For dialog skills only: 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](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#createworkspace){: external}. - {: tip} - -1. Click **Upload and overwrite**. - - If you have trouble uploading a dialog skill, see [Troubleshooting skill upload issues](#skill-dialog-add-import-errors). diff --git a/toc.yaml b/toc.yaml index 1f0b7116..89d1e883 100644 --- a/toc.yaml +++ b/toc.yaml @@ -65,9 +65,6 @@ toc: - entities.md - versions.md - skill-search-add.md - - skill-tasks.md - - deploy-web-link.md - - assistant-settings.md - assistant-language.md - topicgroup: label: Deploying @@ -79,22 +76,6 @@ toc: - deploy-web-chat.md - deploy-salesforce.md - deploy-zendesk.md - links: - - link: - label: Integrating with Genesys Cloud - href: https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/genesys/webChat - - link: - label: Integrating with NICE inContact - href: https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/incontact/webChat - - link: - label: Integrating with Twilio Flex - href: https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/flex/webChat - - link: - label: Integrating with Oracle B2C Service - href: https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter/tree/main/src/oracle/webChat - - link: - label: Integrating with your own service desk - href: https://github.com/watson-developer-cloud/assistant-web-chat-service-desk-starter - topicgroup: label: Deploying for phone topics: @@ -105,7 +86,6 @@ toc: - topicgroup: label: Deploying to other platforms topics: - - deploy-integration-add.md - deploy-facebook.md - deploy-intercom.md - deploy-slack.md diff --git a/troubleshoot.md b/troubleshoot.md index 9adc61cf..850d80d6 100644 --- a/troubleshoot.md +++ b/troubleshoot.md @@ -35,8 +35,6 @@ Use these resources to get answers to your questions: - For answers to frequently asked questions, see the [FAQ](/docs/assistant?topic=assistant-faqs). -- Click the **Learning center** link that is displayed in the header of the skill pages to find helpful product tours. The tours guide you through the steps to follow to complete a range of tasks, from adding your first intent to a dialog skill to enhancing the conversation in an actions skill. The *Additional resources* page has links to relevant documentation topics and how-to videos. You can search the resource link titles to find what you're looking for quickly. - - Find answers to common questions or ask questions where experts and other community members can answer by visiting the [Watson Assistant Community forum](https://community.ibm.com/community/user/watsonapps/communities/community-home/digestviewer?communitykey=7a3dc5ba-3018-452d-9a43-a49dc6819633&tab=digestviewer){: external}. If your service plan covers it, you can get help by creating a case from [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter){: external}. \ No newline at end of file diff --git a/tutorial-slots-complex.md b/tutorial-slots-complex.md index e677b78d..82d60e5e 100644 --- a/tutorial-slots-complex.md +++ b/tutorial-slots-complex.md @@ -842,8 +842,3 @@ In the logic that calls the reservation service, be sure to check for `has_skipp {: #tutorial-slots-complex-summary} In this tutorial you tested a node with slots and made changes that optimize how it interacts with real users. For more information about this subject, see [Gathering information with slots](/docs/assistant?topic=assistant-dialog-slots). - -## Next steps -{: #tutorial-slots-complex-deploy} - -Deploy your dialog skill by first connecting it to an assistant, and then deploying the assistant. There are several ways you can do this. See [Adding integrations](/docs/assistant?topic=assistant-deploy-integration-add) for more details. \ No newline at end of file diff --git a/tutorial.md b/tutorial.md index 24a5b6a0..789d6403 100644 --- a/tutorial.md +++ b/tutorial.md @@ -781,8 +781,3 @@ Now that you have built a more sophisticated version of the assistant, return to Unlike when you send test utterances to your assistant from the "Try it out" pane, standard usage charges apply to API calls that result from utterances that are submited to the chat widget. {: note} - -## Next steps -{: #tutorial-deploy} - -Now that you have built and tested your dialog skill, you can share it with customers. Deploy your skill by first connecting it to an assistant, and then deploying the assistant. There are several ways you can do this. See [Adding integrations](/docs/assistant?topic=assistant-deploy-integration-add) for more details. diff --git a/versions.md b/versions.md index cbd3a4e0..cc8189ce 100644 --- a/versions.md +++ b/versions.md @@ -112,5 +112,3 @@ To download a dialog skill version, complete the following steps: 1. From the skill menu, click **Versions**. 1. Click the ![Click to view actions](images/kebab.png) icon from the version you want to download, and then choose **Export**. 1. Specify a name for the JSON file and where to save it, and then click **Save**. - -For more information about how to replace a skill, see [Overwriting a skill](/docs/assistant?topic=assistant-skill-tasks#skill-tasks-overwrite). \ No newline at end of file diff --git a/web-chat-basics.md b/web-chat-basics.md index 32445bde..1fc5ff04 100644 --- a/web-chat-basics.md +++ b/web-chat-basics.md @@ -8,24 +8,10 @@ subcollection: assistant --- -{:shortdesc: .shortdesc} -{:new_window: target="_blank"} -{:external: target="_blank" .external} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} -{:tip: .tip} -{:preview: .preview} -{:pre: .pre} -{:codeblock: .codeblock} -{:screen: .screen} -{:javascript: .ph data-hd-programlang='javascript'} -{:java: .ph data-hd-programlang='java'} -{:python: .ph data-hd-programlang='python'} -{:swift: .ph data-hd-programlang='swift'} -{:video: .video} - -{{site.data.content.newlink}} +{{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 [Web chat development overview](/docs/watson-assistant?topic=watson-assistant-web-chat-develop){: external}. +{: attention} # Web chat overview {: #web-chat-basics}