vania-janet/multiturn-rag-retrieval-data huggingface dataset:
For more information about API keys and tokens, see [API key connection ![External link icon](https://cloud.ibm.com/docs-content/v1/content/icons/launch-glyph.svg)](https://www.ibm.com/support/knowledgecenter/SSQP8H/iot/platform/platform_authorization.htmlapi-key).



 About HTTP APIs 

Each Watson IoT Platform organization is identified by a 6-character organization ID which is required in the host name for any HTTP API call.





 API authentication 

The HTTP APIs are protected by HTTP basic authentication. This authentication differs if you are using messaging APIs or application APIs.



 API Username Password 

 HTTP Messaging API use-token-auth Token that is created when you registered your device.* 
 HTTP Application API API key generated by Watson IoT Platform.** <br>Example: a-abc123-kodl0vqqrk, where abc123 is the {orgId} Token generated by Watson IoT Platform.** 



*The HTTP Messaging API allows the publication of events and commands by applications and devices indistinguishable from events and commands that are published by using MQTT. For more information about Messaging API keys and tokens, see [MQTT authentication ![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 !
For more information about API keys and tokens, see [API key connection ![External link icon](https://cloud.ibm.com/docs-content/v1/content/icons/launch-glyph.svg)](https://www.ibm.com/support/knowledgecenter/SSQP8H/iot/platform/platform_authorization.htmlapi-key).



 About HTTP APIs 

Each Watson IoT Platform organization is identified by a 6-character organization ID which is required in the host name for any HTTP API call.





 API authentication 

The HTTP APIs are protected by HTTP basic authentication. This authentication differs if you are using messaging APIs or application APIs.



 API Username Password 

 HTTP Messaging API use-token-auth Token that is created when you registered your device.* 
 HTTP Application API API key generated by Watson IoT Platform.** <br>Example: a-abc123-kodl0vqqrk, where abc123 is the {orgId} Token generated by Watson IoT Platform.** 



*The HTTP Messaging API allows the publication of events and commands by applications and devices indistinguishable from events and commands that are published by using MQTT. For more information about Messaging API keys and tokens, see [MQTT authentication ![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/docs/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 !
-a parameters '[{ "required":false, "description": "Any JSON entity" }]' -a sampleInput '{ "msg": "Five fuzzy felines"}' -a sampleOutput '{ "msg": "Five fuzzy felines"}'





 Web action annotations 

The following web action annotations must be explicitly set to true to enable API interactivity.



Annotations specific to web actions.

 Annotation Description 

 web-export When applied to an action, the action becomes a [web action](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions_web). The action becomes accessible to REST calls without authentication so that users can access the actions from a browser. The owner of the web action incurs the cost of running them. In other words, the owner of the action also owns the activations record. 
 final When applied to an action, any action parameters that were previously defined can't be overridden by parameters that are provided during invocation. 
 raw-http When applied to an action that has the web-export annotation, the HTTP request query and body parameters are passed to the action as reserved properties. 
 web-custom-options Enables a web action to respond to OPTIONS requests with customized headers. Otherwise, a [default CORS response](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions_webactions_web_options) applies. 
 require-whisk-auth The web action can be invoked only by requests that provide appropriate authentication credentials. When set to a boolean value, it controls whether the Basic Authentication value of the request is authenticated. A value of true authenticates the credentials, and a value of false invokes the action without any authentication. When set to an integer or a string, this value must match the request X-Require-Whisk-Auth header value. 







 Package annotations 



Annotations specific to packages.

 Annotation Description 

 description A description of the package. 
 parameters An array that describes parameters that are scoped to the package. 







 Parameter annotations
}
]
}{
"result_index": 1,
"results": [
{
"alternatives":
{
"transcript": "three "
}
],
"final": false
}
]
}{
"result_index": 1,
"results": [
{
"alternatives":
{
"transcript": "three four "
}
],
"final": false
}
]
}{
"result_index": 1,
"results": [
{
"alternatives":
{
"confidence": 0.99,
"transcript": "three four "
}
],
"final": true
}
]
}
Show more







 Example WebSocket exchanges 

The following examples show a series of exchanges between a client and the Speech to Text service over a single WebSocket connection. The examples focus on the exchange of messages and data. They do not show opening and closing the connection. (The examples are based on a previous-generation model, so the final transcript for each response includes a confidence field.)



 First example exchange 

In the first exchange, the client sends audio that contains the string Name the Mayflower. The client sends a binary message with a single chunk of PCM (audio/l16) audio data, for which it indicates the required sampling rate. The client does not wait for the {"state":"listening"} response from the service to begin sending the audio data and to signal the end of the request. Sending the data immediately reduces latency because the audio is available to the service as soon as it is ready to handle a recognition request.



* The client sends:

{
"action": "start",
"content-type": "audio/l16;rate=22050"
}
<binary audio data>
{
"action": "stop"
}
* The service responds:

{"state": "listening"}
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 

 HTTP Messaging API† https://{orgId}.messaging.internetofthings.ibmcloud.com/{base_URL} <br> <br>Curl example of [API call ![External link icon](https://cloud.ibm.com/docs-content/v1/icons/launch-glyph.svg)](https://docs.internetofthings.ibmcloud.com/apis/swagger/v0002/http-messaging.html/Devices%20and%20gateways/post_device_types__typeId__devices__deviceId__events__eventName_) to send a device event: <br>curl -X POST "https://{orgId}.internetofthings.ibmcloud.com/api/v0002/device/types/{deviceType}/devices/{deviceId}/events/{event_name}" -H "content-type: {contenttype}" -d "EventPayload" -u 'use-token-auth:{password}' <br>Where {contenttype} is one of the following: text/plain, application/json, application/xml, and application/octet-stream. 
 HTTP Application API https://{orgId}.internetofthings.ibmcloud.com/{base_URL} <br> <br>Curl example of [API call !
* pseudo_ipv4: Adds an IPv4 header to requests when a client is using IPv6, but the server only supports IPv4.
* response_buffering: Enable or disable buffering of responses from the origin server (Enterprise plan only).
* script_load_optimization: Improve the paint time for pages that include JavaScript.
* security_header: Enforce web security policy for your website.
* security_level: Choose the appropriate security profile for your website.
* server_side_exclude: Automatically hide specific content from suspicious visitors.
* tls_client_auth: TLS client certificate presented for authentication on origin pull (Enterprise plan only).
* true_client_ip_header: CIS will send the end user’s IP address in the True-Client-IP header (Enterprise plan only).
* waf: A Web Application Firewall (WAF) blocks requests that contain malicious content.
* websockets: Allow WebSockets connections to your origin server.
* proxy_read_timeout: Maximum time between two read operations from origin.



-i, --instance
: Instance name or ID. If not set, the context instance specified by ibmcloud cis instance-set INSTANCE is used.

--output
: Specify output format, only JSON is supported.





 Examples 

Get ciphers settings for domain 31984fea73a15b45779fa0df4ef62f9b.

ibmcloud cis domain-settings -f "ciphers" 31984fea73a15b45779fa0df4ef62f9b -i "cis-demo"







 ibmcloud cis domain-settings-update 

Update a feature for the domain.

ibmcloud cis domain-settings-update DNS_DOMAIN_ID (-f, --feature FEATURE) (-v, --value VALUE) [-i, --instance INSTANCE] [--output FORMAT]



 Command options 

DNS_DOMAIN_ID
: The ID of DNS domain. Required. -f, --feature value
: Feature of domain settings to update. Required.
Generic webhook triggers run when a POST request that is configured with the secret setting goes to the generic webhook URL. Generic webhook triggers provide a unique webhook URL for POST requests.

Because the PipelineRun UI does not hide the generic webhook payload values in the event payload section, do not include sensitive data in the payload. Instead, secure any data that is required by a generic webhook by using trigger properties, such as passwords or API key secrets.

You can secure generic webhook triggers to work with Git, a Slack outgoing webhook, an Artifactory webhook, and more by using any of the following methods:



* Token matches to compare the saved token and the token that is passed within the POST request. Supported token sources include a header, query, or payload. Token matches are used by GitLab webhooks and Slack outgoing webhooks.
* Payload digest matches to compare the signature and the hash that are generated from the digested payload by using HMAC hex digest with a saved token. Supported signature sources might include a header, query, or payload. Users must specify a digest algorithm. Payload digest matches are used by GitHub webhooks.
* Tekton task validation requires users to validate the webhook request within their Tekton tasks.



Specify the following values to use generic webhook triggers with GitHub webhooks:



* Securing: Payload Digest Matches
* Signature Source: Header
* Header Key Name: X-Hub-Signature
* Digest Algorithm: sha1.



Specify the following values to use generic webhook triggers with GitLab webhooks:



* Securing: Token Matches
* Token Source: Header
* Header Key Name: X-Gitlab-Token



Specify the following values to use generic webhook triggers with Slack outgoing webhooks:



* Securing: Token Matches
* Token Source: Payload
* JSON Property Name / Form Key: token



The following example shows how to use the curl command with a generic webhook that is secured with a Token Matches rule:

Zoom

!
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/services/IoT?topic=IoT-api_overviewapi_docs), and is typically api/v0002/.



 API Host URL 

 HTTP Messaging API† https://{orgId}.messaging.internetofthings.ibmcloud.com/{base_URL} <br> <br>Curl example of [API call ![External link icon](https://cloud.ibm.com/docs-content/v1/icons/launch-glyph.svg)](https://docs.internetofthings.ibmcloud.com/apis/swagger/v0002/http-messaging.html/Devices%20and%20gateways/post_device_types__typeId__devices__deviceId__events__eventName_) to send a device event: <br>curl -X POST "https://{orgId}.internetofthings.ibmcloud.com/api/v0002/device/types/{deviceType}/devices/{deviceId}/events/{event_name}" -H "content-type: {contenttype}" -d "EventPayload" -u 'use-token-auth:{password}' <br>Where {contenttype} is one of the following: text/plain, application/json, application/xml, and application/octet-stream. 
 HTTP Application API https://{orgId}.internetofthings.ibmcloud.com/{base_URL} <br> <br>Curl example of [API call !
It is useful to know the format of the request body of the premessage webhook so that your external code can process it.

The payload contains the request body of the /message (stateful or stateless) v2 API request. The event name message_received indicates that the request is generated by the premessage webhook. For more information about the message request body, see the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2message).

{
"payload" : { Copy of request body sent to /message }
"event": {
"name": "message_received"
}
}





 Response body 

The service that receives the POST request from the webhook must return a JSON object (Accept: application/json).

The response body must have the following structure:

{
"payload": {
...
}
}

The payload object in the response should contain the payload object that was received in the request body. Your code can modify property values in the message payload it received (for example, to update property values, or to add or remove context variables); but the message payload returned to the service must conform to the schema for a request to the message method. For more information, see the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2message).





 Example 1 

This example shows you how to check the language of the input text, and append the language info to the input text string.

In the premessage webhook configuration page, the following values are specified:



* URL: https://us-south.functions.appdomain.cloud/api/v1/web/e97d2516-5ce4-4fd9-9d05-acc3dd8ennn/default/check_language
* Secret: none
* Header name: Content-Type
* Header value: application/json



The premessage webhook calls an IBM Cloud Functions web action name check_language.
The SoftLayer® Application Programming Interface is the development interface that gives developers and system administrators direct interaction with IBM Cloud backend system. The SoftLayer API powers many of the features in the IBM Cloud console, which typically means if an interaction is possible in the IBM Cloud console, it can also be run in the API. Because you can programmatically interact with all portions of the IBM Cloud environment within the API, you can automate tasks with SoftLayer API.

The SoftLayer API is a Remote Procedure Call system. Each call involves sending data toward an API endpoint and receiving structured data in return. The format used to send and receive data with the SoftLayer API depends on which implementation of the API you choose. The SoftLayer API currently uses SOAP, XML-RPC, or REST for data transmission.

To programmatically audit system events for classic infrastructure, call the SoftLayer API as shown in the following example:



* Curl
* Java
* Python
* Go



https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?
resultLimit=0,50&
objectMask=mask[eventName,eventCreateDate,userType]

curl -g -u $SL_USER:$SL_APIKEY 'https://api.softlayer.com/rest/v3.1/SoftLayer_Event_Log/getAllObjects.json?objectMask=mask[eventName,eventCreateDate,userType]&resultLimit=0,50'

The output looks something like this,in this case just the first event in the list:

[
{
"eventCreateDate": "2021-03-29T14:41:55.444089-06:00",
"eventName": "Login Successful",
"userType": "CUSTOMER"
}
]

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.softlayer.api.ApiClient;
import com.softlayer.api.RestApiClient;
Security group API reference 

The SoftLayer Application Programming Interface (API) is the development interface that gives developers and system administrators direct interaction with SoftLayer's back-end system.

The SoftLayer API (SLAPI) powers many of the features in the Customer Portal, which typically means if an interaction is possible in the Customer Portal, it can also be run in the API. Because you can programmatically interact with all portions of the SoftLayer environment within the API, you can use the API to automate tasks. For example, you can use the SoftLayer_Virtual_Guest/createObject API to deploy a virtual server instance with a security group enabled.

The SoftLayer API is a Remote Procedure Call system. Each call involves sending data towards an API endpoint and receiving structured data in return. The format used to send and receive data with the SLAPI depends on which implementation of the API you choose.

For more information about the SoftLayer API, virtual server, and security group APIs, see the following resources in the SoftLayer Development Network:



*  [SoftLayer API Overview](https://softlayer.github.io/reference/softlayerapi/)
*  [Getting Started with the SoftLayer API](http://sldn.softlayer.com/article/getting-started)
*  [SoftLayer_Virtual_Guest/createObject API](http://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createObject)
*  [SoftLayer_Network_SecurityGroup API](https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup)
*  [SoftLayer_Virtual_Guest_Network_Component API](http://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component)
"name": "hello",
"version": "0.0.34",
"exec": {
"kind": "nodejs:10",
"binary": false
},
"annotations": [
{
"key": "web-export",
"value": true
},
{
"key": "raw-http",
"value": false
},
{
"key": "final",
"value": true
},
{
"key": "require-whisk-auth",
"value": 7819991076995522
},
{
"key": "exec",
"value": "nodejs:10"
}
],
"limits": {
"timeout": 60000,
"memory": 256,
"logs": 10,
"concurrency": 1
},
"publish": false
}







 Testing a secure web action with randomly generated value of X-Require-Whisk-Auth 

Test the hello web action and provide the randomly generated X-Require-Whisk-Auth value. Replace the <apihost> and <namespace_ID> values. Replace the <my-secret> value with the randomly generated number that you found in step 3 of [Creating a secure web action](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions_webactions_web_secure_create).

You can test the web action by using one of the following methods.



* Testing the web action by using a cURL command.

curl https://<apihost>/api/v1/web/<namespace_ID>/demo/hello.json?name=Jane -X GET -H "X-Require-Whisk-Auth: <my-secret>"
* Testing the web action by using a wget command.
console.log('nRetrieved a public key from Event Notifications..');
return responseData.public_key;
}

async function main(params) {

try {
const publicKey = await getPublicKey();

// Verify the notification data using the retrieved public key
const decodedNotification = await jwtVerify(params.__ow_body, publicKey).data.data;
console.log(nDecoded an incoming event notification from Secrets Manager:n${JSON.stringify(decodedNotification)});

text = Secrets Manager notificationn\${JSON.stringify(decodedNotification)}\;

const article = { "text": text };

// Post the decoded notification to Slack
await axios.post('<slack_webhook_url>', article)
console.log('nNotification successfully forwarded to Slack!');

} catch (error) {
console.error(error);
}
}
Show more



Table 1. Variables to replace in your Functions code

 Variable Description 

 API_KEY An IBM Cloud API key with Manager access on the Event Notifications service. 
 <event_notifications_endpoint_url> The base URL of your Event Notifications service instance. For more information, see the [Event Notifications API documentation](https://cloud.ibm.com/apidocs/event-notificationsevent-notifications-endpoint-url). 
 <destination_id> The ID of the Event Notifications destination that you created in [step 2](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-tutorial-expiring-secrets-part-3tutorial-expiring-secrets-part-3-update-en). 
 <slack_webhook_url> The incoming webhook URL that is associated with your Slack app.
IBM Cloud Load Balancer API reference 

The SoftLayer application programming interface (API) is the development interface that gives developers and system administrators direct interaction with the SoftLayer back-end system.

The SoftLayer API (SLAPI) powers many of the features in the Customer Portal. Generally, if an interaction is possible in the Customer Portal, it can also be run in the API. Because you can programmatically interact with all portions of the SoftLayer environment within the API, you can use the API to automate tasks.

The SLAPI is a Remote Procedure Call system. Each call involves sending data towards an API endpoint and receiving structured data in return. The format used to send and receive data with the SLAPI depends on which implementation of the API you choose. The SLAPI currently uses SOAP, XML-RPC or REST for data transmission.

For more information about the SoftLayer API, IBM Cloud® Load Balancer Service APIs, see the following resources in the SoftLayer Development Network:



* [Getting Started with the SoftLayer API](https://softlayer.github.io/article/getting-started/)
* [SoftLayer_Product_Package API](https://softlayer.github.io/reference/services/SoftLayer_Product_Package/)
* [SoftLayer_Network_LBaaS_LoadBalancer API](https://softlayer.github.io/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/)
* [SoftLayer_Network_LBaaS_Listener API](https://softlayer.github.io/reference/services/SoftLayer_Network_LBaaS_Listener/)
* [SoftLayer_Network_LBaaS_Member API](https://softlayer.github.io/reference/services/SoftLayer_Network_LBaaS_Member/)
* [SoftLayer_Network_LBaaS_HealthMonitor API](https://softlayer.github.io/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/)
{location}.text-to-speech.watson.cloud.ibm.com/instances/{instance_id} to {ws_url}. So all WebSocket examples call the method as {ws_url}/v1/synthesize.

A WebSocket client calls the /v1/synthesize method with the following query parameters to establish an authenticated connection with the service:

access_token (required string)
: Pass a valid access token to authenticate with the service. You must use the access token before it expires.



IBM Cloud

Pass an Identity and Access Management (IAM) access token to authenticate with the service. You pass an IAM access token instead of passing an API key with the call. For more information, see [Authenticating to IBM Cloud](https://cloud.ibm.com/docs/watson?topic=watson-iamgs-credential-cloud).
IBM Cloud Pak for Data

Pass an access token as you would with the Authorization header of an HTTP request. For more information, see [Authenticating to IBM Cloud Pak for Data](https://cloud.ibm.com/docs/watson?topic=watson-iamgs-credential-cpd).



voice (optional string)
: Specifies the voice in which the text is to be spoken in the audio. Use the /v1/voices method to get the current list of supported voices. Omit the parameter to use the default voice. For more information, see [Languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices) and [Using the default voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-usespecify-voice-default).

customization_id (optional string)
: Specifies the globally unique identifier (GUID) for a custom model that is to be used for the synthesis. A specified custom model must match the language of the voice that is used for the synthesis.