Skip to content

Commit

Permalink
Merge pull request #1946 from clordan/source
Browse files Browse the repository at this point in the history
  • Loading branch information
cfsdocs committed Oct 17, 2023
1 parent fcc53e4 commit beacd5a
Show file tree
Hide file tree
Showing 37 changed files with 92 additions and 925 deletions.
23 changes: 6 additions & 17 deletions access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion api-dialog-modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion api-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions assistant-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
26 changes: 5 additions & 21 deletions assistant-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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.
Expand All @@ -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}
Expand Down
107 changes: 0 additions & 107 deletions assistant-settings.md

This file was deleted.

30 changes: 5 additions & 25 deletions assistants.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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?
Expand All @@ -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}

Expand Down
2 changes: 0 additions & 2 deletions backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
Loading

0 comments on commit beacd5a

Please sign in to comment.