vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Notice that when you enter the following URL https://app.eu-de.logging.cloud.ibm.com/xxxxxxxx, you get a 404 page not found error.

Valid formats are https://<ENDPOINT>/ext/ibm-sso/xxxxxxxxxx or https://<ENDPOINT>/xxxxxxxxxx/logs/view
3. [Optional] You can also pass query parameters to refine the view that is displayed.

https://<ENDPOINT>/ext/ibm-sso/WEB_UI_ID?q=<QUERY>&hosts=<HOSTS>&apps=<APPS><=vels=<LEVELS>&t=<TIMEFRAME>

Where



* <ENDPOINT> represents the dashboard URL in the region where the instance is available. See [UI endpoints](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-endpointsendpoints_ui).
* <QUERY> represents the search query that is applied for the view, for example, q=table%3Amangle%20reason%3A%27refresh%20timer%27.

Use %3A to represent a colon (:).

Use %20 to represent a space.

Use %27 to represent a quote (').
* <HOSTS> represents the list of services for which data is included in the view. Notice that these are values that you select in the Sources section of the UI. Multiple hosts are separated by commas, for example, hosts=logging-agent-trkq9,logging-agent-trkq7.
* <APPS> represents the list of apps for which data is included in the view. Multiple apps are separated by commas.
* <LEVELS> represents the list of levels for which data is included in the view. Multiple levels are separated by commas, for example, levels=normal,critical.
* <TIMEFRAME> represents the timeframe that you apply to the data that is displayed through the view. For example, look at the following samples:

When you specify a timeframe of July 12, the value is t=July%2012.
agent_unavailable string A message to display to the user when no agents are available. Y 
 transfer_info object Information used by the web chat service desk integrations for routing the transfer. N 
 transfer_info.target.zendesk.department string A valid department from your Zendesk account. N 
 transfer_info.target.salesforce.button_id string A valid button ID from your Salesforce deployment. N 







 Example 

This example requests a transfer to a live agent and specifies messages to be displayed both to the user and to the agent at the time of transfer.

{
"generic": [
{
"response_type": "connect_to_agent",
"message_to_human_agent": "User asked to speak to an agent.",
"agent_available": {
"message": "Please wait while I connect you to an agent."
},
"agent_unavailable": {
"message": "I'm sorry, but no agents are online at the moment. Please try again later."
}
}
]
}







 date 

Displays an interactive date picker the customer can use to specify a date value.



 Integration channel support 



 Web chat 

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





* In the web chat, the customer can specify a date value either by clicking the interactive date picker or typing a date value in the input field.







 Fields 



 Name Type Description Required? 

 response_type string date Y 







 Example 

This example sends a text response asking the user to specify a date, and then shows an interactive date picker.

{
"generic": [
{
"response_type": "text",
"text": "What day will you be checking in?"
},
{
"response_type": "date"
Defect fix: Fix limitation for asynchronous HTTP interface
: Defect fix: The limitation that was reported with the asynchronous HTTP interface in the Dallas (us-south) location on 16 December 2020 has been addressed. Previously, a small percentage of jobs were entering infinite loops that prevented their execution. Asynchronous HTTP requests in the Dallas data center no longer experience this limitation.





 2 December 2020 

Arabic model renamed to ar-MS_BroadbandModel
: The Arabic language broadband model is now named ar-MS_BroadbandModel. The former name, ar-AR_BroadbandModel, is deprecated. It will continue to function for at least one year but might be removed at a future date. You are encouraged to migrate to the new name at your earliest convenience.





 2 November 2020 

Canadian French models now generally available
: The Canadian French models, fr-CA_BroadbandModel and fr-CA_NarrowbandModel, are now generally available (GA). They were previously beta. They also now support language model and acoustic model customization.



* For more information about supported languages and models, see [Previous-generation languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models).
* For more information about language support for customization, see [Language support for customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support).







 22 October 2020 

Australian English models now generally available
: The Australian English models, en-AU_BroadbandModel and en-AU_NarrowbandModel, are now generally available (GA). They were previously beta. They also now support language model and acoustic model customization.



* For more information about supported languages and models, see [Previous-generation languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models).
1. In Chrome, go to the page within CIS where you are experiencing trouble.
2. Select the Chrome menu (three vertical dots) at the top-right of your browser window, then select Tools > Developer Tools.
3. The Developer Tools open as a docked panel at the side or bottom of the browser window. Click on the Network tab.
4. Select the option Preserve log.
5. The recording starts automatically, and a red "Record network log" icon appears at the top left of the Network tab. If not, click the black "Stop recording network log" icon, to start recording activity in your browser.
6. Refresh the CIS page you are on or go through the steps to reproduce the problem you've been experiencing while Chrome is recording activity.
7. After you have successfully reproduced the issue while recording, right click on any of the items within the Network tab and select Save all as HAR with Content to save a copy of the activity that you recorded.
8. Save the HAR file in a location you choose, and send the file to Support.







 How to generate a HAR file in Safari 



* In Safari, first check to see if you have a "Develop" menu at the top of the screen. If not, go to Safari > Preferences > Advanced and check "Show Develop Menu in menu bar".
* In Safari, go to the page within CIS where you are experiencing trouble.
* Navigate to Develop > Show Web Inspector. This menu option is not available until you browse somewhere beyond Safari's starting page. The Web Inspector opens as a docked panel at the bottom of Safari.
* Click the Network tab.
* Refresh the CIS page that you are on or go through the steps to reproduce the problem you've been experiencing while Safari is recording activity.
* After you have reproduced the issue, Control + click on the resource that you want to capture the HAR file for, and click Export HAR.
* Save the HAR file in a location you choose, and send the file to Support.
headers.from_uri String The SIP URI from the initial SIP INVITE From header. 
 headers.to_uri String The SIP URI from the initial SIP INVITE To header. 







 assistant_interaction_summaries 

The assistant_interaction_summaries object contains the following properties:



Properties of the assistant_interaction_summaries object

 Property Type Description 

 assistant_id String The unique identifier of the assistant. 
 session_id String The unique identifier of the session. 
 turns Array An array of objects describing the Watson Assistant interactions that took place during the conversation. See [assistant_interaction_summaries.turns]](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-cdr-log-referencecdr-log-reference-turns). 





 assistant_interaction_summaries.turns[] 

The objects in the assistant_interaction_summaries.turns array contain the following properties:



Properties of the objects in the assistant_interaction_summaries.turns[] array

 Property Type Description 

 assistant.log_id String A unique identifier for the logged event. This can be used to correlate between message logs and CDR events. 
 assistant.start_timestamp String The time when the request was sent to the assistant, in ISO format (yyyy-MM-ddTHH:mm:ss.SSSZ). 
 assistant.response_milliseconds Number The time (in milliseconds) between when the request was sent and when the response was received from the assistant. 
 request Object A request sent to the assistant. See [assistant_interaction_summaries.turns].request](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-cdr-log-referencecdr-log-reference-request). 
 response Array An array of the response objects associated with the request. 





 assistant_interaction_summaries.turns[].request 

The assistant_interaction_summaries.turns[].request object contains the following properties:



Properties of the assistant_interaction_summaries.turns[].request object

 Property Type Description
If the problem continues, go to [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter).





 BXNUI0203E 

Message: The routes for the app weren't retrieved because of an internal error.

Try again later. If the problem continues, go to [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter).





 BXNUI0300E 

Message: The usage information could not be retrieved.

Try again later. If you see this message again, go to the [IBM Cloud status page](https://cloud.ibm.com/status?selected=status) to check whether a service or component has an issue. Also make sure you have [appropriate access](https://cloud.ibm.com/docs/account?topic=account-iamfaqiam-access). If the error occurs again, follow the [troubleshooting steps for console pages that don’t load](https://cloud.ibm.com/docs/account?topic=account-ts_err). If the problem continues, go to [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter).





 BXNUI0301E 

Message: While the usage information was being retrieved, the organizations could not be retrieved.

Try again later. If you see this message again, go to the [IBM Cloud status page](https://cloud.ibm.com/status?selected=status) to check whether a service or component has an issue. Also make sure you have [appropriate access](https://cloud.ibm.com/docs/account?topic=account-iamfaqiam-access). If the error occurs again, follow the [troubleshooting steps for console pages that don’t load](https://cloud.ibm.com/docs/account?topic=account-ts_err). If the problem continues, go to [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter).
The webhook is triggered only when a message has been processed by your skill, and a response is ready to be returned.

If you enable the setting that returns an error when the webhook call fails, the processing of the assistant is halted entirely if the webhook encounters any issues. Take steps to test the process that you are calling on a regular basis so you will be alerted if the external service is down, and can take actions to prevent all of the message responses from failing to be returned.

If you call an Cloud Functions web action, you can use the logging capability in Cloud Functions to help you troubleshoot your code. You can [download the command line interface](https://cloud.ibm.com/functions/learn/cli), and then enable logging with the [activation polling command](https://cloud.ibm.com/docs/cloud-functions-cli-plugin?topic=cloud-functions-cli-plugin-functions-clicli_activation_poll).





 Troubleshooting the webhook 

The following error codes can help you track down the cause of issues you might encounter. If you have a web chat integration, for example, you will know that your webhook has an issue if every test message you submit returns a message such as, There is an error with the message you just sent, but feel free to ask me something else. If this message is displayed, use a REST API tool, such as cURL, to send a test /message API request, so you can see the error code and full message that is returned.



Error code details

 Error code and message Description 

 422 Webhook responded with invalid JSON body The webhook's HTTP response body could not be parsed as JSON. 
 422 Webhook responded with [500] status code There's a problem with the external service you called. The code failed or the external server refused the request. 
 500 Processor Exception : [connections to all backends failing] An error occurred in the webhook microservice. It could not connect to backend services. 







 Webhook security 

To authenticate the webhook request, verify the JSON Web Token (JWT) that is sent with the request.
Availability and usage Description 

 Previous-generation models Not available. 
 Next-generation models Generally available or beta for next-generation models that support low latency. For more information, see [Supported next-generation language models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ngmodels-ng-supported). 
 WebSocket Parameter of JSON start message 
 Synchronous HTTP Query parameter of POST /v1/recognize method 
 Asynchronous HTTP Query parameter of POST /v1/recognitions method 







 max_alternatives 

An optional integer that specifies the maximum number of alternative hypotheses that the service returns. By default, the service returns a single final hypothesis. For more information, see [Maximum alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metadatamax-alternatives).



Table 17. The max_alternatives parameter

 Availability and usage Description 

 Previous-generation models Generally available for all languages. 
 Next-generation models Generally available for all languages. 
 WebSocket Parameter of JSON start message 
 Synchronous HTTP Query parameter of POST /v1/recognize method 
 Asynchronous HTTP Query parameter of POST /v1/recognitions method 







 model 

An optional model that specifies the language in which the audio is spoken and the rate at which it was sampled: broadband/multimedia or narrowband/telephony. By default, en-US_BroadbandModel is used. For more information, see [Using a model for speech recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-use).



Table 18. The model parameter

 Availability and usage Description 

 Previous-generation models Generally available for all languages. 
 Next-generation models Generally available for all languages. 
 WebSocket Query parameter of /v1/recognize connection request 
 Synchronous HTTP Query parameter of POST /v1/recognize method 
 Asynchronous HTTP Query parameter of POST /v1/recognitions method 







 processing_metrics
For more information about using channels to target specific integrations, see [Targeting specific integrations](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-responses-jsondialog-responses-json-target-integrations).

{
"output": {
"generic": [
{
"response_type": "channel_transfer",
"channels":
{
"channel": "whatsapp"
}
],
"message_to_user": "Click the link to connect with an agent using our website.",
"transfer_info": {
"target": {
"chat": {
"url": "https://example.com/webchat"
}
}
}
},
{
"response_type": "connect_to_agent",
"channels":
{
"channel": "chat"
}
],
"message_to_human_agent": "User asked to speak to an agent.",
"agent_available": {
"message": "Please wait while I connect you to an agent."
},
"agent_unavailable": {
"message": "I'm sorry, but no agents are online at the moment. Please try again later."
},
"transfer_info": {
"target": {
"zendesk": {
"department": "Payments department"
}
}
}
}
]
}
}
Show more







 dtmf 

Sends commands to the phone integration to control input or output using dual-tone multi-frequency (DTMF) signals. (DTMF is a protocol used to transmit the tones that are generated when a user presses keys on a push-button phone.)



 Fields 



 Name Type Description Required? 

 response_type string dtmf Y 
 command_info object Information specifying the DTMF command to send to the phone integration.
Using only the default transfer target to handle call failures is acceptable for low call volume scenarios but can result in large numbers of calls being directed to a customer contact center when bigger call volumes are handled by Watson Assistant. To enable this 500 error response capability for a specific Watson Assistant instance, you need to make a request to IBM.

You should plan for both full and partial service outages. A good first step is to plan for a manual failover between regions before enabling automation. This requires a complete replica of Watson Assistant in both regions, including all custom speech model training. When automation is enabled it is best to start with a strategy for detecting and failing over to the passive backup region when a complete regional outage is detected. After this is in place, a strategy can be implemented to deal with partial outages, which should cover the vast majority of failure conditions that can occur with a phone integration deployment.







 Web chat 



 Monitoring 

Web chat provides an onError listening feature that allows the host page to detect specific types of outage errors, in particular INITIAL_CONFIG, OPEN_CONFIG, and MESSAGE_COMMUNICATION errors.

You can find the documentation for this feature here:

[https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-configuration#onerror-detail](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-configurationonerror-detail)





 Failover 

Handling a failover for web chat is simple assuming you have set up an additional web chat integration in another region. When the failover needs to be manually triggered, make the following changes:



* The embed script that contains your integration ID, region, service instance ID, and subscription ID (if applicable) needs be changed or updated to use the IDs for the new integration and region.
* If you are using Salesforce or ZenDesk integrations for connecting to human agents, update the configuration within those systems to make sure they can communicate with the correct integration. Follow the instructions on the Live agent tab in the web chat configuration for setting up those systems. This is only needed for obtaining the conversation history for the agent.
For more information about resolving the issue, see [Configuring logging levels for the guest OS](https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.monitoring.doc/GUID-F465D340-6556-49E8-B137-C0B4A060E83B.html). 
 Troubleshooting network connection issues Symptoms can include VM fails to connect to the network, or no network connectivity to or from a single VM. For more information about resolving the issue, see [Troubleshooting virtual machine network connection issues (1003893)](https://kb.vmware.com/s/article/1003893?CoveoV2.CoveoLightningApex.getInitializationData=1&r=2&ui-communities-components-aura-components-forceCommunity-seoAssistant.SeoAssistant.getSeoData=1&other.KM_Utility.getArticleDetails=1&other.KM_Utility.getArticleMetadata=2&other.KM_Utility.getUrl=1&other.KM_Utility.getUser=1&other.KM_Utility.getAllTranslatedLanguages=2&ui-comm-runtime-components-aura-components-siteforce-qb.Quarterback.validateRoute=1).
Do extensive testing of your webhook before you enable it for an assistant that is being used in a production environment.

Your assistant must have a skill added to it before your webhook can do anything useful. The webhook is triggered only when a message has been processed by your skill, and a response is ready to be returned.

If you enable the setting that returns an error when the webhook call fails, the processing of the assistant is halted entirely if the webhook encounters any issues. Take steps to test the process that you are calling regularly so you are alerted if the external service is down, and can take actions to prevent all of the message responses from failing to be returned.

If you call an Cloud Functions web action, you can use the logging capability in Cloud Functions to help you troubleshoot your code. You can [download the command line interface](https://cloud.ibm.com/functions/learn/cli), and then enable logging with the [activation polling command](https://cloud.ibm.com/docs/cloud-functions-cli-plugin?topic=cloud-functions-cli-plugin-functions-clicli_activation_poll).





 Troubleshooting the webhook 

The following error codes can help you track down the cause of issues you might encounter. If you have a web chat integration, for example, you will know that your webhook has an issue if every test message you submit returns a message such as, There is an error with the message you just sent, but feel free to ask me something else. If this message is displayed, use a REST API tool, such as cURL, to send a test /message API request, so you can see the error code and full message that is returned.



Error code details

 Error code and message Description 

 422 Webhook responded with invalid JSON body The webhook's HTTP response body could not be parsed as JSON. 
 422 Webhook responded with [500] status code There's a problem with the external service you called. The code failed or the external server refused the request. 
 500 Processor Exception : [connections to all backends failing] An error occurred in the webhook microservice. It could not connect to backend services.
Getting help and support 

If you have problems or questions when using VPC+ Cloud Migration, you can contact Wanclouds for assistance through the Wanclouds interface or by email using [services@wanclouds.net](mailto:services@wanclouds.net).

If you have problems or questions when using IBM Cloud® infrastructure, you can get help by searching for information or by asking questions through one of the forums. You can also create a case in the [IBM Cloud console](https://cloud.ibm.com/unifiedsupport/supportcenter).

See [Getting help](https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatarusing-avatar) for more details about using the forums.

For information about opening an IBM support ticket, see [Contacting support](https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar).
Getting help and support 

If you have problems or questions when using the IBM Cloud Monitoring service, you have several options to get help with determining the cause of the problem and finding a solution. If you're logged in, you can go directly to the [Support center](https://cloud.ibm.com/unifiedsupport/supportcenter) to review common FAQs, open a support case, or search community content.



 Using the Support Center search field 

You can use the Support Center search field to find answers to your questions from across the IBM Cloud documentation and Stack Overflow forum. You can also manage support cases from the Support Center. You can find links to both the Stack Overflow forum for technical questions and the developerWorks (IBM Developer Answers) forum for all other questions under the Forums section of the Support Center.

To access the Support Center, log in to the IBM Cloud console, and click Support from the menu bar.

If you have a basic, advanced, or premium [support plan](https://cloud.ibm.com/docs/get-support?topic=get-support-support-planssupport-plans), you can find call-in numbers and a chat option to get help.

The Support Center is the preferred method for getting support, but if you can't log in to IBM Cloud, you can use the [New support case](https://cloud.ibm.com/unifiedsupport/cases/add) page to submit a case.





 Searching forums 

You can search forums to find answers to your questions. The Stack Overflow forum, for technical questions, and the IBM Developer Answers forum, for general questions, both provide a wide variety of searchable answers to your IBM Cloud questions.

If you don't find an existing answer to a question, ask a new one.

You can access Stack Overflow and IBM Developer Answers from the Support Center, or use the following links:



* Go to [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud) to ask technical questions about the IBM Cloud Monitoring service.