vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* [Understanding Tune by Example](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-intro)
* [Rules for creating custom prompts and speaker models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-rules)
* [Creating a custom prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-create)
* [Using a custom prompt for speech synthesis](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-use)
* [Managing custom prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts)
* [Managing speaker models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models)



* Using SSML



* [Understanding SSML](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-ssml)
* [SSML elements](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-elements)



* Using phonetic symbols



* [Understanding phonetic symbols](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-symbols)
* [Dutch (Netherlands) symbols](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-nlSymbols-new)
* [English (Australian) symbols](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-auSymbols-new)
Visit the learning center!
: Click the Learning center link that is displayed in the header of the skill pages to find helpful product tours. The tours guide you through the steps to follow to complete a range of tasks, from adding your first intent to a dialog skill to enhancing the conversation in an actions skill. The Additional resources page has links to relevant documentation topics and how-to videos. You can search the resource link titles to find what you're looking for quickly.





 29 October 2020 

System entity support changes
: For English, Brazilian Portuguese, Czech, Dutch, French, German, Italian, and Spanish dialog skills only the new system entities API version is supported. For backward compatibility, both the interpretation and metadata attributes are included with the recognized entity object. The new system entity version is enabled automatically for dialog skills in the Arabic, Chinese, Korean, and Japanese languages. You can choose to use the legacy version of the system entities API by switching to it from the Options>System Entities page. This settings page is not displayed in English, Brazilian Portuguese, Czech, Dutch, French, German, Italian, and Spanish dialog skills because use of the legacy version of the API is no longer supported for those languages. For more information about the new system entities, see [System entities](https://cloud.ibm.com/docs/assistant?topic=assistant-system-entities).





 28 October 2020 

Introducing the actions skill!
: The actions skill is the latest step in the continuing evolution of Watson Assistant as a software as a service application. The actions skill is designed to make it simple enough for anyone to build a virtual assistant. We've removed the need to navigate between intents, entities, and dialog to create conversational flows. Building can all now be done in one simple and intuitive interface.

Web chat integration is created automatically
: When you create a new assistant, a web chat integration is created for you automatically (in addition to the preview link integration, which was created previously). These integrations are added also to the assistant that is auto-generated (named My first assistant) when you create a new service instance.
: The irrelevance detection classification algorithm was updated to make it even smarter out of the box. Now, even before you begin to teach the system about irrelevant requests, it is able to recognize user input that your skill is not designed to address. The new algorithm is enabled by default for any English-language skills that you import or create. For more information, see [Irrelevance detection](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-irrelevance-detection).

Search was added to the Dialog, Intents, and Entities pages
: You can now search within the product. For example, if you want to find any dialog nodes that condition on an intent, you can open the Dialog page and search on the intent name.

v2 Logs API is available
: Use the v2 API logs method to list log events for an assistant. For more information, see the [API reference documentation](https://cloud.ibm.com/apidocs/assistant-data-v2listlogs).

Features not included
: This release does not include the following features, which are available for cloud instances at the time of this release:



* While the web chat integration is now available, service desk support is not included.
* The Facebook, Slack, Intercom, Phone, SMS with Twilio, and WhatsApp integrations are not supported.
* The actions skill is not available.
* You cannot enable FAQ extraction when you add a web crawl data collection to the search skill.
* You cannot use the Activity Tracker service to track user actions for auditing purposes.
* The intent recommendations feature and the enhanced intent detection model are not supported.
* The Learning center and its associated product tours are not available.
* You cannot manage user access at the individual skill and assistant level. You can control only who can access the entire service instance, which includes all of its skills and assistants.
3. Click Apply.
4. Use the Try it out pane to test the digression behavior.

Again, you cannot define the start and end of a digression. The user controls where and when digressions happen. You can only apply settings that determine how a single node participates in one. Because digressions are so unpredictable, it is hard to know how your configuration decisions will impact the overall conversation. To truly see the impact of the choices you made, you must test the dialog.



The #reservation and #cuisine nodes represent two dialog branches that can participate in a single user-directed digression. The digression settings that are configured for each individual node are what make this type of digression possible at run time.

![Shows two dialogs, one that sets the digressions away from the reservation slots node and one that sets the digression into the cuisine node.](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/digression-settings.png)





 Digression usage tips 

This section describes solutions to situations that you might encounter when using digressions.



* Custom return message: For any nodes where you enable returns from digressions away, consider adding wording that lets users know they are returning to where they were in a previous dialog flow. In your text response, use a special syntax that lets you add two versions of the response.

If you do not take action, the same text response is displayed a second time to let users know they have returned to the node they digressed away from. You can make it clearer to users that they have returned to the original conversation thread by specifying a unique message to be displayed when they return.

For example, if the original text response for the node is, What's the order number?, then you might want to display a message like, Now let's get back to where we were. What is the order number? when users return to the node.
Use the v1 /logs method filter parameter to search an application log for specific user data. For example, to search for data specific to a customer_id that matches my_best_customer, the query might be:

curl -X GET -u "apikey:3Df... ...Y7Pc9" "{url}/v2/assistants/{assistant_id}/logs?version=2020-04-01&filter=customer_id::my_best_customer"

where {url} is the appropriate URL for your instance. For more details, see [Service endpoint](https://cloud.ibm.com/apidocs/assistant/assistant-v2service-endpoint).

See the [Filter query reference](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-filter-reference) for additional details.





 Deleting data 

To delete any message log data associated with a specific user that your assistant might have stored, use the DELETE /user_data v1 API method. Specify the customer ID of the user by passing a customer_id parameter with the request.

Only data that was added by using the POST /message API endpoint with an associated customer ID can be deleted using this delete method. Data that was added by other methods cannot be deleted based on customer ID. For example, entities and intents that were added from customer conversations, cannot be deleted in this way. Personal Data is not supported for those methods.

IMPORTANT: Specifying a customer_id will delete all messages with that customer_id that were received before the delete request, across your entire Watson Assistant instance, not just within one skill.

As an example, to delete any message data associated with a user that has the customer ID abc from your Watson Assistant instance, send the following cURL command:

curl -X DELETE -u "apikey:3Df... ...Y7Pc9" "{url}/v2/user_data?customer_id=abc&version=2020-04-01"

where {url} is the appropriate URL for your instance.
* [Using a custom prompt for speech synthesis](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-use)
* [Managing custom prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts)
* [Managing speaker models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models)



New Tune be Example methods
: The service includes eight new methods for working with the Tune by Example feature. The descriptions of the new methods that follow provide links to their entries in the API & SDK reference. You might need to select the Curl tab of the reference to see the new methods.



* The service includes four methods for working with custom prompts:



* [Add a custom prompt](https://cloud.ibm.com/apidocs/text-to-speech/text-to-speechaddcustomprompt): POST /v1/customizations/{customization_id}/prompts/{prompt_id}
* [List custom prompts](https://cloud.ibm.com/apidocs/text-to-speech/text-to-speechlistcustomprompts): GET /v1/customizations/{customization_id}/prompts
* [Get a custom prompt](https://cloud.ibm.com/apidocs/text-to-speech/text-to-speechgetcustomprompt): GET /v1/customizations/{customization_id}/prompts/{prompt_id}
* [Delete a custom prompt](https://cloud.ibm.com/apidocs/text-to-speech/text-to-speechdeletecustomprompt): DELETE /v1/customizations/{customization_id}/prompts/{prompt_id}



* The service includes four methods for working with speaker models:
For more information about language support, see [Supported languages](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-language-support).

Using an intent's user examples to define contextual entities does not affect the classification of that intent. However, entity mentions that you label are also added to that entity as synonyms. And intent classification does use synonym mentions in intent user examples to establish a weak reference between an intent and an entity.



1. From your dialog skill, click the Intents tab.
2. Click an intent to open it.

For this example, the intent buy_supplies defines the order function for an online retailer.

![Select the #buy_supplies intent](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/oe-intent.png)
3. Click Annotate entities, and then review the intent examples for potential entity mentions.

![Shows the Annotate entities toggle](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/oe-annotate.png)
4. Click any word, words, or punctuation that is part of a single entity mention from the intent examples.

In this example, mobile phones is the entity mention.

![Review intent examples](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/oe-click-tokens.png)

A Search box opens that you can use to search for the entity that the highlighted word or phrase is a mention of.

!
For example, the response might ask the user a yes or no question. The dialog will not progress until the user provides more input.
* Skip user input: Use this option when you want to bypass waiting for user input and go directly to the first child node of the current node instead.

The current node must have at least one child node for this option to be available.
* Jump to another dialog node: Use this option when you want the conversation to go directly to an entirely different dialog node. You can use a Jump to action to route the flow to a common dialog node from multiple locations in the tree, for example.

The target node that you want to jump to must exist before you can configure the jump to action to use it.





 Configuring the Jump to action 

If you choose to jump to another node, specify when the target node is processed by choosing one of the following options:



* Condition: If the statement targets the condition section of the selected dialog node, your assistant checks first whether the condition of the targeted node evaluates to true.



* If the condition evaluates to true, the system processes the target node immediately.
* If the condition does not evaluate to true, the system moves to the next sibling node of the target node to evaluate its condition, and repeats this process until it finds a dialog node with a condition that evaluates to true.
* If the system processes all the siblings and none of the conditions evaluate to true, the basic fallback strategy is used, and the dialog evaluates the nodes at the base level of the dialog tree.



Targeting the condition is useful for chaining the conditions of dialog nodes. For example, you might want to first check whether the input contains an intent, such as turn_on, and if it does, you might want to check whether the input contains entities, such as @lights, @radio, or @wipers. Chaining conditions helps to structure larger dialog trees.

Avoid choosing this option when configuring a jump-to from a conditional response that goes to a node situated before the current node in the dialog tree. Otherwise, you can create an infinite loop.
That entity reference, along with all its values or synonyms, is used by the Watson Assistant service classifier for training the intent. For more information, see [Entity as example](https://cloud.ibm.com/docs/assistant?topic=assistant-intentsintents-entity-as-example) in the [Intents](https://cloud.ibm.com/docs/assistant?topic=assistant-intents) topic.

Currently, you can only directly reference closed entities that you define. You cannot directly reference [pattern entities](https://cloud.ibm.com/docs/assistant?topic=assistant-entitiesentities-patterns) or [system entities](https://cloud.ibm.com/docs/assistant?topic=assistant-system-entities).





 8 November 2017 

Watson Assistant connector
: You can use the new Watson Assistant connector tool to connect your workspace to a Slack or Facebook Messenger app that you own, making it available as a chatbot that Slack or Facebook Messenger users can interact with. This tool is available only for the IBM Cloud US South region.





 3 November 2017 

Dialog updates
: The following updates make is easier for you to build a dialog. (See [Building a dialog](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-build) for details.)



* You can add a condition to a slot to make it required only if certain conditions are met. For example, you can make a slot that asks for the name of a spouse required only if a previous (required) slot that asks for marital status indicates that the user is married.
* You can now choose Skip user input as the next step for a node. When you choose this option, after processing the current node, your assistant jumps directly to the first child node of the current node. This option is similar to the existing Jump to next step option, except that it allows for more flexibility. You do not need to specify the exact node to jump to. At run time, your assistant always jumps to whichever node is the first child node, even if the child nodes are reordered or new nodes are added after the next step behavior is defined.
For more information, see [Listing corpora for a custom language model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCorporalistCorpora).
* Copies of all grammar files that you add to your custom language models. To list information about the grammars for your custom models:



* Use the GET /v1/customizations/{customization_id}/grammars method to list information about all grammars for a custom model.
* Use the GET /v1/customizations/{customization_id}/grammars/{grammar_name} method to list information about a specified grammar for a custom model.



For more information, see [Listing grammars for a custom language model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammarslistGrammars).
* Information about all custom words, including their sounds-like and display-as definitions, that you add directly to your custom language models. To list information about the out-of-vocabulary (OOV) words for your custom models:



* Use the GET /v1/customizations/{customization_id}/words method to list information about the words from a custom model. You can use the word_type parameter to list all words from a model, words added directly by the user, words extracted from corpora, or words recognized by grammars.
* Use the GET /v1/customizations/{customization_id}/words/{word_name} method to list information about a specified word from a custom model.



For more information, see [Listing custom words from a custom language model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWordslistWords).



It is a best practice to preserve this information in a format that you can use to re-create your custom language models in the event of a failure. Actively maintaining the information about your custom models and their data, and preparing the calls listed in the following section ahead of time, can enable you to recover as quickly as possible.





 Restoring custom language models
If you specify multiple responses, you can choose to rotate sequentially through the list, choose a response randomly, or output all specified responses.



 Integration channel support 



 Web chat Phone SMS Slack Facebook WhatsApp 

 ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) ![Yes](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/checkmark-icon.svg) 







 Fields 



 Name Type Description Required? 

 response_type string text Y 
 values list A list of one or more objects defining text response. Y 
 values.
When the node is processed, your assistant retrieves a passage from an external data source and returns it as the response to a particular question. This type of search occurs only when the individual dialog node is processed. For more information, see [Adding a search skill response type](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overviewdialog-overview-add-search-skill).
* Actions skill: In the And then field of the step where you want the search to be triggered, choose Search for the answer.



* From the dialog skill's Anything else node: If the assistant has a dialog skill and a search skill, any user input triggers the dialog skill first. The dialog addresses user input that it has a high confidence it can answer correctly. Any queries that would normally trigger the anything_else node in the dialog tree are sent to the search skill instead.

For example, instead of showing a standard message, such as I don't know how to help you with that. the assistant can say, Maybe this information can help:. The assistant passes the user input as the query to your search skill, and returns the search results as the response.

You can prevent the search from being triggered from the anything_else node by following the steps in [Disabling search](https://cloud.ibm.com/docs/services/assistant?topic=assistant-skill-search-addsearch-skill-add-disable).
* When only a search skill is used: If only a search skill is linked to an assistant, and no conversational skill is configured, then a search query is sent to the Discovery service when any user input is received from one of the assistant's integration channels.







 Test the search skill 

After you configure the search, you can send test queries to see the search results that get returned from Discovery by using the Preview pane of the search skill.

To test the full experience that customers will have when they ask questions that are either answered by the dialog or trigger a search, use the Preview button for your assistant.

You cannot test the full end-to-end user experience from the dialog "Try it out" pane.
In the What do you want to analyze? field, enter a term to search for in your documents or select one or more facets, and then click Search to filter the documents.

The search results are displayed in the mining graph. The Facet analysis pane is displayed also. By default, Relevancy analysis is shown.
7. In the drop-down menu from the Facet analysis pane, select Sentiment.
8. In Target facets from the Facet analysis pane, expand the Sentiment Analysis option to see facets that are available for analysis in your documents.
9. Click a facet to explore.

For example, if you click Positive Expression, you can see the following information:



* Positive expressions that were identified in your documents
* Sentiment percentage
* Side-by-side comparison of positive and negative expressions
* Number of instances of the expression
* Expression relevancy



10. Click one or more options in the facet list, or select one or both facet lists, and then click Analyze more.

View the phrase, expression, or target in the Documents or Trends views.



Text from the body field of the document is analyzed. For more information about which field is used for the body text, see [Identifying the text field](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-cm-edit-collectiontext-field).
"voice_telephony": {
"private": {
"sip_to_uri": "sip:watson-conversation@10.10.10.10",
"sip_from_uri": "sip:10.10.10.11",
"sip_request_uri": "sip:test@10.10.10.10:5064;transport=tcp"
},
"sip_call_id": "QjryZsuAS4",
"assistant_phone_number": "18882346789"
}
}
}
}
Show more