vania-janet/multiturn-rag-retrieval-data huggingface dataset:
"datetime": "2020-04-24T10:00:54Z",
"source": "waf",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
},
{
"action": "log",
"clientAsn": "58224",
"clientCountryName": "IR",
"clientIP": "2.183.175.37",
"clientRequestPath": "/api/v2",
"clientRequestQuery": "",
"datetime": "2020-04-24T10:00:54Z",
"source": "waf",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
}
]
}
]
}
},
"errors": null
}
For more information, see [Acceptable Internet use policy for IBM services](https://www.ibm.com/services/us/imc/html/aup1.html).



If you believe that your account was deactivated in error, contact support by calling 1-866-325-0045 and selecting the third option.





 What are my options for contacting IBM Cloud Support? 

From the IBM Cloud console menu bar, click the Help icon ![Help icon](https://cloud.ibm.com/docs-content/v1/content/4d8c6eec891cff72b666dc24bd3211810c77fb42/icons/help.svg) > Support center. The options that are available to you depend on your support plan. For more information, see [Getting support](https://cloud.ibm.com/docs/get-support?topic=get-support-support-plans).

To contact support, you can use the following methods:



* If you have a valid Pay-As-You-Go or Subscription account, you can click Live chat with support to chat with a support engineer.
* Lite and Trial account support is limited to nontechnical support issues that are related to account access and billing. Users with Lite or Trial accounts can view the [IBM Cloud documentation](https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar), Chat with Watson, and use [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud).







 Can I view a list of accounts that I own? 

The IBM Cloud console menu bar lists all of the accounts that are affiliated with your IBMid, including the accounts that you own. Click the account listing in the console menu bar to see the other accounts that you own or are a member. The account name begins with the account number for Pay-As-You-Go and Subscription accounts.

Zoom

![A screen capture of the account selector in the console menu bar.
Asynchronous HTTP Not supported 







 keywords 

An optional array of keyword strings that the service spots in the input audio. By default, keyword spotting is not performed. For more information, see [Keyword spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-spottingkeyword-spotting).



Table 13. The keywords parameter

 Availability and usage Description 

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







 keywords_threshold 

An optional double between 0.0 and 1.0 that indicates the minimum threshold for a positive keyword match. By default, keyword spotting is not performed. For more information, see [Keyword spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-spottingkeyword-spotting).



Table 14. The keywords_threshold parameter

 Availability and usage Description 

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







 language_customization_id 

An optional customization ID for a custom language model that includes terminology from your domain. By default, no custom model is used. For more information, see [Using a custom language model for speech recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageUse).



Table 15. The language_customization_id parameter

 Availability and usage Description 

 Previous-generation models Generally available or beta for all models that support language model customization.
For more information, see [Making a multipart HTTP speech recognition request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-httpHTTP-multi).



 Usage models 

When you work with the service's asynchronous HTTP interface, you can elect to learn about job status and receive results in the following ways:



* By using callback notifications:



1. Call the POST /v1/register_callback method to register a callback URL with the service. You can provide an optional user-specified secret string to enable authentication and data integrity for callbacks that are sent to the URL.
2. Call the POST /v1/recognitions method with an already registered callback URL to which the service sends notifications when the status of the job changes. You specify a list of events of which to be notified. By default, the service sends notifications when a job is started, when it is complete, and if an error occurs. You can also request the results of the request in the completion notification. Otherwise, you need to use the GET /v1/recognitions/{id} method to retrieve the results.



* By polling the service:



1. Call the POST /v1/recognitions method without a callback URL, events, or a user token.
2. Periodically call the GET /v1/recognitions method to check the status of the most recent jobs or the GET /v1/recognitions/{id} method to check the status of a specific job.
3. If you check job status with the GET /v1/recognitions method, call the GET /v1/recognitions/{id} method to retrieve the results of the job once it is complete.





The two approaches can be used together. You can still poll the service to obtain the latest status for a job that is created with a callback URL. For example, you might want to obtain the status of a job if notifications are taking a while to arrive. You might also check the status if you suspect that you missed one or more notifications due to a service or network error.





 Registering a callback URL
[Improving your query results](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-improvements) 
 ![checkbox](https://cloud.ibm.com/docs-content/v1/content/f16b1f78a92498247223b337bd9303c2758b9ba8/discovery-data/images/checkbox.png) Connect your project to a virtual assistant that is built with Watson Assistant. [Deploying your project](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-deploy) 
 ![checkbox](https://cloud.ibm.com/docs-content/v1/content/f16b1f78a92498247223b337bd9303c2758b9ba8/discovery-data/images/checkbox.png) From the Watson Assistant user interface, deploy the web chat that is associated with your assistant. [Deploying your assistant](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-web-chat-overview) 



For a more detailed look at these steps, take a tutorial that walks you through them. For more information, see [Power your assistant with answers from web resources](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-tutorial-assistant-fred).

Alternatively, you can add a generative language service named NeuralSeek between the Watson Discovery and Watson Assistant services. For more information, see [Use NeuralSeek to return polished answers from existing help content](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-tutorial-neuralseek).





 Find trends 

Uncover patterns, trends, and relationships in structured and unstructured data. Use text analytics to gain insights into social media, e-commerce trends, and user behavior. Or start to address problems by finding their root cause.
private.sip_request_uri string The SIP request URI that started the conversation session. 
 private.sip_to_uri string The SIP To URI associated with the conversation session. 
 private.user_phone_number string The phone number that the call was received from. 
 assistant_phone_number string The phone number associated with the Watson Assistant side that received the phone call. 







 Input parameters that are set by the phone channel 

The following input parameters are only valid for the current conversation turn.



Input parameters set by the phone channel

 Name Type Description 

 post_response_timeout_occurred boolean Whether the post response timeout expired. 
 barge_in_occurred boolean Whether barge-in occurred. 
 final_utterance_timeout_occurred true or false Whether the final utterance timeout expired. 
 dtmf_collection_succeeded boolean Whether the DTMF collection succeeded or failed. When true, a DTMF collection succeeded, and returns the expected number of digits. When false, a DTMF collection failed to collect the specified number of digits. Even when dtmf_collection_succeeded is false, all collected digits are passed to the dialog in the input string of the turn request. 
 is_dtmf boolean Whether the input to Watson Assistant is dual-tone multi-frequency signaling (DTMF). 
 speech_to_text_result object The final response from the Speech to Text service in JSON format, including the transcript and confidence score for the top hypothesis and any alternatives. The format matches exactly the format that is received from the Speech to Text service. (For more information, see the [Speech to Text API documentation](https://cloud.ibm.com/apidocs/speech-to-textrecognize).) 





 Example 

{
"input": {
"text": "agent ",
"integrations": {
"voice_telephony": {
"speech_to_text_result": {
"result_index": 0,
"stopTimestamp": "2021-09-29T17:43:31.036Z",
"transaction_ids": {
Message: The name information was not retrieved because a problem occurred contacting Cloud Foundry.

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. If the problem continues, go to [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter).





 BXNUI0133E 

Message: Service bindings weren't retrieved because a problem occurred contacting Cloud Foundry.

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. If the problem continues, go to [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter).





 BXNUI0200E 

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).





 BXNUI0201E 

Message: The routes for the space 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).





 BXNUI0202E 

Message: The domains for the org 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).





 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
The phone integration can also be configured to respond to a SIP INVITE with a SIP 500 (service unavailable) message if an outage is detected during call setup instead of transferring a call to a live agent. A SIP 500 can then be used to redirect the call to another zone, or if many SIP 500s are received, to another region. Using a SIP 500 INVITE error is a better way to signal a failure to an upstream SIP trunking provider because it gives the provider a way to reroute the call. 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:
Use the https transport and specify an authorization header to control access to the webhook.





 What do I do if the training process seems stuck? 

If the training process gets stuck, first check whether for an outage for the service by going to the [Cloud status page](https://cloud.ibm.com/status). You can start a new training process to stop the current process and start over.





 How do I see my monthly active users in Watson Assistant? 

To see your monthly active users (MAU):



1. Sign in to [https://cloud.ibm.com](https://cloud.ibm.com)
2. Click the Manage menu, then choose Billing and usage.
3. Click Usage.
4. For Watson Assistant, select View Plans.
5. Under Time Frame, select the month that you need.
6. Select your Plus plans or Plus Trial plans to see monthly active users and the API calls.







 Can I see what web browser users are using with Watson Assistant? 

With the V2 API and an Enterprise plan, you can use the Segment extension to see what browser was used to send the message. For more information, see [Sending events to Segment](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-segment-add).





 Is it possible to increase the number of intents per skill 

No, it is not possible to increase the number of intents per skill.
Use the universal language model when you want to create a conversation in a language where no model is available, and which is unique enough that an existing model is insufficient.

For more information about feature support in the universal language model, see [Supported languages](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-admin-language-supportadmin-language-support-codes).





 Integration considerations 

Keep these tips in mind for integrations:



* Phone integration: If you want to deploy an assistant that uses the universal language model, you must connect to custom Speech service language models that can understand the language you're using. For more information about supported language models, see the [Speech to Text](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-modelsmodelsList) and [Text to Speech](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voiceslanguageVoices) documentation.
* Search integration: If you build an assistant that specializes in a single language, be sure to connect it to data collections that are written in that language. For more information about the languages that are supported by Discovery, see [Language support](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-language-support).
* Web chat: Web chat has some hardcoded strings that you can customize to reflect your target language. For more information, see [Supporting global audiences](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-web-chat-develop-global).







 Supported languages 

Watson Assistant supports individual features to varying degrees per language.

Watson Assistant has classifier models that are designed specifically to support conversations in the following languages:



Table 1. Supported languages

 Language Language code 

 Arabic ar 
 Chinese (Simplified) zh-cn 
 Chinese (Traditional) zh-tw 
 Czech cs 
 Dutch nl 
 English en-us 
 French fr 
 German de 
 Italian it 
 Japanese ja 
 Korean ko 
 Portuguese (Brazilian) pt-br
[Time period](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/analytics-conversations-time-period.png)





 Filtering conversations 

You can locate specific conversations by filtering the list of conversations. This lets you explore specific areas where your assistant might need improvement or updates to properly handle what your customers are asking about.

You can filter by:



* Actions: Select specific actions. You can choose one or more actions to review.
* Keyword: Search by session ID or for specific key terms, phrases, or words in the conversations. For more information about session IDs, see [session_id](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-admin-managing-planadmin-managing-plan-no-userid).
* Recognition: Choose between recognized or unrecognized user questions or requests.
* Search: Choose between requests that initiated a search or requests that produced no search results.



The Actions and Keyword filters always appear at the top of the page. To show the Recognition and Search filters, click the Additional filters icon.

If you have activated dialog in your assistant, the Actions filter is replaced by a Topics filter.

![Conversation filters](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/analytics-conversations-filters.png)

If you search for a specific session ID, enclose your search in quotation marks to ensure you receive an exact match on the full ID with its numbers and hyphen characters, for example: "9015ab9a-2e13-4627-ae33-4179b1125cb5".





 Exploring conversations in detail 

To explore individual conversations in detail, you can click on any of the utterances or conversation time stamps.
However, using an active/active topology likely requires using [webhooks](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-webhook-overview) to gather interaction data, and build custom data warehouses and reports to understand total usage.





 Session history for web chat and the v2 api 

Session history allows your web chats to maintain conversation history and context when users refresh a page or change to a different page on the same website. This feature doesn't work across instances, so in-progress conversations need to be restarted.





 Billing 

IBM calculates your bill based on the IBM Cloud Account. Watson Assistant calculates monthly average user (MAU) metrics by aggregating within a given service instance as follows:



* The same MAU used in 2 different assistant resources in the same service instance counts as 1 MAU
* The same MAU used in 2 different assistant resources in different service instances counts as 2 MAUs



Note that for an active/active topology, under the worst case scenario, the MAU count could end up being doubled for a given billing period.







 Phone integration 

A Watson Assistant phone integration in one region is unaware of a phone integration in a different region. You need to ensure that your assistants are identically configured in both regions. You also need to rely on the upstream SIP trunking provider to detect and manage failing over between regions.



 Monitoring 

SIP trunking providers can be configured to actively health-check the Watson Assistant session border controllers (SBCs) by sending periodic SIP OPTIONS messages to each zone within a region. A failure to receive a response from one of the zones being health-checked can be used to either provide notification of a failure to trigger a manual failover, or it can be used to automate removal of the failed zone from the route list.





 Failover 

The SIP trunking provider plays an important role in detecting and managing a failover, especially if an automatic failover is expected between regions. In most cases, SIP trunking providers should be configured to treat each zone within a region as active/active and two regions where an assistant is configured as active/passive. SIP trunking providers should always be configured to load balance and fail over between zones within a single region.
Reporting a problem 



  Accessing and writing to the forums. 

For issues related to lite or paid queue managers, there are several forums where you can ask questions and read the responses to many existing queries.



*  [MQSeries.net](http://www.mqseries.net/phpBB2/index.php)
*  [StackOverflow](https://stackoverflow.com/questions/tagged/ibm-mq)
*  [List-Server](https://listserv.meduniwien.ac.at/archives/mqser-l.html)
*  [IMWUC MQ forum](https://community.ibm.com/community/user/imwuc/communities/community-home/digestviewer?communitykey=183ec850-4947-49c8-9a2e-8e7c7fc46c64&tab=digestviewer)







  Raising a support ticket 

For issues related to a paid queue manager (e.g. xsmall/small/medium/large) please open a support ticket.

Using the IBM Cloud console:



*  Click Support in the top right header bar, and then Add Ticket
*  Select Ticket type Technical
*  In the Select a resource context dropdown, select Resource Group
*  In the Technical area of support dropdown, select Integrate
*  In the Resource group dropdown, select the group in which your service instance is located (e.g. "Default")
*  In the Associated Resource dropdown, select the service instance in which your queue manager is located (e.g "MQ-1r")
*  In the Subject give a concise description of the problem you are seeing (e.g "Queue manager fails to deploy")
*  In the Brief Description give the details of the problem including the hostname of the queue manager that you are working with (for example qm1-abcd.qm.us-south.mq.appdomain.cloud) and any further details which might help us resolve the issue



Click Submit when the form is complete.
"enabled": true,
"name": "www.example.com",
"session_affinity": "none",
"session_affinity_ttl": 5000,
"steering_policy": "geo",
"fallback_pool": "4112ba6c2974ec43886f90736968e838",
"default_pools": [
"6563ebae141638f92ebbdc4a821bef8c",
"4112ba6c2974ec43886f90736968e838"
],
"pop_pools": {},
"region_pools": {
"EEU": [
"4112ba6c2974ec43886f90736968e838"
],
"ENAM": [
"6563ebae141638f92ebbdc4a821bef8c"
],
"WEU": [
"4112ba6c2974ec43886f90736968e838"
],
"WNAM": [
"6563ebae141638f92ebbdc4a821bef8c"
]
}
}'
"WAFRuleMessage":"",
"WorkerCPUTime":0,
"WorkerStatus":"unknown",
"WorkerSubrequest":false,
"WorkerSubrequestCount":0,
"ZoneID":
}
Show more
* Response with Status Code 404

{
"CacheCacheStatus":"miss",
"CacheResponseBytes":209,
"CacheResponseStatus":404,
"CacheTieredFill":false,
"ClientASN":56046,
"ClientCountry":"cn",
"ClientDeviceType":"desktop",
"ClientIP":"1.1.1.1",
"ClientIPClass":"noRecord",
"ClientRequestBytes":433,
"ClientRequestHost":"foo.com",
"ClientRequestMethod":"GET",
"ClientRequestPath":"/favicon.ico",
"ClientRequestProtocol":"HTTP/1.1",
"ClientRequestReferer":"foo.com/",
"ClientRequestURI":"/favicon.ico",
"ClientRequestUserAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"ClientSSLCipher":"NONE",
"ClientSSLProtocol":"none",
"ClientSrcPort":4532,
"EdgeColoID":134,
"EdgeEndTimestamp":"2019-01-03T01:54:12Z",
"EdgePathingOp":"wl",
"EdgePathingSrc":"macro",
"EdgePathingStatus":"nr",