diff --git a/accessibility.md b/accessibility.md index 8a3be9d2..43ae051b 100644 --- a/accessibility.md +++ b/accessibility.md @@ -6,11 +6,11 @@ lastupdated: "2019-06-11" subcollection: assistant - --- {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -42,4 +42,4 @@ The accessibility features in this product documentation allow users to do the f - Use screen magnifiers to magnify what is displayed on the screen. - Operate specific or equivalent features by using only the keyboard. -The documentation content is published in the IBM Cloud Docs site. For information about the accessibility of the site, see [Accessibility features for IBM Cloud](/docs/overview/accessibility?topic=overview-accessibility-platform). +The documentation content is published in the IBM Cloud Docs site. For information about the accessibility of the site, see [Accessibility features for IBM Cloud](/docs/overview/accessibility?topic=overview-accessibility-platform)(: external). diff --git a/api-client.md b/api-client.md index ce877589..6405aaa6 100755 --- a/api-client.md +++ b/api-client.md @@ -15,6 +15,7 @@ subcollection: assistant {:python: #python .ph data-hd-programlang='python'} {:swift: data-hd-programlang='swift'} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} @@ -260,7 +261,7 @@ Paste the example code into a file named `AssistantSimpleExample.java`. You can **Note:** Make sure you have installed the Watson SDK for Python using `pip install --upgrade ibm-watson` or `easy_install --upgrade ibm-watson`. {: python} -**Note:** Make sure you have installed the [Watson SDK for Java ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/java-sdk/blob/master/README.md){: new_window}. +**Note:** Make sure you have installed the [Watson SDK for Java](https://github.com/watson-developer-cloud/java-sdk/blob/master/README.md){: external}. {: java} Assuming everything works as expected, the assistant returns the output from the dialog, which is then printed to the console: @@ -847,4 +848,4 @@ Using the v2 API is the recommended way to build a runtime client application th Note that if your app uses the v1 API, it communicates directly with the workspace, bypassing the orchestration and state-management capabilities of the assistant. This means that your application is responsible for managing state information using the context. Your application must maintain the context by saving the context received with each response and sending it back to the service with each new message request. (The v1 `/message` method always returns the context with each response.) -For more information about the v1 `/message` method and context, see the [v1 API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1#get-response-to-user-input){: new_window}. \ No newline at end of file +For more information about the v1 `/message` method and context, see the [v1 API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1#get-response-to-user-input){: external}. \ No newline at end of file diff --git a/api-context.md b/api-context.md index 5cf06f51..c718f53a 100755 --- a/api-context.md +++ b/api-context.md @@ -15,6 +15,7 @@ subcollection: assistant {:python: #python .ph data-hd-programlang='python'} {:swift: data-hd-programlang='swift'} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} @@ -192,4 +193,4 @@ The output from this request includes not only the usual output, but also the co } ``` -For detailed information about how to access context variables using the API, see the [v2 API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v2#send-user-input-to-assistant){: new_window}.) +For detailed information about how to access context variables using the API, see the [v2 API Reference](https://{DomainName}/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: external}.) diff --git a/api-dialog-responses.md b/api-dialog-responses.md index 7a6d0ed3..314e7e5f 100644 --- a/api-dialog-responses.md +++ b/api-dialog-responses.md @@ -11,6 +11,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -59,7 +60,7 @@ It is the reponsibility of your client application to handle all response types ## Response types {: #api-dialog-responses-types} -Each element of a response is of one of the supported response types (currently `image`, `option`, `pause`, `text`, and `suggestion`). Each response type is specified using a different set of JSON properties, so the properties included for each response will vary depending upon response type. For complete information about the response model of the `/message` API, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v2#send-user-input-to-assistant){: new_window}.) +Each element of a response is of one of the supported response types (currently `image`, `option`, `pause`, `text`, and `suggestion`). Each response type is specified using a different set of JSON properties, so the properties included for each response will vary depending upon response type. For complete information about the response model of the `/message` API, see the [API Reference](https://{DomainName}/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: external}.) This section describes the available response types and how they are represented in the `/message` API response JSON. (If you are using the Watson SDK, you can use the interfaces provided for your language to access the same objects.) diff --git a/api-methods.md b/api-methods.md index 4fb21c81..02f8cd10 100755 --- a/api-methods.md +++ b/api-methods.md @@ -15,6 +15,7 @@ subcollection: assistant {:python: #python .ph data-hd-programlang='python'} {:swift: data-hd-programlang='swift'} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} @@ -38,56 +39,56 @@ The following tables list the methods that are available using the {{site.data.k | Method | Description | API ver | Reference | |:-------|:------------|:-------:|:---------:| -| **Create a session** | Create a new session. A session is used to send user input to a skill and receive responses. It also maintains the state of the conversation. | v2 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v2#create-a-session){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v2?code=node#create-a-session){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v2?code=java#create-a-session){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v2?code=python#create-a-session){: new_window} | -| **Delete session** | Deletes a session explicitly before it times out. | v2 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v2#delete-session){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v2?code=node#delete-session){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v2?code=java#delete-session){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v2?code=python#delete-session){: new_window} | -| **Send user input to assistant** | Send user input to an assistant and receive a response. | v2 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v2?code=node#send-user-input-to-assistant){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v2?code=java#send-user-input-to-assistant){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v2?code=python#send-user-input-to-assistant){: new_window} | +| **Create a session** | Create a new session. A session is used to send user input to a skill and receive responses. It also maintains the state of the conversation. | v2 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v2#create-a-session){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v2?code=node#create-a-session){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v2?code=java#create-a-session){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v2?code=python#create-a-session){: external} | +| **Delete session** | Deletes a session explicitly before it times out. | v2 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v2#delete-session){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v2?code=node#delete-session){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v2?code=java#delete-session){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v2?code=python#delete-session){: external} | +| **Send user input to assistant** | Send user input to an assistant and receive a response. | v2 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v2?code=node#send-user-input-to-assistant){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v2?code=java#send-user-input-to-assistant){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v2?code=python#send-user-input-to-assistant){: external} | ## Authoring methods {: #api-methods-authoring} | Method | Description | API ver | Reference | |:-------|:------------|:-------:|:---------:| -| **List workspaces** | List the workspaces associated with a Watson Assistant service instance. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-workspaces){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-workspaces){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-workspaces){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-workspaces){: new_window} | -| **Create workspace** | Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-workspace){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-workspace){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-workspace){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-workspace){: new_window} | -| **Get information about a workspace** | Get information about a workspace, optionally including all workspace content. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-information-about-a-workspace){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-information-about-a-workspace){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-information-about-a-workspace){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-information-about-a-workspace){: new_window} | -| **Update workspace** | Update an existing workspace with new or modified data. You must provide component objects defining the content of the updated workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-workspace){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-workspace){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-workspace){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-workspace){: new_window} | -| **Delete workspace** | Delete a workspace from the service instance. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-workspace){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-workspace){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-workspace){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-workspace){: new_window} | -| **List intents** | List the intents for a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-intents){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-intents){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-intents){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-intents){: new_window} | -| **Create intent** | Create a new intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-intent){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-intent){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-intent){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-intent){: new_window} | -| **Get intent** | Get information about an intent, optionally including all intent content. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-intent){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-intent){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-intent){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-intent){: new_window} | -| **Update intent** | Update an existing intent with new or modified data. You must provide component objects defining the content of the updated intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-intent){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-intent){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-intent){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-intent){: new_window} | -| **Delete intent** | Delete an intent from a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-intent){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-intent){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-intent){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-intent){: new_window} | -| **List user input examples** | List the user input examples for an intent, optionally including contextual entity mentions. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-user-input-examples){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-user-input-examples){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-user-input-examples){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-user-input-examples){: new_window} | -| **Create user input example** | Add a new user input example to an intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-user-input-example){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-user-input-example){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-user-input-example){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-user-input-example){: new_window} | -| **Get user input example** | Get information about a user input example. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-user-input-example){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-user-input-example){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-user-input-example){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-user-input-example){: new_window} | -| **Update user input example** | Update the text of a user input example. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-user-input-example){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-user-input-example){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-user-input-example){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-user-input-example){: new_window} | -| **Delete user input example** | Delete a user input example from an intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-user-input-example){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-user-input-example){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-user-input-example){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-user-input-example){: new_window} | -| **List counterexamples** | List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-counterexamples){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-counterexamples){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-counterexamples){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-counterexamples){: new_window} | -| **Create counterexample** | Add a new counterexample to a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-counterexample){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-counterexample){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-counterexample){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-counterexample){: new_window} | -| **Get counterexample** | Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-counterexample){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-counterexample){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-counterexample){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-counterexample){: new_window} | -| **Update counterexample** | Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-counterexample){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-counterexample){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-counterexample){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-counterexample){: new_window} | -| **Delete counterexample** | Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-counterexample){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-counterexample){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-counterexample){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-counterexample){: new_window} | -| **List entities** | List the entities for a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entities){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entities){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entities){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entities){: new_window} | -| **Create entity** | Create a new entity, or enable a system entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-entity){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-entity){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-entity){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-entity){: new_window} | -| **Get entity** | Get information about an entity, optionally including all entity content. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-entity){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-entity){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-entity){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-entity){: new_window} | -| **Update entity** | Update an existing entity with new or modified data. You must provide component objects defining the content of the updated entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-entity){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-entity){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-entity){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-entity){: new_window} | -| **Delete entity** | Delete an entity from a workspace, or disable a system entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-entity){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-entity){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-entity){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-entity){: new_window} | -| **List entity mentions** | List mentions for a contextual entity. An entity mention is an occurrence of a contextual entity in the context of an intent user input example. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entity-mentions){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entity-mentions){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entity-mentions){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entity-mentions){: new_window} | -| **List entity values** | List the values for an entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entity-values){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entity-values){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entity-values){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entity-values){: new_window} | -| **Add entity value** | Create a new value for an entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#add-entity-value){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#add-entity-value){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#add-entity-value){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#add-entity-value){: new_window} | -| **Get entity value** | Get information about an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-entity-value){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-entity-value){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-entity-value){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-entity-value){: new_window} | -| **Update entity value** | Update an existing entity value with new or modified data. You must provide component objects defining the content of the updated entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-entity-value){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-entity-value){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-entity-value){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-entity-value){: new_window} | -| **Delete entity value** | Delete a value from an entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-entity-value){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-entity-value){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-entity-value){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-entity-value){: new_window} | -| **List entity value synonyms** | List the synonyms for an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entity-value-synonyms){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entity-value-synonyms){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entity-value-synonyms){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entity-value-synonyms){: new_window} | -| **Add entity value synonym** | Add a new synonym to an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#add-entity-value-synonym){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#add-entity-value-synonym){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#add-entity-value-synonym){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#add-entity-value-synonym){: new_window} | -| **Get entity value synonym** | Get information about a synonym of an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-entity-value-synonym){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-entity-value-synonym){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-entity-value-synonym){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-entity-value-synonym){: new_window} | -| **Update entity value synonym** | Update an existing entity value synonym with new text. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-entity-value-synonym){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-entity-value-synonym){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-entity-value-synonym){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-entity-value-synonym){: new_window} | -| **Delete entity value synonym** | Delete a synonym from an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-entity-value-synonym){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-entity-value-synonym){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-entity-value-synonym){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-entity-value-synonym){: new_window} | -| **List dialog nodes** | List the dialog nodes for a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-dialog-nodes){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-dialog-nodes){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-dialog-nodes){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-dialog-nodes){: new_window} | -| **Create dialog node** | Create a new dialog node. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-dialog-node){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-dialog-node){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-dialog-node){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-dialog-node){: new_window} | -| **Get dialog node** | Get information about a dialog node. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-dialog-node){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-dialog-node){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-dialog-node){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-dialog-node){: new_window} | -| **Update dialog node** | Update an existing dialog node with new or modified data. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-dialog-node){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-dialog-node){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-dialog-node){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-dialog-node){: new_window} | -| **Delete dialog node** | Delete a dialog node from a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-dialog-node){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-dialog-node){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-dialog-node){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-dialog-node){: new_window} | -| **List log events in a workspace** | List the events from the log of a specific workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-log-events-in-a-workspace){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-log-events-in-a-workspace){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-log-events-in-a-workspace){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-log-events-in-a-workspace){: new_window} | -| **List log events in all workspaces** | List the events from the logs of all workspaces in the service instance. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-log-events-in-all-workspaces){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-log-events-in-all-workspaces){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-log-events-in-all-workspaces){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-log-events-in-all-workspaces){: new_window} | -| **Delete labeled data** | Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-labeled-data){: new_window} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-labeled-data){: new_window} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-labeled-data){: new_window} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-labeled-data){: new_window} | \ No newline at end of file +| **List workspaces** | List the workspaces associated with a Watson Assistant service instance. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-workspaces){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-workspaces){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-workspaces){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-workspaces){: external} | +| **Create workspace** | Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-workspace){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-workspace){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-workspace){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-workspace){: external} | +| **Get information about a workspace** | Get information about a workspace, optionally including all workspace content. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-information-about-a-workspace){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-information-about-a-workspace){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-information-about-a-workspace){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-information-about-a-workspace){: external} | +| **Update workspace** | Update an existing workspace with new or modified data. You must provide component objects defining the content of the updated workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-workspace){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-workspace){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-workspace){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-workspace){: external} | +| **Delete workspace** | Delete a workspace from the service instance. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-workspace){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-workspace){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-workspace){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-workspace){: external} | +| **List intents** | List the intents for a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-intents){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-intents){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-intents){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-intents){: external} | +| **Create intent** | Create a new intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-intent){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-intent){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-intent){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-intent){: external} | +| **Get intent** | Get information about an intent, optionally including all intent content. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-intent){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-intent){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-intent){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-intent){: external} | +| **Update intent** | Update an existing intent with new or modified data. You must provide component objects defining the content of the updated intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-intent){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-intent){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-intent){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-intent){: external} | +| **Delete intent** | Delete an intent from a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-intent){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-intent){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-intent){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-intent){: external} | +| **List user input examples** | List the user input examples for an intent, optionally including contextual entity mentions. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-user-input-examples){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-user-input-examples){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-user-input-examples){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-user-input-examples){: external} | +| **Create user input example** | Add a new user input example to an intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-user-input-example){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-user-input-example){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-user-input-example){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-user-input-example){: external} | +| **Get user input example** | Get information about a user input example. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-user-input-example){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-user-input-example){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-user-input-example){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-user-input-example){: external} | +| **Update user input example** | Update the text of a user input example. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-user-input-example){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-user-input-example){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-user-input-example){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-user-input-example){: external} | +| **Delete user input example** | Delete a user input example from an intent. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-user-input-example){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-user-input-example){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-user-input-example){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-user-input-example){: external} | +| **List counterexamples** | List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-counterexamples){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-counterexamples){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-counterexamples){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-counterexamples){: external} | +| **Create counterexample** | Add a new counterexample to a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-counterexample){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-counterexample){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-counterexample){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-counterexample){: external} | +| **Get counterexample** | Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-counterexample){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-counterexample){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-counterexample){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-counterexample){: external} | +| **Update counterexample** | Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-counterexample){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-counterexample){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-counterexample){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-counterexample){: external} | +| **Delete counterexample** | Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-counterexample){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-counterexample){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-counterexample){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-counterexample){: external} | +| **List entities** | List the entities for a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entities){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entities){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entities){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entities){: external} | +| **Create entity** | Create a new entity, or enable a system entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-entity){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-entity){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-entity){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-entity){: external} | +| **Get entity** | Get information about an entity, optionally including all entity content. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-entity){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-entity){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-entity){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-entity){: external} | +| **Update entity** | Update an existing entity with new or modified data. You must provide component objects defining the content of the updated entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-entity){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-entity){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-entity){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-entity){: external} | +| **Delete entity** | Delete an entity from a workspace, or disable a system entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-entity){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-entity){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-entity){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-entity){: external} | +| **List entity mentions** | List mentions for a contextual entity. An entity mention is an occurrence of a contextual entity in the context of an intent user input example. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entity-mentions){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entity-mentions){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entity-mentions){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entity-mentions){: external} | +| **List entity values** | List the values for an entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entity-values){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entity-values){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entity-values){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entity-values){: external} | +| **Add entity value** | Create a new value for an entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#add-entity-value){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#add-entity-value){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#add-entity-value){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#add-entity-value){: external} | +| **Get entity value** | Get information about an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-entity-value){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-entity-value){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-entity-value){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-entity-value){: external} | +| **Update entity value** | Update an existing entity value with new or modified data. You must provide component objects defining the content of the updated entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-entity-value){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-entity-value){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-entity-value){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-entity-value){: external} | +| **Delete entity value** | Delete a value from an entity. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-entity-value){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-entity-value){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-entity-value){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-entity-value){: external} | +| **List entity value synonyms** | List the synonyms for an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-entity-value-synonyms){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-entity-value-synonyms){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-entity-value-synonyms){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-entity-value-synonyms){: external} | +| **Add entity value synonym** | Add a new synonym to an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#add-entity-value-synonym){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#add-entity-value-synonym){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#add-entity-value-synonym){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#add-entity-value-synonym){: external} | +| **Get entity value synonym** | Get information about a synonym of an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-entity-value-synonym){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-entity-value-synonym){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-entity-value-synonym){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-entity-value-synonym){: external} | +| **Update entity value synonym** | Update an existing entity value synonym with new text. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-entity-value-synonym){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-entity-value-synonym){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-entity-value-synonym){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-entity-value-synonym){: external} | +| **Delete entity value synonym** | Delete a synonym from an entity value. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-entity-value-synonym){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-entity-value-synonym){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-entity-value-synonym){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-entity-value-synonym){: external} | +| **List dialog nodes** | List the dialog nodes for a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-dialog-nodes){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-dialog-nodes){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-dialog-nodes){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-dialog-nodes){: external} | +| **Create dialog node** | Create a new dialog node. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#create-dialog-node){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#create-dialog-node){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#create-dialog-node){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#create-dialog-node){: external} | +| **Get dialog node** | Get information about a dialog node. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#get-dialog-node){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#get-dialog-node){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#get-dialog-node){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#get-dialog-node){: external} | +| **Update dialog node** | Update an existing dialog node with new or modified data. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#update-dialog-node){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#update-dialog-node){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#update-dialog-node){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#update-dialog-node){: external} | +| **Delete dialog node** | Delete a dialog node from a workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-dialog-node){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-dialog-node){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-dialog-node){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-dialog-node){: external} | +| **List log events in a workspace** | List the events from the log of a specific workspace. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-log-events-in-a-workspace){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-log-events-in-a-workspace){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-log-events-in-a-workspace){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-log-events-in-a-workspace){: external} | +| **List log events in all workspaces** | List the events from the logs of all workspaces in the service instance. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#list-log-events-in-all-workspaces){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#list-log-events-in-all-workspaces){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#list-log-events-in-all-workspaces){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#list-log-events-in-all-workspaces){: external} | +| **Delete labeled data** | Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID. | v1 | [cURL](https://{DomainName}/apidocs/assistant/assistant-v1#delete-labeled-data){: external} [node](https://{DomainName}/apidocs/assistant/assistant-v1?code=node#delete-labeled-data){: external} [java](https://{DomainName}/apidocs/assistant/assistant-v1?code=java#delete-labeled-data){: external} [python](https://{DomainName}/apidocs/assistant/assistant-v1?code=python#delete-labeled-data){: external} | \ No newline at end of file diff --git a/api-migration.md b/api-migration.md index b88ab6ac..101ea3a2 100755 --- a/api-migration.md +++ b/api-migration.md @@ -67,7 +67,7 @@ The v2 runtime API sends messages to an assistant, which routes the messages to After you have created an assistant, you can update your client application to use the v2 runtime API instead of the v1 runtime API. -1. Before sending the first message in a conversation, use the v2 [**Create a session**](https://cloud.ibm.com/apidocs/assistant-v2#create-a-session){: external} method to create a session. Save the returned session ID: +1. Before sending the first message in a conversation, use the v2 [**Create a session**](https://cloud.ibm.com/apidocs/assistant/assistant-v2#create-a-session){: external} method to create a session. Save the returned session ID: ```javascript service @@ -97,7 +97,7 @@ After you have created an assistant, you can update your client application to u {: codeblock} {: java} -1. Use the v2 [**Send user input to assistant**](https://cloud.ibm.com/apidocs/assistant-v2#send-user-input-to-assistant){: external} method to send user input to the assistant. Instead of specifying the workspace ID as you did with the v1 API, you specify the assistant ID and the session ID: +1. Use the v2 [**Send user input to assistant**](https://cloud.ibm.com/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: external} method to send user input to the assistant. Instead of specifying the workspace ID as you did with the v1 API, you specify the assistant ID and the session ID: ```javascript service @@ -134,7 +134,7 @@ After you have created an assistant, you can update your client application to u The basic message structure has not changed; in particular, the user input is still sent as `input.text`. -1. After a conversation ends, use the v2 [**Delete session**](https://cloud.ibm.com/apidocs/assistant-v2#delete-session){: external} method to delete the session. +1. After a conversation ends, use the v2 [**Delete session**](https://cloud.ibm.com/apidocs/assistant/assistant-v2#delete-session){: external} method to delete the session. ```javascript service @@ -183,7 +183,7 @@ Your application might need to be updated to handle the v2 runtime response form However, keep in mind that state data, including conversation context, is now maintained by the assistant, so your application might not need to access the context at all (see [Let the assistant maintain state](#api-migration-state)). -Refer to the v2 [API Reference ](https://cloud.ibm.com/apidocs/assistant-v2#send-user-input-to-assistant){: external} for complete documentation of the v2 response format. +Refer to the v2 [API Reference ](https://cloud.ibm.com/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: external} for complete documentation of the v2 response format. ## Let the assistant maintain state {: #api-migration-state} diff --git a/api-overview.md b/api-overview.md index 6a72a0ab..2f2eb58b 100755 --- a/api-overview.md +++ b/api-overview.md @@ -15,6 +15,7 @@ subcollection: assistant {:python: #python .ph data-hd-programlang='python'} {:swift: data-hd-programlang='swift'} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} @@ -44,13 +45,13 @@ By using the v2 runtime API to communicate with your assistant, your application - **Search capabilities.** The v2 runtime API can be used to receive responses from both dialog skills and search skills. When a query is submitted that your dialog skill cannot answer, the assistant can use a search skill to find the best answer from the configured data sources. (Search skills are a beta feature available only to Plus or Premium plan users.) -For details about the v2 API, see the {{site.data.keyword.conversationshort}} [v2 API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v2){: new_window}. +For details about the v2 API, see the {{site.data.keyword.conversationshort}} [v2 API Reference](https://{DomainName}/apidocs/assistant/assistant-v2){: external}. **Note**: The {{site.data.keyword.conversationshort}} v1 API still supports the legacy `/message` method that sends user input directly to the workspace used by a dialog skill. The v1 runtime API is supported primarily for backward compatibility purposes. If you use the v1 `/message` method, you must implement your own state management, and you cannot take advantage of versioning or any of the other features of an assistant. ## Authoring applications -The v1 API provides methods that enable an application to create or modify dialog skills, as an alternative to building a skill graphically using the {{site.data.keyword.conversationshort}} user interface. An authoring application uses the API to create and modify skills, intents, entities, dialog nodes, and other artifacts that make up a dialog skill. For more information, see the [v1 API Reference ![External link icon](../../icons/launch-glyph.svg "External linkicon")](https://{DomainName}/apidocs/assistant-v1){: new_window}. +The v1 API provides methods that enable an application to create or modify dialog skills, as an alternative to building a skill graphically using the {{site.data.keyword.conversationshort}} user interface. An authoring application uses the API to create and modify skills, intents, entities, dialog nodes, and other artifacts that make up a dialog skill. For more information, see the [v1 API Reference](https://{DomainName}/apidocs/assistant/assistant-v1){: external}. **Note:** The v1 authoring methods create and modify workspaces rather than skills. A workspace is a container for the dialog and training data (such as intents and entities) within a dialog skill. If you create a new workspace using the API, it will appear as a new dialog skill in the {{site.data.keyword.conversationshort}} user interface. diff --git a/assistant-add.md b/assistant-add.md index afa69578..b5143f8c 100644 --- a/assistant-add.md +++ b/assistant-add.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-10-18" +lastupdated: "2019-10-24" subcollection: assistant @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} diff --git a/assistant-settings.md b/assistant-settings.md index 62e5bdfd..e16f4546 100644 --- a/assistant-settings.md +++ b/assistant-settings.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-10-18" +lastupdated: "2019-10-24" subcollection: assistant @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} diff --git a/assistants.md b/assistants.md index dd24101d..4fc9f35c 100644 --- a/assistants.md +++ b/assistants.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-07-26" +lastupdated: "2019-10-24" subcollection: assistant @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} diff --git a/backup.md b/backup.md index 6dc7d089..58838978 100644 --- a/backup.md +++ b/backup.md @@ -2,15 +2,15 @@ copyright: years: 2015, 2019 -lastupdated: "2019-10-18" +lastupdated: "2019-10-24" subcollection: assistant - --- {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -42,7 +42,7 @@ You cannot export the following data: ## Retaining logs {: #backup-retain-logs} -If you want to store logs of conversations that users have had with your assistant, you can use the `/logs` API to export your log data. See [API reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1#list-log-events-in-a-workspace) for details. +If you want to store logs of conversations that users have had with your assistant, you can use the `/logs` API to export your log data. See [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1#list-log-events-in-a-workspace) for details. To get the workspace ID for a skill, from the skill tile, click the ![open and close list of options](images/kabob-beta.png) icon, and then choose **View API Details**. {: tip} @@ -62,7 +62,7 @@ To back up dialog skill data, export the skill as a JSON file, and store the JSO 1. Specify a name for the JSON file and where to save it, and then click **Save**. -Alternatively, you can use the `/workspaces` API to export a dialog skill. Include the `export=true` parameter with the GET workspace request. See the [API reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1#get-information-about-a-workspace) for more details. +Alternatively, you can use the `/workspaces` API to export a dialog skill. Include the `export=true` parameter with the GET workspace request. See the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1#get-information-about-a-workspace){: external} for more details. ## Importing a dialog skill {: #backup-import-skill} @@ -83,7 +83,7 @@ If the {{site.data.keyword.conversationshort}} service changes between the time **Important:** - The imported JSON file must use UTF-8 encoding, without byte order mark (BOM) encoding. - - The maximum size for a skill JSON file is 10MB. If you need to import a larger skill, consider importing the intents and entities separately after you have imported the skill. (You can also import larger skills using the REST API. For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1#create-workspace){: new_window}.) + - The maximum size for a skill JSON file is 10MB. If you need to import a larger skill, consider importing the intents and entities separately after you have imported the skill. (You can also import larger skills using the REST API. For more information, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1#create-workspace){: external}.) - The JSON file cannot contain tabs, newlines, or carriage returns. Select **Everything (Intents, Entities, and Dialog)** to import a complete copy of the exported skill. diff --git a/beta-deploy-zendesk.md b/beta-deploy-zendesk.md index 37836bd4..a477d5dd 100644 --- a/beta-deploy-zendesk.md +++ b/beta-deploy-zendesk.md @@ -47,11 +47,11 @@ As with any beta feature, do not use this feature in production. This integratio Zendesk Chat is an add-on to Zendesk Support. Zendesk Support puts all your customer support interactions in one place, so communication is seamless, personal, and efficient, which means more productive agents and satisfied customers. -You must have a Zendesk account. If not, go to [www.zendesk.com ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.zendesk.com) to create one. An Enterprise or Chat Professional plan is recommended. +You must have a Zendesk account. If not, go to [www.zendesk.com](https://www.zendesk.com) to create one. An Enterprise or Chat Professional plan is recommended. When you create an account, you specify a subdomain. Afterwards, your Zendesk console is available from a URL with the syntax: `.zendesk.com`. For example: `ibm.zendesk.com` -Set up Zendesk Chat. See [Setting up Zendesk Chat routing ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://support.zendesk.com/hc/en-us/articles/203661666-Setting-up-Zopim-Chat-in-Zendesk). +Set up Zendesk Chat. See [Setting up Zendesk Chat routing](https://support.zendesk.com/hc/en-us/articles/203661666-Setting-up-Zopim-Chat-in-Zendesk). You or someone in your organziation must complete these one-time prerequisite steps before you can add the Zendesk integration to your assistant. @@ -88,7 +88,7 @@ You or someone in your organziation must complete these one-time prerequisite st Chats with customers are routed to departments. You need to create a department with only your assistant as a member, so that you can route customer chats to your assistant in a later step. - For more details, see [Creating agents and departments ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://support.zendesk.com/hc/en-us/articles/360022365373). + For more details, see [Creating agents and departments](https://support.zendesk.com/hc/en-us/articles/360022365373). 1. Create at least one more department. Add members to it who are human agents that can address customer questions. @@ -188,7 +188,7 @@ An application is provided by the {{site.data.keyword.conversationshort}} servic 1. Upload the application to Zendesk Chat as a new private app. When credentials are requested, paste the app credentials that you copied earlier. - For more details, see [Managing your installed apps ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://support.zendesk.com/hc/en-us/articles/203662486). + For more details, see [Managing your installed apps](https://support.zendesk.com/hc/en-us/articles/203662486). ### Configuring message routing {: #deploy-zendesk-config-backup} @@ -276,7 +276,7 @@ To test the assistant, temporarily route all incoming chats to the assistant's d ![Shows the Zendesk UI Settings page where you can define a trigger that always routes messages to an assistant](images/zendesk-setup-for-testing-trigger-always.png) - For more details, see [Automatically route chats to departments ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://support.zendesk.com/hc/en-us/articles/360022186814) from the Zendesk documentation. + For more details, see [Automatically route chats to departments](https://support.zendesk.com/hc/en-us/articles/360022186814) from the Zendesk documentation. 1. Create a chat widget to embed in a test web page. @@ -309,9 +309,9 @@ After you test the integration, and feel confident that the assistant is ready t 1. Create a new trigger that routes specific types of messages to the department you created for the assistant. - For more details, see [Automatically route chats to departments ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://support.zendesk.com/hc/en-us/articles/360022186814). + For more details, see [Automatically route chats to departments](https://support.zendesk.com/hc/en-us/articles/360022186814). 1. Set up reassignments that will reroute messages that your assistant does not reply to in under 20 seconds to a department monitored by human agents. - For more details, see [Setting up chat routing ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://support.zendesk.com/hc/en-us/articles/360022366213). + For more details, see [Setting up chat routing](https://support.zendesk.com/hc/en-us/articles/360022366213). 1. Embed the chat widget in a production web site to make it available to your customers. diff --git a/deploy-integration-add.md b/deploy-integration-add.md index f366b2ab..3b2852ee 100644 --- a/deploy-integration-add.md +++ b/deploy-integration-add.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -35,7 +36,7 @@ Watson this 3-minute video to learn more about integrating your assistant with a -To learn about how service desk integrations with your assistant can benefit your business, [read this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/contact-center-post-394dff427c8){: new_window}. +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}. ## Add an integration {: #deploy-integration-add-task} @@ -59,10 +60,10 @@ Follow these steps to add integrations to your assistant: - [Intercom](/docs/services/assistant?topic=assistant-deploy-intercom) ![Plus or Premium plan only](images/plus.png) - [Preview Link](/docs/services/assistant?topic=assistant-deploy-web-link) - [Slack](/docs/services/assistant?topic=assistant-deploy-slack) - - [Voice Agent (Telephony) ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/catalog/services/voice-agent-with-watson){: new_window} + - [Voice Agent (Telephony)](https://cloud.ibm.com/catalog/services/voice-agent-with-watson){: external} Opens the **Voice Agent with Watson** service overview page on {{site.data.keyword.cloud}}. - - [WordPress plug-in ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://wordpress.org/plugins/conversation-watson/){: new_window} + - [WordPress plug-in](https://wordpress.org/plugins/conversation-watson/){: external} Opens the IBM Watson Assistant plug-in overview page on the WordPress site. diff --git a/deploy-intercom.md b/deploy-intercom.md index c74686da..9da75f06 100644 --- a/deploy-intercom.md +++ b/deploy-intercom.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -250,6 +251,6 @@ The following 3-minute video illustrates the steps. ## Testing the integration {: #deploy-intercom-try} -To effectively test your Intercom integration from end-to-end, you must have access to an Intercom end-user application. You already created or edited an Intercom workspace. The workspace must have an associated user interface client. If it does not, see [Apps in Intercom ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.intercom.com/help/en/collections/380-apps-in-intercom){: new_window} for help with setting one up. +To effectively test your Intercom integration from end-to-end, you must have access to an Intercom end-user application. You already created or edited an Intercom workspace. The workspace must have an associated user interface client. If it does not, see [Apps in Intercom ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.intercom.com/help/en/collections/380-apps-in-intercom){: external} for help with setting one up. Submit test user queries through a client application that is associated with your Intercom workspace to see how the messages are handled by Intercom. Verify that messages that are meant to be answered by the assistant are generating the appropriate responses, and that the assistant is not responding to messages that it is not configured to answer. diff --git a/dialog-methods.md b/dialog-methods.md index 44ba0277..d321aa51 100644 --- a/dialog-methods.md +++ b/dialog-methods.md @@ -1053,7 +1053,7 @@ For example, this context variable definition creates a $time variable that save ``` {: codeblock} -Format follows the Java [SimpleDateFormat ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html){: new_window} rules. +Format follows the Java [SimpleDateFormat](https://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html){: external} rules. **Note**: When trying to format time only, the date is treated as `1970-01-01`. @@ -1448,7 +1448,7 @@ You can use the the Class methods, including these: ``` {: codeblock} -See the [java.lang.Math reference documentation ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://docs.oracle.com/javase/7/docs/api/java/lang/Math.html) for information about other methods. +See the [java.lang.Math reference documentation](https://docs.oracle.com/javase/7/docs/api/java/lang/Math.html){: external} for information about other methods. ### java.util.Random() {: #dialog-methods-numbers-java-util-random} @@ -1486,7 +1486,7 @@ Condition = @sys-number ``` {: codeblock} -See the [java.util.Random reference documentation](https://docs.oracle.com/javase/7/docs/api/java/util/Random.html) for information about other methods. +See the [java.util.Random reference documentation](https://docs.oracle.com/javase/7/docs/api/java/util/Random.html){: external} for information about other methods. You can use standard methods of the following classes also: @@ -1689,7 +1689,7 @@ There methods help you work with text. For information about how to recognize and extract certain types of Strings, such as people names and locations, from user input, see [System entities](/docs/services/assistant?topic=assistant-system-entities). -**Note:** For methods that involve regular expressions, see [RE2 Syntax reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/google/re2/wiki/Syntax){: new_window} for details about the syntax to use when you specify the regular expression. +**Note:** For methods that involve regular expressions, see [RE2 Syntax reference](https://github.com/google/re2/wiki/Syntax){: external} for details about the syntax to use when you specify the regular expression. ### String.append(Object) {: #dialog-methods-strings-append} @@ -2128,7 +2128,7 @@ In addition to the built-in methods, you can use standard methods of the `java.l #### java.lang.String.format() {: #dialog-methods-strings-java-lang-String-format} -You can apply the standard Java String `format()` method to text. See [java.util.formatter reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html#syntax){: new_window} for information about the syntax to use to specify the format details. +You can apply the standard Java String `format()` method to text. See [java.util.formatter reference](https://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html#syntax){: external} for information about the syntax to use to specify the format details. For example, the following expression takes three decimal integers (1, 1, and 2) and adds them to a sentence. diff --git a/dialog-overview.md b/dialog-overview.md index 558f4c9c..75cf5e37 100644 --- a/dialog-overview.md +++ b/dialog-overview.md @@ -12,6 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -150,7 +151,7 @@ Use one of these syntax options to create valid expressions in conditions: - Shorthand notations to refer to intents, entities, and context variables. See [Accessing and evaluating objects](/docs/services/assistant?topic=assistant-expression-language). -- Spring Expression (SpEL) language, which is an expression language that supports querying and manipulating an object graph at run time. See [Spring Expression Language (SpEL) language ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions){: new_window} for more information. +- Spring Expression (SpEL) language, which is an expression language that supports querying and manipulating an object graph at run time. See [Spring Expression Language (SpEL) language](https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions){: external} for more information. You can use regular expressions to check for values to condition against. To find a matching string, for example, you can use the `String.find` method. See [Methods](/docs/services/assistant?topic=assistant-dialog-methods) for more details. @@ -444,7 +445,7 @@ To add a rich response, complete the following steps: You can include specific information provided by the user by referencing entities that were detected in the user's input as part of the query. For example, `Tell me about @product`. Or you can reference a context variable, such as `Do you have flights to $destination?`. Just be sure to design your dialog such that the search is not triggered unless any entities or context variables that you reference in the query have been set to valid values. - This field is equivalent to the {{site.data.keyword.discoveryshort}} `natural_language_query` parameter. For more information, see [Query parameters ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-query-parameters#nlq){: new_window}. + This field is equivalent to the {{site.data.keyword.discoveryshort}} `natural_language_query` parameter. For more information, see [Query parameters](/docs/services/discovery?topic=discovery-query-parameters#nlq){: external}. - **Filter**: Optional. Specify a text string that defines information that must be present in any of the search results that are returned. @@ -458,7 +459,7 @@ To add a rich response, complete the following steps: If you add both a query and a filter value, then the filter parameter is applied first to filter the data collection documents and cache the results. The query parameter then ranks the cached results. - This field is equivalent to the {{site.data.keyword.discoveryshort}} `filter` parameter. For more information, see [Query parameters ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-query-parameters#filter){: new_window}. + This field is equivalent to the {{site.data.keyword.discoveryshort}} `filter` parameter. For more information, see [Query parameters](/docs/services/discovery?topic=discovery-query-parameters#filter){: external}. This response type only returns a valid response if the assistant to which you added this dialog skill also has a search skill associated with it. Test this response type from the preview link or another assistant-level integration. You cannot test it from the dialog skill's "Try it out" pane. diff --git a/dialog-responses-json.md b/dialog-responses-json.md index fab749d1..07e8b4f5 100644 --- a/dialog-responses-json.md +++ b/dialog-responses-json.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -104,9 +105,9 @@ In addition to the generic JSON format, the dialog node JSON also supports chann You can specify native JSON for Slack or Facebook using the appropriate field in the dialog node response: -- `output.slack`: insert any JSON you want to be included in the `attachment` field of the Slack response. For more information about the Slack JSON format, see the Slack [documentation ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://api.slack.com/messaging/composing){: new_window}. +- `output.slack`: insert any JSON you want to be included in the `attachment` field of the Slack response. For more information about the Slack JSON format, see the Slack [documentation](https://api.slack.com/messaging/composing){: external}. -- `output.facebook`: insert any JSON you want included in the `message.attachment.payload` field of the Facebook response. For more information about the Facebook JSON format, see the Facebook [documentation ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developers.facebook.com/docs/messenger-platform/send-messages/templates){: new_window}. +- `output.facebook`: insert any JSON you want included in the `message.attachment.payload` field of the Facebook response. For more information about the Facebook JSON format, see the Facebook [documentation](https://developers.facebook.com/docs/messenger-platform/send-messages/templates){: external}. ## Response types {: #dialog-responses-json-response-types} @@ -174,7 +175,7 @@ Displays a set of buttons or a drop-down list users can use to choose an option. This example displays two options: - Option 1 (labeled `Buy something`) sends a simple string message (`Place order`), which is sent to the workspace as the input text. -- Option 2 (labeled `Exit`) sends a complex message that includes both input text and an array of intents. The response can include any field that is a valid part of a {{site.data.keyword.conversationshort}} message. (For more information about the structure of message input, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v2?curl=#get-response-to-user-input){: new_window}.) +- Option 2 (labeled `Exit`) sends a complex message that includes both input text and an array of intents. The response can include any field that is a valid part of a {{site.data.keyword.conversationshort}} message. (For more information about the structure of message input, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2?curl=#get-response-to-user-input){: external}.) ```json { diff --git a/dialog-runtime.md b/dialog-runtime.md index 2dc9ccac..32be9c06 100644 --- a/dialog-runtime.md +++ b/dialog-runtime.md @@ -12,6 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -107,7 +108,7 @@ The following `output` object JSON format is supported for backwards compatibili There are response types other than a text response that you can define. See [Responses](/docs/services/assistant?topic=assistant-dialog-overview#dialog-overview-responses) for more details. -You can learn more about the /message API call from the [API reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v2){: new_window}. +You can learn more about the /message API call from the [API reference](https://{DomainName}/apidocs/assistant/assistant-v2){: external}. ### Retaining information across dialog turns {: #dialog-runtime-context} diff --git a/dialog-slots.md b/dialog-slots.md index a00ba499..ef4a4000 100644 --- a/dialog-slots.md +++ b/dialog-slots.md @@ -12,6 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -689,6 +690,6 @@ In the JSON editor for the Found condition, reset the value of the $animal conte ## Slots examples {: #dialog-slots-examples} -To access JSON files that implement different common slot usage scenarios, go to the community [conversation repo ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/community/tree/master/watson-assistant){: new_window} in GitHub. +To access JSON files that implement different common slot usage scenarios, go to the community [conversation repo](https://github.com/watson-developer-cloud/community/tree/master/watson-assistant){: external} in GitHub. To explore an example, download one of the example JSON files, and then import it as a new dialog skill. From the Dialog tab, you can review the dialog nodes to see how slots were implemented to address different use cases. diff --git a/dialog-tips.md b/dialog-tips.md index 93e192cd..47fa268a 100644 --- a/dialog-tips.md +++ b/dialog-tips.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -88,7 +89,7 @@ It can be difficult to know the syntax to use in your dialog node to accurately See [Expression language methods for String](/docs/services/assistant?topic=assistant-dialog-methods#dialog-methods-strings) to learn about more methods you can use. -- **Dealing with multiple intents**: A user enters input that expresses a wish to complete two separate tasks. `I want to open a savings account and apply for a credit card.` How does the dialog recognize and address both of them? See the [Compound questions](https://sodoherty.ai/2017/02/06/compound-questions/){: new_window} entry from Simon O'Doherty's blog for strategies you can try. (Simon is a developer on the {{site.data.keyword.conversationshort}} team.) +- **Dealing with multiple intents**: A user enters input that expresses a wish to complete two separate tasks. `I want to open a savings account and apply for a credit card.` How does the dialog recognize and address both of them? See the [Compound questions](https://sodoherty.ai/2017/02/06/compound-questions/){: external} entry from Simon O'Doherty's blog for strategies you can try. (Simon is a developer on the {{site.data.keyword.conversationshort}} team.) - **Dealing with ambiguous intents**: A user enters input that expresses a wish that is ambiguous enough that your assistant finds two or more nodes with intents that could potentially address it. How does the dialog know which dialog branch to follow? If you enable disambiguation, it can show users their options and ask the user to pick the right one. See [Disambiguation](/docs/services/assistant?topic=assistant-dialog-runtime#dialog-runtime-disambiguation) for more details. diff --git a/dialog-webhooks.md b/dialog-webhooks.md index 4fb53a43..f708a5cc 100644 --- a/dialog-webhooks.md +++ b/dialog-webhooks.md @@ -4,10 +4,13 @@ copyright: years: 2015, 2019 lastupdated: "2019-10-22" +subcollection: assistant + --- {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -278,7 +281,7 @@ The following tips will help you call a {{site.data.keyword.openwhisk_short}} we If the external application that you call returns a response, it must be able to send back a response in JSON format. - Notice the request URL in this example ends in `.json`. By specifying this extension, you take advantage of a feature of web actions that lets you specify the desired content type of the response. Specifying this extension type ensures that, if the web actions can return responses in more than one format, a JSON response will be returned. See [Extra features](/docs/openwhisk?topic=cloud-functions-actions_web#actions_web_extra){: new_window} for more details. + Notice the request URL in this example ends in `.json`. By specifying this extension, you take advantage of a feature of web actions that lets you specify the desired content type of the response. Specifying this extension type ensures that, if the web actions can return responses in more than one format, a JSON response will be returned. See [Extra features](/docs/openwhisk?topic=cloud-functions-actions_web#actions_web_extra){: external} for more details. {: tip} 1. You do not need to add any headers. @@ -309,7 +312,7 @@ The following tips will help you call a {{site.data.keyword.openwhisk_short}} we - When calling a {{site.data.keyword.openwhisk_short}} web action, you cannot pass parameters with the same key as parameters that are defined as part of the web action. See [Protected parameters](/docs/openwhisk?topic=cloud-functions-actions_web#protected-parameters){: new_window} for more details. + When calling a {{site.data.keyword.openwhisk_short}} web action, you cannot pass parameters with the same key as parameters that are defined as part of the web action. See [Protected parameters](/docs/openwhisk?topic=cloud-functions-actions_web#protected-parameters){: external} for more details. {: note} 1. You can edit the dialog node response to include only the section of the response that you want to display to users. diff --git a/entities.md b/entities.md index 5968a4d7..60881799 100644 --- a/entities.md +++ b/entities.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-09-179" +lastupdated: "2019-10-24" keywords: entity, entity value, contextual entity, dictionary entity, pattern entity, entity synonym, annotate mentions @@ -12,6 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -70,7 +71,7 @@ When you define an annotation-based entity, which is also referred to as a conte If you choose to define entity values by using annotations, add at least 10 annotations per entity to give the contextual entity model enough data to be reliable. -To learn more about contextual entities, [read this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/contextual-entities-with-ibm-watson-assistant-f41b2e0ca82e). +To learn more about contextual entities, [read this blog post](https://medium.com/ibm-watson/contextual-entities-with-ibm-watson-assistant-f41b2e0ca82e){: external}. ## Creating entities {: #entities-creating-task} @@ -336,7 +337,7 @@ The following video demonstrates how to annotate entity mentions. -**Tutorial**: To walk through a tutorial that shows you how to define contextual entities before you add your own, go to [Tutorial: Defining contextual entities ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/cloud/garage/demo/try-watson-assistant-contextual-entities){: new_window}. +**Tutorial**: To walk through a tutorial that shows you how to define contextual entities before you add your own, go to [Tutorial: Defining contextual entities](https://www.ibm.com/cloud/garage/demo/try-watson-assistant-contextual-entities){: external}. The contextual entities tutorial shows a slightly older veresion of the user interface. But the concepts it covers are the same, so it is still a worthwhile exercise. {: note} diff --git a/expression-language.md b/expression-language.md index 82744f82..c881da3d 100644 --- a/expression-language.md +++ b/expression-language.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -25,7 +26,7 @@ subcollection: assistant # Expressions for accessing objects {: #expression-language} -You can write expressions that access objects and properties of objects by using the Spring Expression (SpEL) language. For more information, see [Spring Expression Language (SpEL) ![External link icon](../../icons/launch-glyph.svg "External link icon")](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/expressions.html){: new_window}. +You can write expressions that access objects and properties of objects by using the Spring Expression (SpEL) language. For more information, see [Spring Expression Language (SpEL)](https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions){: external}. {: shortdesc} ## Evaluation syntax diff --git a/feedback.md b/feedback.md index 1f368b1e..7e366767 100644 --- a/feedback.md +++ b/feedback.md @@ -32,7 +32,7 @@ We value your opinion and want to hear it. ## Share your ideas {: #feedback-ideas-portal} -To share ideas or suggest new features for the {{site.data.keyword.conversationfull}} service, go to the [IBM Data and AI Ideas Portal ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://ibm-data-and-ai.ideas.aha.io/?project=ASSISTANT){: new_window}. +To share ideas or suggest new features for the {{site.data.keyword.conversationfull}} service, go to the [IBM Data and AI Ideas Portal](https://ibm-data-and-ai.ideas.aha.io/?project=ASSISTANT){: external}. ## Did the documentation help? {: #feedback-doc} diff --git a/filter-reference.md b/filter-reference.md index 3737cc41..3d0cb6e5 100644 --- a/filter-reference.md +++ b/filter-reference.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -31,7 +32,7 @@ The `filter` parameter is a cacheable query that limits the results to those mat To see examples of filter queries, see [Examples](#filter-reference-examples). -For more information about the /logs `GET` method and its response model, refer to the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#list-log-events-in-a-workspace){: new_window}. +For more information about the /logs `GET` method and its response model, refer to the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#list-log-events-in-a-workspace){: external}. ## Filter query syntax {: #filter-reference-syntax} diff --git a/getting-started.md b/getting-started.md index e7f03342..ae02ef81 100644 --- a/getting-started.md +++ b/getting-started.md @@ -12,9 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} -{:deprecated: .deprecated} -{:important: .important} -{:note: .note} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -43,11 +41,11 @@ In this short tutorial, we introduce {{site.data.keyword.conversationfull}} and You need a service instance to start. {: hide-dashboard} -1. {: hide-dashboard} Go to the [{{site.data.keyword.conversationshort}} ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/catalog/services/watson-assistant) page in the {{site.data.keyword.cloud}} catalog. +1. {: hide-dashboard} Go to the [{{site.data.keyword.conversationshort}}](https://cloud.ibm.com/catalog/services/watson-assistant){: external} page in the {{site.data.keyword.cloud}} catalog. The service instance will be created in the **default** resource group if you do not choose a different one, and it *cannot* be changed later. This group is sufficient for the purposes of trying out the product. - If you're creating an instance for more robust use, then learn more about [resource groups ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/docs/resources/bestpractice_rgs#bp_resourcegroups){: new_window}. + If you're creating an instance for more robust use, then learn more about [resource groups](https://{DomainName}/docs/resources/bestpractice_rgs#bp_resourcegroups){: external}. 1. {: hide-dashboard} Sign up for a free {{site.data.keyword.cloud_notm}} account or log in. 1. {: hide-dashboard} Click **Create**. diff --git a/information-security.md b/information-security.md index 3eea25f6..083543ba 100644 --- a/information-security.md +++ b/information-security.md @@ -36,15 +36,15 @@ The products, services, and other capabilities described herein are not suitable If you need to request GDPR support for {{site.data.keyword.cloud}} {{site.data.keyword.watson}} resources that are created -- In the European Union, see [Requesting support for IBM Cloud Watson resources created in the European Union![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/docs/services/watson/getting-started-gdpr-sar#request-EU){: new_window}. -- Outside the European Union, see [Requesting support for resources outside the European Union![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/docs/services/watson/getting-started-gdpr-sar#request-non-EU){: new_window}. +- In the European Union, see [Requesting support for IBM Cloud Watson resources created in the European Union](https://cloud.ibm.com/docs/services/watson/getting-started-gdpr-sar#request-EU){: external}. +- Outside the European Union, see [Requesting support for resources outside the European Union](https://cloud.ibm.com/docs/services/watson/getting-started-gdpr-sar#request-non-EU){: external}. ## European Union General Data Protection Regulation (GDPR) {: #information-security-gdpr} IBM is committed to providing our clients and partners with innovative data privacy, security and governance solutions to assist them on their journey to GDPR compliance. -Learn more about IBM's own GDPR readiness journey and our GDPR capabilities and offerings to support your compliance journey [here ![External link icon](../../icons/launch-glyph.svg "External link icon")](../../icons/launch-glyph.svg "External link icon")](http://www.ibm.com/gdpr){: new_window}. +Learn more about IBM's own GDPR readiness journey and our GDPR capabilities and offerings to support your compliance journey [here](http://www.ibm.com/gdpr){: external}. ## Health Insurance Portability and Accountability Act (HIPAA) {: #information-security-hipaa} @@ -119,6 +119,6 @@ curl -X DELETE -u "apikey:3Df... ...Y7Pc9" An empty JSON object `{}` is returned. -For more information, see the [API reference](https://cloud.ibm.com/apidocs/assistant-v1?curl=#delete-labeled-data). +For more information, see the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#delete-labeled-data). **Note:** Delete requests are processed in batches and may take up to 24 hours to complete. diff --git a/intent-recommendations.md b/intent-recommendations.md index 7f59cbba..d742d627 100644 --- a/intent-recommendations.md +++ b/intent-recommendations.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -39,7 +40,7 @@ The following video provides a 3 1/2-minute overview of intent and intent user e -To learn more about how intent recommendations can help you build a useful bot faster, [read this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/let-watson-train-your-virtual-assistant-57bd53b12bc3){: new_window}. +To learn more about how intent recommendations can help you build a useful bot faster, [read this blog post](https://medium.com/ibm-watson/let-watson-train-your-virtual-assistant-57bd53b12bc3){: external}. Mine your existing data to do one of the following things: diff --git a/logs-resources.md b/logs-resources.md index 2b57a60e..f7aac3df 100644 --- a/logs-resources.md +++ b/logs-resources.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-10-23" +lastupdated: "2019-10-24" subcollection: assistant @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -31,11 +32,11 @@ Learn about APIs and other tools you can use to access and analyze log data. ## API {: #logs-resources-api} -You can use the `/logs` API to list events from the transcripts of conversations that occured between your users and your assistant. For detailed API reference documentation, see [List log events ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1#list-log-events-in-a-workspace). +You can use the `/logs` API to list events from the transcripts of conversations that occured between your users and your assistant. For detailed API reference documentation, see [List log events](https://cloud.ibm.com/apidocs/assistant/assistant-v1#list-log-events-in-a-workspace)(: external). The number of days that logs are stored differs by service plan type. See [Log limits](/docs/services/assistant?topic=assistant-logs#logs-limits) for details. -For a Python script you can run to export logs and convert them to CSV format, download the `export_logs.py` file from the [Watson Assistant GitHub ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/community/blob/master/watson-assistant/export_logs.py) repository. +For a Python script you can run to export logs and convert them to CSV format, download the `export_logs.py` file from the [Watson Assistant GitHub)](https://github.com/watson-developer-cloud/community/blob/master/watson-assistant/export_logs.py){: external} repository. ## Logs-related terminology {: #logs-resources-terminology} @@ -61,7 +62,7 @@ First, review the definitions of terms that are associated with {{site.data.keyw User metrics allow you to see, for example, the number of unique users who have engaged with your assistant, or the average number of conversations per user over a given time interval on the [Overview page](/docs/services/assistant?topic=assistant-logs-overview). User metrics are enabled by using a unique `User ID` parameter. -To specify the `User ID` for a message sent using the `/message` API, include the `user_id` property in your global [context ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v2#send-user-input-to-assistant){: new_window}, as in this example: +To specify the `User ID` for a message sent using the `/message` API, include the `user_id` property in your global [context](https://cloud.ibm.com/apidocs/assistant/assistant-v2#send-user-input-to-assistant){: external}, as in this example: ```json "context": { @@ -74,7 +75,7 @@ To specify the `User ID` for a message sent using the `/message` API, include th ``` {: codeblock} -If your application is still using the older [v1 runtime API ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#get-response-to-user-input){: new_window}, the context format is different: +If your application is still using the older [v1 runtime API](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#get-response-to-user-input){: external}, the context format is different: {: note} ```json @@ -115,9 +116,9 @@ To delete messages using `customer_id` values, see the [Information security](/d IBM created Jupyter notebooks that you can use to analyze your log data in more detail. A Jupyter notebook is a web-based environment for interactive computing. You can run small pieces of code that process your data, and you can immediately view the results of your computation. -There is a set of notebooks that you can use with standard Python tools and a set that is designed for optimal use with {{site.data.keyword.DSX_full}}. {{site.data.keyword.DSX_short}} is a product that provides an environment in which you can pick and choose the tools you need to analyze and visualize data, to cleanse and shape data, to ingest streaming data, or to create, train, and deploy machine learning models. See the [product documentation ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/welcome-main.html){:new_window} for more details. +There is a set of notebooks that you can use with standard Python tools and a set that is designed for optimal use with {{site.data.keyword.DSX_full}}. {{site.data.keyword.DSX_short}} is a product that provides an environment in which you can pick and choose the tools you need to analyze and visualize data, to cleanse and shape data, to ingest streaming data, or to create, train, and deploy machine learning models. See the [product documentation](https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/welcome-main.html){: external} for more details. -To learn more about how notebooks can help you improve your assistant, [read this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/continuously-improve-your-watson-assistant-with-jupiter-notebooks-60231df4f01f). +To learn more about how notebooks can help you improve your assistant, [read this blog post](https://medium.com/ibm-watson/continuously-improve-your-watson-assistant-with-jupiter-notebooks-60231df4f01f){: external}. The following notebooks are available: @@ -125,29 +126,29 @@ The following notebooks are available: - **Effectiveness**: Performs a deeper analysis of your logs to help you understand the steps you can take to improve your assistant. -The [Watson Assistant Continuous Improvement Best Practices Guide ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/downloads/cas/V0XQ0ZRE) describes how to get the most out of the notebooks. +The [Watson Assistant Continuous Improvement Best Practices Guide](https://www.ibm.com/downloads/cas/V0XQ0ZRE){: external} describes how to get the most out of the notebooks. ### Using the notebooks with {{site.data.keyword.DSX}} {: #logs-resources-notebooks-studio} If you choose to use the notebooks that are designed for use with {{site.data.keyword.DSX}}, the steps are roughly these: -1. Create a {{site.data.keyword.DSX}} account, [create a project ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/projects.html){:new_window}, and add a Cloud Object Storage account to it. -1. From the {{site.data.keyword.DSX}} community, get the [Measure Watson Assistant Performance notebook ![External link icon](../../icons/launch-glyph.svg "External link icon")]( https://dataplatform.cloud.ibm.com/exchange/public/entry/view/133dfc4cd1480bbe4eaa78d3f635e568). +1. Create a {{site.data.keyword.DSX}} account, [create a project](https://dataplatform.cloud.ibm.com/docs/content/wsj/getting-started/projects.html){: external}, and add a Cloud Object Storage account to it. +1. From the {{site.data.keyword.DSX}} community, get the [Measure Watson Assistant Performance notebook](https://dataplatform.cloud.ibm.com/exchange/public/entry/view/133dfc4cd1480bbe4eaa78d3f635e568){: external}. 1 Follow the step-by-step instructions provided with the notebook to analyze a subset of the dialog exchanges from the logs. The insights are visualized in ways that make it easier to understand the assistant's coverage and effectiveness. 1. Export a sample set of the logs from ineffective conversations, and then analyze and annotate them. For example, indicate whether a response is correct. If correct, mark whether it is helpful. If a response is incorrect, then identify the root cause, the wrong intent or entity was detected, for example, or the wrong dialog node was triggered. After identifying the root cause, indicate what the correct choice would have been. -1. Feed the annotated spreadsheet to the [Analyze Watson Assistant Effectiveness notebook](https://dataplatform.cloud.ibm.com/exchange/public/entry/view/133dfc4cd1480bbe4eaa78d3f636921c). +1. Feed the annotated spreadsheet to the [Analyze Watson Assistant Effectiveness notebook](https://dataplatform.cloud.ibm.com/exchange/public/entry/view/133dfc4cd1480bbe4eaa78d3f636921c){: external}. This process helps you to understand the steps you can take to improve your assistant. There is no way to automatically apply what you learn back to your service instance. Keep track of any changes you make to improve the system, so you can subsequently apply them to the training data of your dialog skill directly. ### Using the notebooks with standard Python tools {: #logs-resources-notebooks-python} -If you choose to use standard Python tools to run the notebooks, you can get the notebooks from the [IBM GitHub repository](https://github.com/watson-developer-cloud/assistant-improve-recommendations-notebook/tree/master/notebook). Be sure to run them in the following order: +If you choose to use standard Python tools to run the notebooks, you can get the notebooks from the [IBM GitHub repository](https://github.com/watson-developer-cloud/assistant-improve-recommendations-notebook/tree/master/notebook){: external}. Be sure to run them in the following order: 1. Measure Notebook.ipynb 1. Effectiveness Notebook.ipynb diff --git a/logs.md b/logs.md index 685c6dc8..0de5d275 100644 --- a/logs.md +++ b/logs.md @@ -12,6 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -129,7 +130,7 @@ Applications that use the older v1 runtime API must specify a deployment ID in e For assistants or custom apps that use the v2 version of the API, your assistant automatically includes a system id and skill id with each /message call, so you can choose a data source by assistant name instead of using a deployment ID. -To add the deployment ID, v1 API users include the deployment property inside the metadata of the [context ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#get-response-to-user-input){: new_window}, as in this example: +To add the deployment ID, v1 API users include the deployment property inside the metadata of the [context](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#get-response-to-user-input){: external}, as in this example: ```json "context" : { diff --git a/migrate.md b/migrate.md index 5384608c..975117cc 100644 --- a/migrate.md +++ b/migrate.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -70,7 +71,7 @@ To migrate your service instance, complete these steps: A message is displayed when the process is done. If you have other service instances to migrate, you can continue migrating other service instances, or click **Done**. -1. **Premium plan one-time step**: If the service instance you are migrating was created as part of a Premium plan, you must inform the service team that you are migrating a Premium plan instance. To do so, create a case from [IBM Cloud Support ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/unifiedsupport/supportcenter){: new_window}. +1. **Premium plan one-time step**: If the service instance you are migrating was created as part of a Premium plan, you must inform the service team that you are migrating a Premium plan instance. To do so, create a case from [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter){: external}. There are some additional steps that the service team needs to take on your behalf. Add the following information to the case: diff --git a/recovery.md b/recovery.md index 4fee466f..7522227c 100644 --- a/recovery.md +++ b/recovery.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -28,7 +29,7 @@ subcollection: assistant {{site.data.keyword.conversationfull}} is highly available within multiple {{site.data.keyword.cloud}} locations (for example, Dallas and Washington, DC). However, recovering from potential disasters that affect an entire location requires planning and preparation. {: shortdesc} -You are responsible for understanding your configuration, customization, and usage of {{site.data.keyword.conversationshort}}. You are also responsible for being ready to re-create an instance of the service in a new location and to restore your data in any location. See [How do I ensure zero downtime? ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/overview?topic=overview-zero-downtime#zero-downtime){: new_window} for more information. +You are responsible for understanding your configuration, customization, and usage of {{site.data.keyword.conversationshort}}. You are also responsible for being ready to re-create an instance of the service in a new location and to restore your data in any location. See [How do I ensure zero downtime?](/docs/overview?topic=overview-zero-downtime#zero-downtime){: external} for more information. ## High availability {: #recovery-ha} diff --git a/release-notes.md b/release-notes.md index 68e56133..b7486f7c 100644 --- a/release-notes.md +++ b/release-notes.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-10-17" +lastupdated: "2019-10-24" subcollection: assistant @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -40,7 +41,7 @@ Send the version parameter with every API request. {{site.data.keyword.conversat ## Beta features {: #release-notes-beta} -IBM releases services, features, and language support for your evaluation that are classified as beta. These features might be unstable, might change frequently, and might be discontinued with short notice. Beta features also might not provide the same level of performance or compatibility that generally available features provide and are not intended for use in a production environment. Beta features are supported only on the [IBM Developer Answers ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/answers/topics/watson-assistant/){: new_window}. +IBM releases services, features, and language support for your evaluation that are classified as beta. These features might be unstable, might change frequently, and might be discontinued with short notice. Beta features also might not provide the same level of performance or compatibility that generally available features provide and are not intended for use in a production environment. Beta features are supported only on the [IBM Developer Answers](https://developer.ibm.com/answers/topics/watson-assistant/){: external}. ## Updated models {: #release-notes-updated-models} @@ -51,7 +52,7 @@ Existing models that you have trained will not be immediately impacted, but expi **Note:** This updating statement applies to Generally Available (GA) languages and features only. -The following new features and changes to {{site.data.keyword.conversationshort}} are available. Check out our [blog ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/assistant/home) to find in-depth information about how the newest features can benefit your business. +The following new features and changes to {{site.data.keyword.conversationshort}} are available. Check out our [blog](https://medium.com/ibm-watson/assistant/home) to find in-depth information about how the newest features can benefit your business. ## 16 October 2019 {: #16October2019} @@ -377,7 +378,7 @@ The following updates are available in all locations except Dallas currently. Existing Premium plan service instances are not impacted by this change; they continue to use API-based billing methods. Only existing Premium plan users will see the API-based plan listed as the *Premium (API)* plan option. {: note} - See {{site.data.keyword.conversationshort}} [service plan options ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/cloud/watson-assistant/pricing/){: new_window} for more information about all available service plans. + See {{site.data.keyword.conversationshort}} [service plan options](https://www.ibm.com/cloud/watson-assistant/pricing/){: external} for more information about all available service plans. - **Intent user example recommendations ![Plus or Premium plan only](images/plus.png)**: You can upload a file that contains raw user inputs, such as user inquiries from a call center log, that Watson can analyze and mine for intent user example candidates. See [Adding examples from log files](/docs/services/assistant?topic=assistant-intent-recommendations#intent-recommendations-get-example-recommendations). @@ -441,12 +442,12 @@ The following updates are available in all locations except Dallas currently. ## 26 September 2018 {: #26September2018} -- **{{site.data.keyword.conversationfull}} is available in {{site.data.keyword.icpfull}}**: See the [{{site.data.keyword.icpfull}} documentation ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/support/knowledgecenter/en/SSBS6K_2.1.0.3/featured_applications/watson_assistant.html) for more information. +- **{{site.data.keyword.conversationfull}} is available in {{site.data.keyword.icpfull}}**: See the [{{site.data.keyword.icpfull}} documentation](https://www.ibm.com/support/knowledgecenter/en/SSBS6K_2.1.0.3/featured_applications/watson_assistant.html) for more information. ## 21 September 2018 {: #21September2018} -- **New API version**: The current API version is now `2018-09-20`. In this version, the `errors[].path` attribute of the error object that is returned by the API is expressed as a [JSON Pointer ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://tools.ietf.org/html/rfc6901) instead of in dot notation form. +- **New API version**: The current API version is now `2018-09-20`. In this version, the `errors[].path` attribute of the error object that is returned by the API is expressed as a [JSON Pointer](https://tools.ietf.org/html/rfc6901) instead of in dot notation form. - **Web actions support**: You can now call {{site.data.keyword.openwhisk_short}} web actions from a dialog node. See [Making programmatic calls from a dialog node](/docs/services/assistant?topic=assistant-dialog-actions-client) for more details. ## 15 August 2018 @@ -513,9 +514,9 @@ The following updates are available in all locations except Dallas currently. For all new and existing service instances in other regions, you continue to use service credentials (`{username}:{password}`) for authentication. - When you use any of the Watson SDKs, you can pass the API key and let the SDK manage the lifecycle of the tokens. For more information and examples, see [Authentication ![External link icon](../../icons/launch-glyph.svg "External link icon")]https://{DomainName}/apidocs/assistant-v2#authentication){: new_window} in the API reference. + When you use any of the Watson SDKs, you can pass the API key and let the SDK manage the lifecycle of the tokens. For more information and examples, see [Authentication]https://{DomainName}/apidocs/assistant/assistant-v2#authentication){: external} in the API reference. - If you are not sure which type of authentication to use, view the {{site.data.keyword.conversationshort}} credentials by clicking the service instance from the Services section of the [{{site.data.keyword.Bluemix_notm}} Resource List ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com){: new_window}. + If you are not sure which type of authentication to use, view the {{site.data.keyword.conversationshort}} credentials by clicking the service instance from the Services section of the [{{site.data.keyword.Bluemix_notm}} Resource List](https://cloud.ibm.com){: external}. ## 25 May 2018 {: #25May2018} @@ -528,7 +529,7 @@ The following updates are available in all locations except Dallas currently. Now, the hypertext link is rendered as if on a web page. It is displayed like this: - `Contact us at` [ibm.com](https://www.ibm.com){: new_window}. + `Contact us at` [ibm.com](https://www.ibm.com){: external}. Remember, you must use the appropriate type of syntax in your responses for the client application to which you will deploy the conversation. Only use HTML syntax if your client application can interpret it properly. Other integration channels might expect other formats. @@ -552,9 +553,9 @@ The following updates are available in all locations except Dallas currently. ## 15 March 2018 {: #15March2018} -- **Introducing {{site.data.keyword.conversationfull}}**: {{site.data.keyword.ibmwatson}} Conversation has been renamed. It is now called {{site.data.keyword.conversationfull}}. The name change reflects the fact that {{site.data.keyword.conversationshort}} is expanding to provide prebuilt content and tools that help you more easily share the virtual assistants you build. Read [this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/blogs/watson/2018/03/the-future-of-watson-conversation-watson-assistant/) for more details. +- **Introducing {{site.data.keyword.conversationfull}}**: {{site.data.keyword.ibmwatson}} Conversation has been renamed. It is now called {{site.data.keyword.conversationfull}}. The name change reflects the fact that {{site.data.keyword.conversationshort}} is expanding to provide prebuilt content and tools that help you more easily share the virtual assistants you build. Read [this blog post](https://www.ibm.com/blogs/watson/2018/03/the-future-of-watson-conversation-watson-assistant/) for more details. -- **New REST APIs and SDKs are available for Watson Assistant**: The new APIs are functionally identical to the existing Conversation APIs, which continue to be supported. For more information about the Watson Assistant APIs, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v1){: new_window}. +- **New REST APIs and SDKs are available for Watson Assistant**: The new APIs are functionally identical to the existing Conversation APIs, which continue to be supported. For more information about the Watson Assistant APIs, see the [API Reference](https://{DomainName}/apidocs/assistant/assistant-v1){: external}. - **Dialog enhancements**: The following features were added to the dialog tool: @@ -580,7 +581,7 @@ The following updates are available in all locations except Dallas currently. - **New API version**: The current API version is now `2018-02-16`. This version introduces the following changes: - - A new `include_audit` parameter is now supported on most GET requests. This is an optional boolean parameter that specifies whether the response should include the audit properties (`created` and `updated` timestamps). The default value is `false`. (If you are using an API version earlier than `2018-02-16`, the default value is `true`.) For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v1){: new_window}. + - A new `include_audit` parameter is now supported on most GET requests. This is an optional boolean parameter that specifies whether the response should include the audit properties (`created` and `updated` timestamps). The default value is `false`. (If you are using an API version earlier than `2018-02-16`, the default value is `true`.) For more information, see the [API Reference](https://{DomainName}/apidocs/assistant/assistant-v1){: external}. - Responses from API calls using the new version include only properties with non-`null` values. @@ -598,8 +599,8 @@ The following updates are available in all locations except Dallas currently. {: #29January2018} - The {{site.data.keyword.conversationshort}} REST API now supports new request parameters: - - Use the `append` parameter when updating a workspace to indicate whether the new workspace data should be added to the existing data, rather than replacing it. For more information, see [Update workspace ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#update-workspace){: new_window}. - - Use the `nodes_visited_details` parameter when sending a message to indicate whether the response should include additional diagnostic information about the nodes that were visited during processing of the message. For more information, see [Send message ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#get-response-to-user-input){: new_window}. + - Use the `append` parameter when updating a workspace to indicate whether the new workspace data should be added to the existing data, rather than replacing it. For more information, see [Update workspace](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#update-workspace){: external}. + - Use the `nodes_visited_details` parameter when sending a message to indicate whether the response should include additional diagnostic information about the nodes that were visited during processing of the message. For more information, see [Send message](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#get-response-to-user-input){: external}. ## 23 January 2018 {: #23January2018} @@ -729,7 +730,7 @@ The following updates are available in all locations except Dallas currently. **Note:** Accent normalization is enabled for Portuguese, Spanish, French, and Czech. -- **Workspace opt-out flag**: The {{site.data.keyword.conversationshort}} REST API now supports an opt-out flag for workspaces. This flag indicates that workspace training data such as intents and entities are not to be used by IBM for general service improvements. For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#data-collection){: new_window} +- **Workspace opt-out flag**: The {{site.data.keyword.conversationshort}} REST API now supports an opt-out flag for workspaces. This flag indicates that workspace training data such as intents and entities are not to be used by IBM for general service improvements. For more information, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#data-collection){: external} ## 7 August 2017 {: #7August2017} @@ -751,7 +752,7 @@ The following updates are available in all locations except Dallas currently. ## 19 July 2017 {: #19July2017} -- The {{site.data.keyword.conversationshort}} REST API now supports access to dialog nodes. For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#list-dialog-nodes){: new_window}. +- The {{site.data.keyword.conversationshort}} REST API now supports access to dialog nodes. For more information, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#list-dialog-nodes){: external}. ## 14 July 2017 {: #14July2017} @@ -828,7 +829,7 @@ The following updates are available in all locations except Dallas currently. {: #26May2017} - The current API version is now `2017-05-26`. This version introduces the following changes: - - The schema of ErrorResponse objects has changed. This change affects all endpoints and methods. For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant){: new_window}. + - The schema of ErrorResponse objects has changed. This change affects all endpoints and methods. For more information, see the [API Reference](https://{DomainName}/apidocs/assistant){: external}. - The internal schema used to represent dialog nodes in exported workspace JSON has changed. If you use the `2017-05-26` API to import a workspace that was exported using an earlier version, some dialog nodes might not import correctly. For best results, always import a workspace using the same version that was used to export it. ## 25 May 2017 @@ -865,7 +866,7 @@ The following updates are available in all locations except Dallas currently. - entity value synonyms - logs - For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v1){: new_window}. + For more information, see the [API Reference](https://{DomainName}/apidocs/assistant/assistant-v1){: external}. - The behavior of the /messages `POST` method has changed the handling of entities and intents specified as part of the message input: - If you specify intents on input, your assistant uses the intents you specify, but uses natural language processing to detect entities in the user input. - If you specify entities on input, your assistant uses the entities you specify, but uses natural language processing to detect intents in the user input. @@ -884,7 +885,7 @@ The {{site.data.keyword.conversationshort}} REST API now supports access to the - examples - counterexamples -For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://{DomainName}/apidocs/assistant-v1){: new_window}. +For more information, see the [API Reference](https://{DomainName}/apidocs/assistant/assistant-v1){: external}. ## 7 March 2017 {: #7March2017} diff --git a/resources.md b/resources.md index 9c3d1e9d..55e93b2f 100644 --- a/resources.md +++ b/resources.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -31,50 +32,50 @@ Links to resources, videos, tutorials, and articles that can help you to get sta ## Developer resources {: #resources-for-developers} -- [IBM Code Bot Asset Exchange ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/code/exchanges/bots/){: new_window} +- [IBM Code Bot Asset Exchange](https://developer.ibm.com/code/exchanges/bots/){: external} ## Developer resources for building assistants {: #resources-for-bots} -- [Codeless test automation for your assistant ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://chatbotsmagazine.com/10-minutes-codeless-test-automation-for-ibm-watson-chatbots-d71eac9626d7){: new_window} -- [Retail chat app ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/patterns/create-cognitive-retail-chatbot/){: new_window} -- [Cognitive Banking chatbot ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/patterns/create-cognitive-banking-chatbot/){: new_window} -- [Pizza ordering chatbot using slots ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/patterns/assemble-a-pizza-ordering-chatbot-dialog/){: new_window} -- [Create an Alexa skill with serverless and a conversation ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/patterns/create-an-alexa-skill-with-serverless-and-a-conversation/){: new_window} -- [Adding a chatbot to WordPress with {{site.data.keyword.conversationshort}} ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://wordpress.org/plugins/conversation-watson/){: new_window} -- [Tutorial: Build a database-driven Slackbot ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/docs/tutorials/slack-chatbot-database-watson.html){: new_window} -- [Tutorial: Build a voice-enabled Android chatbot ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/docs/tutorials/android-watson-chatbot.html){: new_window} +- [Codeless test automation for your assistant](https://chatbotsmagazine.com/10-minutes-codeless-test-automation-for-ibm-watson-chatbots-d71eac9626d7){: external} +- [Retail chat app](https://developer.ibm.com/patterns/create-cognitive-retail-chatbot/){: external} +- [Cognitive Banking chatbot](https://developer.ibm.com/patterns/create-cognitive-banking-chatbot/){: external} +- [Pizza ordering chatbot using slots](https://developer.ibm.com/patterns/assemble-a-pizza-ordering-chatbot-dialog/){: external} +- [Create an Alexa skill with serverless and a conversation](https://developer.ibm.com/patterns/create-an-alexa-skill-with-serverless-and-a-conversation/){: external} +- [Adding a chatbot to WordPress with {{site.data.keyword.conversationshort}}](https://wordpress.org/plugins/conversation-watson/){: external} +- [Tutorial: Build a database-driven Slackbot](https://cloud.ibm.com/docs/tutorials/slack-chatbot-database-watson.html){: external} +- [Tutorial: Build a voice-enabled Android chatbot](https://cloud.ibm.com/docs/tutorials/android-watson-chatbot.html){: external} ## Building with Watson videos {: #resources-videos} From an IBM technical deep-dive series. These recordings provide step-by-step instructions and answers. -- [Advanced integrations with {{site.data.keyword.conversationshort}} ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://youtu.be/0rnt54ONtQw){: new_window} -- [Training {{site.data.keyword.conversationshort}} to detect user intent ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://youtu.be/uYw4Tv1Y5tc){: new_window} -- [New tools for dialog scripting ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://youtu.be/QuR54--vD5o){: new_window} +- [Advanced integrations with {{site.data.keyword.conversationshort}}](https://youtu.be/0rnt54ONtQw){: external} +- [Training {{site.data.keyword.conversationshort}} to detect user intent](https://youtu.be/uYw4Tv1Y5tc){: external} +- [New tools for dialog scripting](https://youtu.be/QuR54--vD5o){: external} ## Other videos {: #resources-other-videos} Additional videos created by IBMers. -- [Watson Assistant demos ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/demos/collection/Watson-Assistant/){: new_window}: A collection of resources, including a product tour and hands-on lab. -- [{{site.data.keyword.conversationshort}} Integrations Tutorial ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.youtube.com/watch?v=O3silvVBaC8&t=3s){: new_window}: A 10-minute tutorial you can follow to connect {{site.data.keyword.conversationshort}} with Twilio using Botkit to create a SMS chatbot. -- [Show me how to use {{site.data.keyword.conversationshort}} ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://youtu.be/tUkLIUOm550){: new_window}: A 3-minute overview of the product. -- [Introducing {{site.data.keyword.conversationshort}} service ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://youtu.be/A96nLYSMltA){: new_window}: A 1-minute introduction. -- [Walkthrough of {{site.data.keyword.conversationshort}} ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://youtu.be/ELwWhJGE2P8){: new_window}: A 14-minute technical walkthrough. +- [Watson Assistant demos](https://www.ibm.com/demos/collection/Watson-Assistant/){: external}: A collection of resources, including a product tour and hands-on lab. +- [{{site.data.keyword.conversationshort}} Integrations Tutorial ](https://www.youtube.com/watch?v=O3silvVBaC8&t=3s){: external}: A 10-minute tutorial you can follow to connect {{site.data.keyword.conversationshort}} with Twilio using Botkit to create a SMS chatbot. +- [Show me how to use {{site.data.keyword.conversationshort}}](https://youtu.be/tUkLIUOm550){: external}: A 3-minute overview of the product. +- [Introducing {{site.data.keyword.conversationshort}} service](https://youtu.be/A96nLYSMltA){: external}: A 1-minute introduction. +- [Walkthrough of {{site.data.keyword.conversationshort}}](https://youtu.be/ELwWhJGE2P8){: external}: A 14-minute technical walkthrough. ## Educational materials {: #resources-academy} -- [Watson Academy ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/services/learning/ites.wss/zz-en?pageType=page&c=LNW1G2K9220IL0YX){: new_window} -- [Coursera: Building AI Powered Chatbots Without Programming ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.coursera.org/learn/building-ai-powered-chatbots) +- [Watson Academy](https://www.ibm.com/services/learning/ites.wss/zz-en?pageType=page&c=LNW1G2K9220IL0YX){: external} +- [Coursera: Building AI Powered Chatbots Without Programming](https://www.coursera.org/learn/building-ai-powered-chatbots){: external} ## Blogs {: #resources-blogs} -- [Latest blogs on Medium ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/tag/watson-assistant/latest){: new_window} -- [Simon Burns (IBM Watson developer) on Medium ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/@snrubnomis/conversational-directory-5a5531749295){: new_window} -- [Simon O'Doherty (IBM Watson developer) ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://sodoherty.ai/){: new_window} -- [IBM Watson blog ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/blogs/watson/){: new_window} +- [Latest blogs on Medium](https://medium.com/tag/watson-assistant/latest){: external} +- [Simon Burns (IBM Watson developer) on Medium](https://medium.com/@snrubnomis/conversational-directory-5a5531749295){: external} +- [Simon O'Doherty (IBM Watson developer)](https://sodoherty.ai/){: external} +- [IBM Watson blog](https://www.ibm.com/blogs/watson/){: external} diff --git a/sample-apps.md b/sample-apps.md index 9cf87216..ebd890a6 100644 --- a/sample-apps.md +++ b/sample-apps.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -33,21 +34,21 @@ Explore our sample applications to understand what you can develop with {{site.d The Node.js app shows how {{site.data.keyword.conversationshort}} uses intents in a simple chat interface. It shows the conversation with an end user and the JSON responses at each turn of the conversation. -[See the demo ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://watson-assistant-simple.ng.bluemix.net/){: new_window} or [fork the code ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/assistant-simple){: new_window}. +[See the demo](https://watson-assistant-simple.ng.bluemix.net/){: external} or [fork the code](https://github.com/watson-developer-cloud/assistant-simple){: external}. ## {{site.data.keyword.conversationshort}} customer service demo {: #sample-apps-customer-service} This Node.js app is a fully developed example of the type of app you can build with {{site.data.keyword.conversationshort}} that uses intents, entities, and dialog. -[See the demo ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://watson-assistant-demo.ng.bluemix.net/){: new_window} or [fork the code ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/assistant-demo){: new_window}. +[See the demo](https://watson-assistant-demo.ng.bluemix.net/){: external} or [fork the code](https://github.com/watson-developer-cloud/assistant-demo){: external}. ## {{site.data.keyword.conversationshort}} and {{site.data.keyword.discoveryshort}} {: #sample-apps-with-discovery} This app demonstrates the combination of {{site.data.keyword.conversationshort}} and {{site.data.keyword.discoveryshort}}. First, users pose questions to the {{site.data.keyword.conversationshort}} service. If {{site.data.keyword.conversationshort}} is not able to answer confidently, {{site.data.keyword.conversationshort}} Enhanced executes a call to {{site.data.keyword.discoveryshort}} to provide the user with a list of helpful answers. -[See the demo ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://assistant-with-discovery-openwhisk-demo.ng.bluemix.net/){: new_window} or [fork the code ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/assistant-with-discovery-openwhisk){: new_window}. +[See the demo](https://assistant-with-discovery-openwhisk-demo.ng.bluemix.net/){: external} or [fork the code](https://github.com/watson-developer-cloud/assistant-with-discovery-openwhisk){: external}. ## {{site.data.keyword.conversationshort}} and {{site.data.keyword.toneanalyzershort}} {: #sample-apps-with-tone-analyzer} @@ -57,4 +58,4 @@ This app demonstrates the combination of {{site.data.keyword.conversationshort}} The demo refers to {{site.data.keyword.conversationshort}} by its former name, Watson Conversation. {: note} -[View the demo ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://food-coach.ng.bluemix.net/){: new_window} or [fork the code ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://github.com/watson-developer-cloud/food-coach){: new_window} +[View the demo](https://food-coach.ng.bluemix.net/){: external} or [fork the code](https://github.com/watson-developer-cloud/food-coach){: external} diff --git a/services-information.md b/services-information.md index af0eae4c..caa050bd 100644 --- a/services-information.md +++ b/services-information.md @@ -87,8 +87,8 @@ Unlike API-based plans, which measure usage by the number of API calls made duri 1. **user_id**: A property defined in the API that is sent in the context object of a /message API call. Using this property is the best way to ensure that you accurately attribute /message API calls to unique users. For more information about the user ID property, see the API reference documentation: - - `context.global.system.user_id`: [v2 API](https://cloud.ibm.com/apidocs/assistant-v2#send-user-input-to-assistant) - - `context.metadata.user_id`: [v1 API](https://cloud.ibm.com/apidocs/assistant-v1#get-response-to-user-input) + - `context.global.system.user_id`: [v2 API](https://cloud.ibm.com/apidocs/assistant/assistant-v2#send-user-input-to-assistant) + - `context.metadata.user_id`: [v1 API](https://cloud.ibm.com/apidocs/assistant/assistant-v1#get-response-to-user-input) 1. **session_id**: A property defined in the v2 API that identifies a single conversation between a user and the assistant. A session ID is provided in /message API calls that are generated by the built-in integrations. The session ends when a user closes the chat window or after the chat is inactive for 60 minutes. @@ -159,7 +159,7 @@ The authentication mechanism used by your service instance impacts how you must See [Authenticating with IAM tokens](/docs/services/watson?topic=watson-iam){: external} for more information. - For examples, see [Authentication](https://{DomainName}/apidocs/assistant-v2#authentication){: external} for your language in the API reference. + For examples, see [Authentication](https://{DomainName}/apidocs/assistant/assistant-v2#authentication){: external} for your language in the API reference. ### Data centers {: #services-information-regions} diff --git a/skill-dialog-add.md b/skill-dialog-add.md index a0ec786e..a618ba87 100644 --- a/skill-dialog-add.md +++ b/skill-dialog-add.md @@ -2,7 +2,7 @@ copyright: years: 2015, 2019 -lastupdated: "2019-10-18" +lastupdated: "2019-10-24" keywords: import workspace, import JSON, export JSON @@ -12,6 +12,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -55,7 +56,7 @@ To add a skill, complete the following steps: **Important:** - The imported JSON file must use UTF-8 encoding, without byte order mark (BOM) encoding. - - The maximum size for a skill JSON file is 10MB. If you need to import a larger skill, consider importing the intents and entities separately after you have imported the skill. (You can also import larger skills using the REST API. For more information, see the [API Reference ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/apidocs/assistant-v1?curl=#create-workspace){: new_window}.) + - The maximum size for a skill JSON file is 10MB. If you need to import a larger skill, consider importing the intents and entities separately after you have imported the skill. (You can also import larger skills using the REST API. For more information, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=#create-workspace){: external}.) - The JSON cannot contain tabs, newlines, or carriage returns. Specify the data you want to include: @@ -122,7 +123,7 @@ To download a dialog skill, complete the following steps: 1. Specify a name for the JSON file and where to save it, and then click **Save**. -You can export a skill by using the API also. Include the `export=true` parameter with the request. See the [API reference](https://cloud.ibm.com/apidocs/assistant-v1#get-information-about-a-workspace) for more details. +You can export a 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#get-information-about-a-workspace){: external} for more details. For information about how to download a specific skill version, see [Downloading a skill version](/docs/services/assistant?topic=assistant-versions-export). @@ -160,7 +161,8 @@ To share a dialog skill with other people, you must give them access to the serv - **Platform access roles**: Operator - **Service access roles**: Writer - For more information about roles, see [IAM access ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/docs/iam?topic=iam-userroles). + The service access role assignment is currently ignored. Any person you invite is given full access to the instance and all of its skills and assistants, regardless of the *Service access role* you assign to them. You cannot assign someone to a Reader service access role to give them read-only access to an instance, for example. + {: important} For older instances that are managed by Cloud Foundry, you click *Cloud Foundry* instead of *IAM Services*, choose your organization, and then assign the person to the **Developer** space role. {: note} diff --git a/skill-search-add.md b/skill-search-add.md index c327cea9..a08bfd6e 100644 --- a/skill-search-add.md +++ b/skill-search-add.md @@ -39,14 +39,14 @@ The following 4-minute video provides an overview of the search skill. -To learn more about how search skill can benefit your business, [read this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/adding-search-to-watson-assistant-99e4e81839e5){: new_window}. +To learn more about how search skill can benefit your business, [read this blog post](https://medium.com/ibm-watson/adding-search-to-watson-assistant-99e4e81839e5){: external}. ## How it works {: #skill-search-add-how} The search skill searches for information from a data collection that you create by using the {{site.data.keyword.discoveryshort}} service. -{{site.data.keyword.discoveryshort}} is a service that crawls, converts, and normalizes your unstructured data. The product applies data analysis and cognitive intuition to enrich your data such that you can more easily find and retrieve meaningful information from it later. To read more about {{site.data.keyword.discoveryshort}}, see the [product documentation ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-about){: new_window}. +{{site.data.keyword.discoveryshort}} is a service that crawls, converts, and normalizes your unstructured data. The product applies data analysis and cognitive intuition to enrich your data such that you can more easily find and retrieve meaningful information from it later. To read more about {{site.data.keyword.discoveryshort}}, see the [product documentation](/docs/services/discovery?topic=discovery-about){: external}. Typically, the type of data collection you add to {{site.data.keyword.discoveryshort}} and access from your assistant contains information that is owned by your company. This proprietary information can include FAQs, sales collateral, technical manuals, or papers written by subject matter experts. Mine this dense collection of proprietary information to find answers to customer questions quickly. @@ -105,7 +105,7 @@ The remaining steps differ depending on whether you have access to an existing { - If you do not have a collection or do not want to use any of the data collections that are listed, click **Create a new collection** to add one. Follow the procedure in [Create a data collection](#search-skill-add-create-discovery-collection). - The **Create a new collection** button is not displayed if you have reached the limit to the number of collections you are allowed to create based on your {{site.data.keyword.discoveryshort}} service plan. See [{{site.data.keyword.discoveryshort}} pricing plans ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery/discovery-about?topic=discovery-discovery-pricing-plans){: new_window} for plan limit details. + The **Create a new collection** button is not displayed if you have reached the limit to the number of collections you are allowed to create based on your {{site.data.keyword.discoveryshort}} service plan. See [{{site.data.keyword.discoveryshort}} pricing plans](/docs/services/discovery/discovery-about?topic=discovery-discovery-pricing-plans){: external} for plan limit details. {: note} ## Create a Watson Discovery service instance @@ -133,13 +133,13 @@ If you have a Discovery service Lite plan, you are given an opportunity to upgra 1. Provide the required information for the data source you choose, and then click **Connect**. - For a list of the supported data types and details on how to set up access to them, see [Connecting to data sources ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-sources){: new_window}. + For a list of the supported data types and details on how to set up access to them, see [Connecting to data sources](/docs/services/discovery?topic=discovery-sources){: external}. 1. Indicate the frequency with which you want data from the data source to be synchronized with the collection you are creating in {{site.data.keyword.discoveryshort}}. 1. Specify the information that you want to extract from the data source and include in your {{site.data.keyword.discoveryshort}} collection. The options that are displayed differ depending on the data source type. - - For a Salesforce data source, you select the object types that you want to extract from the source documents. You might select a [Case object type ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm#!) that represents a *case*, which is a customer issue or problem, for example. + - For a Salesforce data source, you select the object types that you want to extract from the source documents. You might select a [Case object type](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm#!){: external} that represents a *case*, which is a customer issue or problem, for example. - For a Sharepoint data source, you specify paths. - For file repositories, you specify directories or files. - For a web crawl data source, specify the base URL of a website that you want to crawl. The web page that you specify and any pages that it links to are crawled and a document is created per web page. @@ -157,12 +157,12 @@ If you have a Discovery service Lite plan, you are given an opportunity to upgra 1. First, you define the collection, and then you upload the documents. Provide the following information: - Collection name. The name must be unique for this service instance. - - Language. Select the language of the files that you are adding to this collection. For information about the languages supported by {{site.data.keyword.discoveryshort}}, see [Language support ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-language-support){: new_window}. + - Language. Select the language of the files that you are adding to this collection. For information about the languages supported by {{site.data.keyword.discoveryshort}}, see [Language support](/docs/services/discovery?topic=discovery-language-support){: external}. - If you are uploading a PDF document and want to extract party, nature, and category information from it, then expand the **Advanced** section and click **Use the Default Contract Configuration with this collection**. See [Collection requirements ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-element-classification#element-collection){: new_window} for more details. + If you are uploading a PDF document and want to extract party, nature, and category information from it, then expand the **Advanced** section and click **Use the Default Contract Configuration with this collection**. See [Collection requirements](/docs/services/discovery?topic=discovery-element-classification#element-collection){: external} for more details. 1. Upload documents. - Supported file types include PDF, HTML, JSON, and DOC files. See [Adding content ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-addcontent){: new_window} for more details. + Supported file types include PDF, HTML, JSON, and DOC files. See [Adding content](/docs/services/discovery?topic=discovery-addcontent){: external} for more details. {: note} No ongoing synchronization of uploaded documents is available. If you want to pick up changes that are made to a document, upload a later version of the document. @@ -269,7 +269,7 @@ The appropriate collection fields to extract data from vary depending on your co To learn more about the structure of the documents in your collection, including the names of fields that contain information you might want to extract, open the collection in {{site.data.keyword.discoveryshort}}, and then click the View data schema icon ![View data schema icon](images/icon-view-data-schema.png). -The source fields are created when the collection is created. To learn more about fields that are generated for you, such as `enriched_text.concepts.text`, see [Configuring your service > Adding enrichments ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-configservice#adding-enrichments){: new_window}. +The source fields are created when the collection is created. To learn more about fields that are generated for you, such as `enriched_text.concepts.text`, see [Configuring your service > Adding enrichments](/docs/services/discovery?topic=discovery-configservice#adding-enrichments){: external}. ## Troubleshooting {: #skill-search-add-troubleshoot} @@ -287,7 +287,7 @@ Review this information for help with performing common tasks. This feature enables you to annotate documents based on text formatting. For example, you can teach {{site.data.keyword.discoveryshort}} that any text in 28-point bold font is a document title. If you apply this information to the collection when you ingest it, you can later use the *title* field as the source for the title section of your search result. - You can also use Smart Document Understanding to split up large documents into segments that are easier to search. For more information, see the the [Smart Document Understanding ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/services/discovery?topic=discovery-sdu) topic in the {{site.data.keyword.discoveryshort}} documentation. + You can also use Smart Document Understanding to split up large documents into segments that are easier to search. For more information, see the the [Smart Document Understanding](/docs/services/discovery?topic=discovery-sdu) topic in the {{site.data.keyword.discoveryshort}} documentation. - **Improve search results**: If you don't like the results you are seeing, review this information for help. @@ -297,7 +297,7 @@ Review this information for help with performing common tasks. For example, you can define a filter that filters out any documents in the data collection that do not mention an intent in the document title or some other metadata field. Or the filter can filter out documents that do not identify an entity as a known entity in the data collection's metadata or that don't mention the entity anywhere in the full text of the document. For details about how to add a search skill response type, see [Adding rich responses](https://cloud.ibm.com/docs/services/assistant?topic=assistant-dialog-overview#dialog-overview-multimedia-add). - For more tips about improving results, read the [Improve your natural language query results from Watson Discovery ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://developer.ibm.com/blogs/improving-your-natural-language-query-results-from-watson-discovery/) blog post. + For more tips about improving results, read the [Improve your natural language query results from Watson Discovery](https://developer.ibm.com/blogs/improving-your-natural-language-query-results-from-watson-discovery/){: external} blog post. ## Next steps {: #skill-search-add-next-steps} diff --git a/toc b/toc index 08f80eb0..c8213224 100644 --- a/toc +++ b/toc @@ -96,7 +96,7 @@ Watson Assistant {: .navgroup-end} {: .navgroup id="reference"} - [API reference](https://cloud.ibm.com/apidocs/assistant-v2) + [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2) dialog-methods.md expression-language.md filter-reference.md diff --git a/troubleshoot.md b/troubleshoot.md index ebb8090c..a9f3e30b 100644 --- a/troubleshoot.md +++ b/troubleshoot.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -30,7 +31,7 @@ Scan the list of known error messages to see if you can find a quick solution. If you cannot find a solution to the issue you are having, try the resources available from the **Developer community** section of the table of contents. -If your service plan covers it, you can get help by creating a case from [IBM Cloud Support ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://cloud.ibm.com/unifiedsupport/supportcenter){: new_window}. +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}. ## Solutions {: #troubleshoot-solutions} diff --git a/upgrade.md b/upgrade.md index 7346b6d6..ef71d5e2 100644 --- a/upgrade.md +++ b/upgrade.md @@ -48,6 +48,6 @@ To upgrade your plan, complete these steps: Currently, you cannot upgrade from a Lite, Standard, or Plus Lite plan to a Plus plan. Instead, purchase the Plus plan first. Export skills from an instance in your existing plan and then import them to an instance in the Plus plan. To start the process of provisioning a Plus plan, fill out [this form](https://ibm.biz/contact-WA-plus){: external}. Alternatively, go to the [plan overview page](https://www.ibm.com/cloud/watson-assistant/pricing/){: external} and start a chat with an IBM representative. Tell them about the type of plan you want to upgrade, and be prepared to provide the plan account ID. {: note} -For answers to common questions about subscriptions, see the [How you're charged ![External link icon](../../icons/launch-glyph.svg "External link icon")](/docs/billing-usage?topic=billing-usage-charges){: new_window}. +For answers to common questions about subscriptions, see the [How you're charged](/docs/billing-usage?topic=billing-usage-charges){: external}. -Still have questions? Contact [IBM Sales ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://www.ibm.com/account/reg/us-en/subscribe?formid=urx-20970){: new_window}. +Still have questions? Contact [IBM Sales](https://www.ibm.com/account/reg/us-en/subscribe?formid=urx-20970){: external}. diff --git a/versions.md b/versions.md index 391dd10a..2c3d27db 100644 --- a/versions.md +++ b/versions.md @@ -10,6 +10,7 @@ subcollection: assistant {:shortdesc: .shortdesc} {:new_window: target="_blank"} +{:external: target="_blank" .external} {:deprecated: .deprecated} {:important: .important} {:note: .note} @@ -37,7 +38,7 @@ This 2 1/2 minute video describes how using versions can help you. -To learn more about how versions can improve the workflow you use to build an assistant, [read this blog post ![External link icon](../../icons/launch-glyph.svg "External link icon")](https://medium.com/ibm-watson/watson-assistant-versions-announcement-d60869b1f5f){: new_window}. +To learn more about how versions can improve the workflow you use to build an assistant, [read this blog post](https://medium.com/ibm-watson/watson-assistant-versions-announcement-d60869b1f5f){: external}. ## Creating a version {: #versions-create}