vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* For more information about using IAM tokens with Watson services, see [Authenticating to Watson services](https://cloud.ibm.com/docs/watson?topic=watson-iam).
* For examples that use IAM authentication, see the [API & SDK reference](https://cloud.ibm.com/apidocs/text-to-speech).







 12 June 2018 

New features for applications hosted in Washington, DC, location
: The following features are enabled for applications that are hosted in Washington, DC (us-east):



* The service now supports a new API authentication process. For more information, see the [30 October 2018 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notestext-to-speech-30october2018).
* The service now supports the X-Watson-Metadata header and the DELETE /v1/user_data method. For more information, see [Information security](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-information-security).







 15 May 2018 

New features for applications hosted in Sydney location
: The following features are enabled for applications that are hosted in Sydney (au-syd):



* The service now supports a new API authentication process. For more information, see the [30 October 2018 service update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notestext-to-speech-30october2018).
* The service now supports the X-Watson-Metadata header and the DELETE /v1/user_data method. For more information, see [Information security](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-information-security).







 2 October 2017 

Changes to audio/l16 audio format
: For the audio/l16 format, you can now optionally specify the endianness of the audio that is returned. (You must already specify the sampling rate.)
Invoking the queue manager REST APIs 

IBM MQ provides a set of REST APIs that provide a simple way to administer, test and interact with your queue manager via scripts, applications and programs. In this section, the requirements to call the APIs on the IBM queue manager will be provided, in addition to examples that can be run straight from your terminal and be easily translated into other programming languages.

An IBM queue manager has 2 REST APIs available to call:



* Administration REST API - that allows you carry out administrative actions against the queue manager
* Messaging REST API - that allows applications to send and receive messages



There are a few important pieces of information when interacting with the IBM queue manager:



1. The Listener Port is not required in the URI to call the REST API
2. The hostname to call your queue manager should start with web-
3. The beginning of the path in the URI should be /ibmmq/rest
4. The REST API is case-sensitive - for example if your queue manager is called QM1 and your using the admin REST API, then in the path for admin you should do /qmgr/QM1/...





 Authenticating your client to invoke REST API requests 

There are a couple of ways that you can authenticate with your IBM queue manager over REST.

The first is using Basic Authentication, this is very common method used to interact with the queue manager over REST as it is easy to convert to other languages and is great for testing.

For more information on using Basic Authentication to authenticate with your queue manager see [here](https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.sec.doc/q128710_.htm).



 Example: Authenticating with an IBM queue manager using Basic Authentication 



1. Get your MQ username and API key from your service instance in IBM Cloud, then run the following:

AUTH=echo "<MQ_USERNAME>:<API_KEY>" | base64
* For more information about the PKCS #11 API, check out

[Introducing PKCS #11](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-pkcs11-intro) and

[PKCS #11 API reference](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-pkcs11-api-ref).
* For more information about the GREP11 API, check out [Introducing EP11 over gRPC](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-grep11-intro) and [GREP11 API reference](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-grep11-api-ref).
* To learn more about the differences and relationships between PKCS #11 and GREP11 API, see [Introducing cloud HSM](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-introduce-cloud-hsm).
uri: "https://api.nasa.gov/planetary/apod?api_key=NNKOjkoul8n1CH18TWA9gwngW1s1SmjESPjNoUFo",
json: true
}
return rp(options)
.then(res => {
return { response: res }
})
}

A call is made to the NASA APOD API, and fields are extracted from the JSON result.

Next, [create](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions), and [invoke the action](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-test) to test it. The following example object is returned.

{
"copyright": "Eric Houck",
"date": "2018-03-28",
"explanation": "Does an alignment like this occur only once in a blue moon? ...",
"hdurl": "https://apod.nasa.gov/apod/image/1803/MoonTree_Houck_1799.jpg",
"media_type": "image",
"service_version": "v1",
"title": "Blue Moon Tree",
"url": "https://apod.nasa.gov/apod/image/1803/MoonTree_Houck_960.jpg"
}





 Packaging JavaScript code with the webpack module 

Before you begin, [review the packages that are included with the JavaScript runtime](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-runtimesopenwhisk_ref_javascript_environments) to see whether a dependency of your app is already included with the runtime. If your dependency is not included, you must package it with your app. The following steps assume that you are running the commands on a Linux-based distribution on a processor with AMD64-based architecture.
: v2 API: [https://containers.cloud.ibm.com/global/swagger-global-api/](https://containers.cloud.ibm.com/global/swagger-global-api//).

API architectural style
: v1 API: Representational state transfer (REST) that focuses on resources that you interact with through HTTP methods such as GET, POST, PUT, PATCH, and DELETE.
: v2 API: Remote procedure calls (RPC) that focus on actions through only GET and POST HTTP methods.

Supported container platforms
: v1 API: Use the IBM Cloud Kubernetes Service API to manage your IBM Cloud infrastructure resources, such as worker nodes, for both community Kubernetes and Red Hat OpenShift clusters.
: v2 API: Use the IBM Cloud Kubernetes Service v2 API to manage your IBM Cloud infrastructure resources, such as worker nodes, for both community Kubernetes and Red Hat OpenShift VPC clusters.

Kubernetes API
: v1 API: To use the Kubernetes API to manage Kubernetes resources within the cluster, such as pods or namespaces, see [Working with your cluster by using the Kubernetes API](https://cloud.ibm.com/docs/containers?topic=containers-cs_api_installkube_api).
: v2 API: Same as v1; see [Working with your cluster by using the Kubernetes API](https://cloud.ibm.com/docs/containers?topic=containers-cs_api_installkube_api).

Supported APIs by infrastructure type
: v1 API: classic
: v2 API: vpc and classic



* The vpc provider is designed to support multiple VPC subproviders. The supported VPC subprovider is vpc-gen2, which corresponds to a VPC cluster for Generation 2 compute resources.
* Provider-specific requests have a path parameter in the URL, such as v2/vpc/createCluster. Some APIs are only available to a particular provider, such as GET vlan for classic or GET vpcs for VPC.
The following events are for working with tenants in your Power Systems Virtual Server instance.



Table 9. List of events: Tenant

 Action Description 

 power-iaas.tenant.read Read your Tenant Information 
 power-iaas.tenant-ssh.read Read SSH Key or SSH Keys 
 power-iaas.tenant-ssh.create Create an SSH Key 
 power-iaas.tenant-ssh.update Update an SSH Key 
 power-iaas.tenant-ssh.delete Delete an SSH Key 







 List of events: Job 

The following events are for working with jobs in your Power Systems Virtual Server instance.



Table 10. List of events: Job

 Action Description 

 power-iaas.job.read Read a Job or all Jobs 
 power-iaas.job.create Create a Job 
 power-iaas.job.delete Delete a Job 







 List of events: Network ports 

The following events are for working with network ports in your Power Systems Virtual Server instance.



Table 11. List of events: Network ports

 Action Description 

 power-iaas.port.read Read a Network Port or all Network Ports 
 power-iaas.port.create Create a Network Port 
 power-iaas.port.update Update a Network Port 
 power-iaas.port.delete Delete a Network Port 







 List of events: SAP 

The following events are for working with SAP in your Power Systems Virtual Server instance.



Table 12. List of events: SAP

 Action Description 

 power-iaas.sap.read Read SAP Information 
 power-iaas.sap.create Create an SAP PVM Instance 







 List of events: Cloud Connections 

The following events are for working with Cloud connections in your Power Systems Virtual Server instance.



Table 13. List of events: Cloud connections

 Action Description 

 power-iaas.cloud-connection.read Read a Cloud Connection or all Cloud Connections 
 power-iaas.cloud-connection.create Create a Cloud Connection 
 power-iaas.cloud-connection.update Update a Cloud Connection 
 power-iaas.cloud-connection.delete Delete a Cloud Connection 







 List of events: Placement Groups
[External link icon](https://cloud.ibm.com/docs-content/v1/icons/launch-glyph.svg)](https://www.ibm.com/support/knowledgecenter/SSQP8H/iot/platform/devices/mqtt.htmlmqtt_authentication).
**For more information about API keys and tokens, see [API key connection](https://cloud.ibm.com/applications/app_dev_index.htmlauthentication). Tip: You can look up the default API key and token for your Watson IoT Platform instance by using the [Watson IoT Platform dashboard ![External link icon](https://cloud.ibm.com/docs-content/v1/icons/launch-glyph.svg)](https://www.ibm.com/support/knowledgecenter/SSQP8H/iot/getting_started/external_dashboard.htmlaccess_api).





 Using HTTP APIs 

Each Watson IoT Platform organization is identified by a 6-character organization ID ({orgId}) which is required in the host name for any HTTP API call.
Tip: You can find your organization ID from the Watson IoT Platform dashboard, see [Accessing service APIs ![External link icon](https://cloud.ibm.com/docs-content/v1/icons/launch-glyph.svg)](https://www.ibm.com/support/knowledgecenter/SSQP8H/iot/getting_started/external_dashboard.htmlaccess_api).



 HTTP API URL 

Use the following API endpoint URLs to access the Watson IoT Platform APIs. The API endpoint URL consists of a Host URL and a Base URL. The base URL for each REST API is listed with the [API docs](https://cloud.ibm.com/docs/IoT?topic=IoT-api_overviewapi_docs), and is typically api/v0002/.



 API Host URL
ibmcloud fn action update demo/hello <filepath>/hello.js --web true
3. Test the action in your browser or by using a cURL command. Replace the <apihost> and <namespace_ID> variables. You can test the web action by either:



* Opening the URL https://<apihost>/api/v1/web/<namespace_ID>/demo/hello in your browser.
* Running the following cURL command.

curl https://<apihost>/api/v1/web/<namespace_ID>/demo/hello
* Running the following wget command.

wget https://<apihost>/api/v1/web/<namespace_ID>/demo/hello









 Returning JSON by using a web action 

You might use this feature in a web application to return a JSON object of user IP information.

Before you begin

Create the demo package and hello web action by completing the steps in [Creating a web action](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions_webactions_web_example).

To create a web action that returns application/json:



1. Save the code as hello.js.

function main(params) {
return {
statusCode: 200,
headers: { 'Content-Type': 'application/json' },
body: params
};
}
2. Update your hello web action with the new version for your hello.js code. Replace <filepath> with the file path of your hello.js file.

ibmcloud fn action update demo/hello <filepath>/hello.js --web true
3. Test the action in your browser or by using a cURL command. Replace the <apihost> and <namespace_ID> variables. You can test the web action by using one of the following methods.
Update your hello web action with the new version for your hello.js code. Replace <filepath> with the file path of your hello.js file.

ibmcloud fn action update demo/hello <filepath>/hello.js --web true
3. Test the action in your browser or by using a cURL command. Replace the <apihost> and <namespace_ID> variables. You can test the web action by using one of the following methods.



* Opening the URL https://<apihost>/api/v1/web/<namespace_ID>/demo/hello in your browser.
* Running the following cURL command.

curl https://<apihost>/api/v1/web/<namespace_ID>/demo/hello
* Running the following wget command.

wget https://<apihost>/api/v1/web/<namespace_ID>/demo/hello



Example output

{
"__ow_headers": {
"accept": "/",
"accept-encoding": "gzip",
"cdn-loop": "cloudflare",
"cf-connecting-ip": "XX.XXX.XXX.XXX",
"cf-ipcountry": "US",
"cf-ray": "4d9f3e442a86cf28-IAD",
"cf-visitor": "{"scheme":"https"}",
"host": "<apihost>",
"user-agent": "curl/7.54.0",
"x-forwarded-for": "XX.XXX.XX.XXX, XX.XXX.XX.XXX",
"x-forwarded-host": "<apihost>",
"x-forwarded-port": "443",
"x-forwarded-proto": "https",
curl https://<apihost>/api/v1/web/<namespace_ID>/demo/hello?name=Jane
* Testing the action by using a wget command.

wget https://<apihost>/api/v1/web/<namespace_ID>/demo/hello?name=Jane



Example output

<html><body><h3>Hello, Jane!</h3></body></html>



Next steps, try adding the URL for your hello web action to your web app and test it there.



 Web action JSON properties 

The default Content-Type for an HTTP response is application/json, and the body can be any allowed JSON value. If your Content-Type is not application/json, you must specify a Content-Type in the headers of your action code.

If the [result size limit](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-limits) for actions is reached, the response fails. If you know that your action result is larger than 5 MB, then set up an [object store](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-pkg_obstorage).



JSON web action properties.

 JSON property Description 

 headers A JSON object in which the keys are header names and the values are string, number, or boolean values. To send multiple values for a single header, the header's value is a JSON array of the multiple values. No headers are set by default. 
 statusCode A valid HTTP status code. If body content is present, the default is 200 OK. If no body content is present, the default is 204 No Content. 
 body A string that is either plain text, a JSON object or array, or a base64 encoded string for binary data. The body is considered empty if it is null, the empty string "", or undefined. The default is an empty body.
* Opening the URL https://<apihost>/api/v1/web/<namespace_ID>/demo/hello in your browser.
* Running the following cURL command.

curl https://<apihost>/api/v1/web/<namespace_ID>/demo/hello
* Running the following wget command,

wget https://<apihost>/api/v1/web/<namespace_ID>/demo/hello









 Returning an image by using a web action 

Images that are returned through web actions are required to be base64 encoded strings. You might use this feature in a web application to return the image of a country flag based on user locale.

Before you begin

Create the demo package and hello web action by completing the steps in [Creating a web action](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions_webactions_web_example).

To create a web action that returns an image/png:



1. Save the code as hello.js. Replace <base64_encoded_string> with a base64 encoded string from an image file.

function main() {
let png = '<base64_encoded_string>';
return { headers: { 'Content-Type': 'image/png' },
statusCode: 200,
body: png };
}
2. Update your hello web action with the new version for your hello.js code. Replace <filepath> with the file path of your hello.js file.

ibmcloud fn action update demo/hello <filepath>/hello.js --web true
3. Test the action in your browser or by using a cURL command. Replace the <apihost> and <namespace_ID> variables. You can test the web action by either:



* Opening the URL https://<apihost>/api/v1/web/<namespace_ID>/demo/hello in your browser.
* Running the following cURL command.
![webservice-output-1.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/webservice-output-1.png)
16. Click the circle corresponding to zip string on the input side and then click the circle corresponding to zip string on the output side. Map the remaining parameters using the following as a guide. ![webservice-output-2.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/webservice-output-2.png)
17. Click the Save icon ![save-icon.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/save-icon.png) to save your changes.



You have included the web service invocation in your assembly and mapped an input parameter to the appropriate part of the SOAP request and mapped the appropriate part of the SOAP response to a JSON output.





 Testing your API definition 

To test your API definition by using the API Manager test tool, complete the steps below.



1. Click the Test icon ![test-icon.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/test-icon.png) under the Assembly tab to reveal the test pane.
When you use the Swagger documentation to test the Cognos Dashboard Embedded REST API, enter the client_id in the Username field and the client_secret in the Password field when you authorize the Swagger client using basic authentication. You can find the Swagger documentation for REST API here: [https://dde-us-south.analytics.ibm.com/api-docs/](https://dde-us-south.analytics.ibm.com/api-docs/).

See the following example screen capture:

![AuthenticatonSwagger](https://cloud.ibm.com/docs-content/v1/content/2781097afe16f2d329d7a606ddd260fb1a3e355c/services/cognos-dashboard-embedded/swaggerauthentication.jpg)





 Step 4: Embedding Cognos Dashboard Embedded through the JavaScript API 

With Cognos Dashboard Embedded, you can embed dashboards into a web application using the JavaScript API. The documentation of the API is located here: [https://dde-us-south.analytics.ibm.com/daas/jsdoc/cognos/api/CognosApi.html](https://dde-us-south.analytics.ibm.com/daas/jsdoc/cognos/api/CognosApi.html).

Note: Specify the web-domain of your application that contains the Cognos Dashboard Embedded dashboard, in the POST request to create the session.

Make sure that your application does the following:



* Pull in the CognosApi.js file. The CognosApi.js file is available from the Cognos Dashboard Embedded service instance: [https://dde-us-south.analytics.ibm.com/daas/CognosApi.js](https://dde-us-south.analytics.ibm.com/daas/CognosApi.js).
* Create and initialize an instance of the API framework. This API takes three parameters:



1.
Customize your SAP system configuration. In the same file, input.auto.tfvars, edit the SAP system configuration variables that are passed to the Ansible automated deployment.

For descriptions of the variables, see the [README file](https://github.com/IBM-Cloud/sap-netweaver-abap-db2-standard/tree/mainreadme).

SAP system configuration
sap_sid	= "DB2"
sap_ci_instance_number = "00"
sap_ascs_instance_number = "01"

Kits paths
kit_sapcar_file = "/storage/NW75DB2/SAPCAR_1010-70006178.EXE"
kit_swpm_file = "/storage/NW75DB2/SWPM10SP37_2-20009701.SAR"
kit_saphotagent_file = "/storage/NW75DB2/SAPHOSTAGENT51_51-20009394.SAR"
kit_sapexe_file = "/storage/NW75DB2/SAPEXE_800-80002573.SAR"
kit_sapexedb_file = "/storage/NW75DB2/SAPEXEDB_800-80002603.SAR"
kit_igsexe_file = "/storage/NW75DB2/igsexe_13-80003187.sar"
kit_igshelper_file = "/storage/NW75DB2/igshelper_17-10010245.sar"
kit_export_dir = "/storage/NW75DB2/51050829"
kit_db2_dir = "/storage/NW75DB2/51055138/DB2_FOR_LUW_11.5_MP6_FP0SAP2_LINUX_"
kit_db2client_dir = "/storage/NW75DB2/51055140"

Remember, you must manually decompress the kit_export_dir, kit_db2_dir, and kit_db2client_dir files.
For more information, see [Tune by Example events](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-at-eventsat-events-tbe).

Updates to Activity Tracker actions for customization
: The names of the actions for the Activity Tracker events for the customization methods have changed. The actions now include the string custom-model instead of custom-voice. The old names of the actions are deprecated. The old names are still available for use but will be removed at a future date. Migrate to the new names that are listed in [Customization events](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-at-eventsat-events-custom) at your earliest convenience.

Create eventsDeprecated action name -> New action name



* text-to-speech.custom-voice.create -> text-to-speech.custom-model.create
* text-to-speech.custom-voice-word-list.create -> text-to-speech.custom-model-word-list.create
* text-to-speech.custom-voice-word.create -> text-to-speech.custom-model-word.create



Read eventsDeprecated action name -> New action name



* text-to-speech.custom-voice-list.read -> text-to-speech.custom-model-list.read
* text-to-speech.custom-voice.read -> text-to-speech.custom-model.read
* text-to-speech.custom-voice-word-list.read -> text-to-speech.custom-model-word-list.read
* text-to-speech.custom-voice-word.read -> text-to-speech.custom-model-word.read



Update eventDeprecated action name -> New action name



* text-to-speech.custom-voice.update -> text-to-speech.custom-model.update



Delete eventsDeprecated action name -> New action name
Obs. This will be used also as identification number across different HA name resources. Duplicates are not allowed.
 Example: hana_sid = "HDB"

hana_sysno = "00"
 SAP HANA instance number. Should follow the SAP rules for instance number naming.
 Example: hana_sysno = "00"

hana_system_usage = "custom"
 System usage. Default: custom. Suported values: production, test, development, custom
 Example: hana_system_usage = "custom"

hana_components = "server"
 SAP HANA Components. Default: server. Supported values: all, client, es, ets, lcapps, server, smartda, streaming, rdsync, xs, studio, afl, sca, sop, eml, rme, rtl, trp
 Example: hana_components = "server"

kit_saphana_file = "/storage/HANADB/51055299.ZIP"
 SAP HANA Installation kit path
 Supported SAP HANA versions on Red Hat 8.4 and Suse 15.3: HANA 2.0 SP 5 Rev 57, kit file: 51055299.ZIP
 Supported SAP HANA versions on Red Hat 7.6: HANA 2.0 SP 5 Rev 52, kit file: 51054623.ZIP
 Example for Red Hat 7: kit_saphana_file = "/storage/HANADB/51054623.ZIP"
 Example for Red Hat 8 or Suse 15: kit_saphana_file = "/storage/HANADB/51055299.ZIP"


 SAP system configuration


sap_sid = "NWD"
 SAP System ID
 Obs. This will be used also as identification number across different HA name resources. Duplicates are not allowed.

sap_ascs_instance_number = "00"
 The central ABAP service instance number. Should follow the SAP rules for instance number naming.
 Example: sap_ascs_instance_number = "00"

sap_ers_instance_number = "01"
 The enqueue replication server instance number.