vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* ignore-all: Ignore all query arguments
* ignore: space separated query-args: Ignores those specific query arguments. For example, "ignore: query1 query2"
* include: space separated query-args: Includes those specific query arguments. For example, "include: query1 query2"





Of particular note is the uniqueId, which is generated when a mapping is created and is used as a parameter to subsequent API calls.

For example, this call to listDomainMappingByUniqueid

$cdnMapping = $client->listDomainMappingByUniqueid('750352919747xxx');

Returns an object similar to this one:

[0] => SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping Object
(
[cacheKeyQueryRule] => include-all
[certificateType] => NO_CERT
[cname] => api-testing.cdn.appdomain.cloud.
[akamaiCname] => wildcard.appdomain.mdc.edgekey.net.
[domain] => api-testing.cdntesting.net
[header] => origin.cdntesting.net
[httpPort] => 80
[httpsPort] =>
[originHost] => origin.cdntesting.net
[originType] => HOST_SERVER
[path] => /media/
[performanceConfiguration] => General web delivery
[protocol] => HTTP
[respectHeaders] => 0
[serveStale] => 1
[status] => RUNNING
[uniqueId] => 750352919747xxx
[vendorName] => akamai
)

Show more

Calls to stopDomainMapping and startDomainMapping will return the same Mapping object, with the status being the difference.

[0] => SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping Object
(
...

[status] => STOPPED
"parameter name": "parameter value",
"parameter name": "parameter value"
}
}
}
]
}
}
Show more



Each command type along with its related parameters are described in the following sections.



 command_info.type : configure 

Dynamically reconfigures the Text to Speech service by applying a set of configuration parameters, which can be based on the dialog or action flow. For example, you might want to choose a particular voice at a specific point in the conversation.



 parameter description required default 

 synthesize The Text to Speech service configuration to use when synthesizing audio. The parameters defined by this object are used when connecting to the Text to Speech service for speech synthesis requests. For more information about these parameters, see the [Text to Speech API documentation](https://cloud.ibm.com/apidocs/text-to-speechsynthesize-audio-websockets-). yes Current Text to Speech configuration 
 update_strategy Specifies the update strategy to use when setting the speech configuration. Possible values include:<br><br><br><br> * replace: Replaces the configuration for the rest of the session. Any root-level fields in the new configuration completely overwrite the previous configuration.<br> * replace_once: Replaces the configuration only for the next turn of the conversation. Subsequently, the previous configuration is used.<br> * merge: Merges the new configuration with the existing configuration for the rest of the session. Only changed parameters are overwritten; any other configuration parameters are unchanged.<br> * merge_once: Merges the new configuration with the existing configuration only for the next turn of the conversation. Subsequently, the previous configuration is used.<br><br><br> no replace 



The parameters that you can set for synthesize reflect the parameters that are made available by the Text to Speech WebSocket interface. The WebSocket API sends two types of parameters: query parameters, which are sent when phone integration connects to the service, and message parameters, which are sent as part of the JSON data in the request body.
Based on the earlier example, edit all the deployments for 068f8a20-8b27-4049-91fe-a3ff5f505352 and 45333bd7-79f5-475f-9b14-9fe99734592a.

Always verify that the changes that you requested have been made.





 Service parameter definitions 

parameters
: An array of key-value pairs that are defined by the service when the service instance is created.

"parameters": [{
"name": "nodes",
"displayname": "Number of Data Nodes"
}]

parameters.name
: The key of the parameter.

parameters.displayname
: The name of the parameter that is displayed.

parameters.type
: The type of input field that is displayed by the IBM Cloud user interface. The value can be text, password, dropdown, check box, or radio.

This value is required.

{
"name": "pwd",
"displayname": "Password",
"type": "password"
},

parameters.options
: A JSON structure to specify available values for dropdown, check box, and radio input type.

parameters.options.displayname
: The name of the dropdown, check box, or radio button that you want to display in the UI.

parameters.options.value
: The value of the parameter to be sent to the service broker when creating the service.

"options": [
{
"displayname": "HDFS",
"value": "hdfs"
},
{
"displayname": "YARN",
"value": "yarn"
},
]

parameters.value
: The default value of the parameter. For check box input type, it can be an array of values.

["hfs","yarn"]

parameters.layout
: Specifies the layout of check box or radio input types. When unspecified, the default layout is horizontal.

parameters.associations
Parameters message DigestRequest { bytes State = 1; bytes Data = 2; } message DigestResponse { bytes Digest = 3; } 
 Return values Wraps EP11 error into message Grep11Error. 



Code snippets



* Golang code snippet

digestData := []byte("Create a digest for this string")
DigestRequest := &pb.DigestRequest {
State: DigestInitResponse.State,
Data: digestData,
}

DigestResponse, err := cryptoClient.Digest(context.Background(), DigestRequest)
* JavaScript code snippet

client.Digest({
State: state,
Data: Buffer.from(digestData)
}, (err, data={}) => {
cb(err, data.Digest);
});
}







 DigestUpdate 

The DigestUpdate function continues a multiple-part digesting operation. Before you call this function, make sure to run DigestInit first. When you set parameters, note not to specify the length of the input data to be zero and the pointer that points to the input data location to be NULL.

Enterprise PKCS #11 over gRPC

Enterprise PKCS #11

PKCS #11





 Description Binds to EP11 m_DigestUpdate, which is an implementation of PKCS #11 C_DigestUpdate. 
 Parameters message DigestUpdateRequest { bytes State = 1; bytes Data = 2; } message DigestUpdateResponse { bytes State = 1; } 
 Return values Wraps EP11 error into message Grep11Error. 



Code snippets



* Golang code snippet

// Use DigestUpdate if you would like to breakup
// the digest operation into multiple suboperations
DigestUpdateRequest1 := &pb.DigestUpdateRequest {
State: DigestInitResponse.State,
Data: digestData[:16],
}
* Optional: Limits the response to keys that begin with the specified PREFIX.



* Flag: --prefix PREFIX



* Optional: The SIZE of each page to get in the service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the service, retrieving fewer items in each call. This can help prevent the service calls from timing out.



* Flag: --page-size SIZE



* Optional: The total NUMBER of items to return in the command's output.



* Flag: --max-items NUMBER



* Optional: Output FORMAT can be only json or text.



* Flag: --output FORMAT













 List in-progress multipart uploads 



* Action: Lists in-progress multipart uploads.
* Usage:ibmcloud cos multipart-uploads --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--key-marker value] [--upload-id-marker value] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
* Parameters to provide:



* The name of the bucket.



* Flag: --bucket BUCKET_NAME



* Optional: A DELIMITER is a character that you use to group keys.



* Flag: --delimiter DELIMITER



* Optional: Requests to encode the object keys in the response and specifies the encoding METHOD to use.



* Flag: --encoding-type METHOD



* Optional: Limits the response to keys that begin with the specified PREFIX.



* Flag: --prefix PREFIX



* Optional: Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.



* Flag: --key-marker value



* Optional: Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.



* Flag: --upload-id-marker value
: An array of selected values that are associated with the custom parameter that you want to interact with. This parameter shows in the UI when one of those values is selected.

parameters.associations.parameters.optionsRefresh
: When this parameter is set to true, the optionsUrl is called when the associated parameter value is changed and this parameter is visible in the UI.

parameters.optionsUrl
: The API that is called by the console to get a list of options for dropdown, check box, or radio input type. The response is a JSON structure that contains two fields:

options
: An array of JSON that will return parameters.options; for more details see the entry for parameters.options.

value
: The new default value of the parameter. For more details, see the entry for parameters.value.

The console passes the ace_config query parameter, which contains the current org GUID, space GUID, the current value of all custom parameters, and the current price plan ID. The bearer token is propagated in the header.

parameters.invalidmessage
: The message that appears when the content of the text box is invalid.

parameters.description
: The description of the parameter that is displayed to help users with the value of the parameter.

parameters.required
: A Boolean value that indicates whether the parameter must be entered in the IBM Cloud user interface.

parameters.pattern
: A regular expression that the value is checked against.

parameters.placeholder
: A short hint that describes the expected value.

parameters.readonly
: A Boolean value that indicates whether the value of the parameter is displayed only and cannot be changed by users. The default value is false.

parameters.hidden
: A Boolean value that indicates whether the key-value pair is hidden from users. The default value is false.
Parameters message VerifyUpdateRequest { bytes State = 1; bytes Data = 2; } message VerifyUpdateResponse { bytes State = 1; } 
 Return values Wraps EP11 error into message Grep11Error. 



Code snippets



* Golang code snippet

// Use VerifyUpdate if you would like to breakup
// the verify operation into multiple suboperations
VerifyUpdateRequest1 := &pb.VerifyUpdateRequest {
State: VerifyInitResponse.State,
Data: msgHash[:16],
}

VerifyUpdateResponse, err := cryptoClient.VerifyUpdate(context.Background(), VerifyUpdateRequest1)

VerifyUpdateRequest2 := &pb.VerifyUpdateRequest {
State: VerifyUpdateResponse.State,
Data: msgHash[16:],
}

VerifyUpdateResponse, err := cryptoClient.VerifyUpdate(context.Background(), VerifyUpdateRequest2)
* JavaScript code snippet

client.VerifyUpdate({
State: state,
Data: digest
}, (err, response) => {
callback(err, response);
});







 VerifyFinal 

The VerifyFinal function finishes a multiple-part verification operation.

Enterprise PKCS #11 over gRPC

Enterprise PKCS #11

PKCS #11





 Description Binds to EP11 m_VerifyFinal, which is an implementation of PKCS #11 C_VerifyFinal. 
 Parameters message VerifyFinalRequest { bytes State = 1; bytes Signature = 2; } message VerifyFinalResponse { } 
 Return values Wraps EP11 error into message Grep11Error. 



Code snippets



* Golang code snippet

VerifyFinalRequest := &pb.VerifyFinalRequest {
State: VerifyUpdateResponse.State,
Signature: SignResponse.Signature,
}
"version": 2,
"type": "WEBHOOK",
"enabled": true,
"name": "test-tip-webhook",
"options": {
"notifyOnOk": false,
"url": "https://test-tip.endpoint.com",
"notifyOnResolve": true
}
}
}

Request body parameters: All the response body parameters specified in GET notification channel except:



* createdOn
* modifiedOn



Note: Notification version can get through response body of [notificationChannels API](https://cloud.ibm.com/docs/monitoring?topic=monitoring-notifications_apifetch-specific-user-notification). User can also add [customHeaders & customData](https://docs.sysdig.com/en/configure-a-webhook-channel.htmlal_UUID-a6715905-0530-a08a-a3ab-cb10b2c5d19b_UUID-f9896786-62e5-c4c3-d2ef-38d3a2f7dfab) to notfications based on their requirements.





 Notifications schema: Request body 

See schema for getting information about 1 or more notifications channels:

{
"notificationChannel": {
"id": 20,
"version": 1,
"type": "",
"enabled": true,
"name": "",
"options": {
"notifyOnOk": false,
"notifyOnResolve": true,
"resolveOnOk": true,
"channel": "",
"emailRecipients": "",
"url" : "",
"apiKey": "",
"routingKey": "",
"account": "",
"serviceKey": "",
"serviceName": ""
}
}
The value parameter is the value to match the rule condition.
* ibmcloud is load-balancer-listener-policy-create 72251a2e-d6c5-42b4-97b0-b5f8e8d1f479 72b27b5c-f4b0-48bb-b954-5becc7c1dcb3 --action reject --priority 3 --name my-policy --output JSON
* ibmcloud is lb-lpc f5b20e9b-a77b-43e9-aa2d-a3a5ac9fe8fd 5cb08c12-004f-4587-87f4-ef46e799da50 --priority 3 --action https_redirect --target-listener-id d7e0543c-4e0f-4c0d-89aa-73f0f028ec61 --target-listener-http-status-code 303 When the action is "https_redirect", the "target-listener-id" and "http_status_code" are required. Possible values for "http_status_code" are "301", "302", "303", "307", or "308".
* ibmcloud is lb-lpc f5b20e9b-a77b-43e9-aa2d-a3a5ac9fe8fd 5cb08c12-004f-4587-87f4-ef46e799da50 --priority 3 --action https_redirect --target-listener-id d7e0543c-4e0f-4c0d-89aa-73f0f028ec61 --target-listener-http-status-code 307 --target-uri /example When the action is "https_redirect", the "target-listener-id" and "http_status_code" are required. The "uri" is the redirect target URI, it's an optional field.
Some parameter values are Cloud Resource Names (CRNs), which uniquely identify a resource in the cloud. All parameter names and values are passed as strings.

For example, if a database is being provisioned from a particular backup and the new database deployment needs a total of 9 GB of memory across three members, then the command to provision 3 GB per member looks like:

ibmcloud resource service-instance-create example-database <service-name> standard us-south -p '{
"backup_id": "crn:v1:blue:public:databases-for-mysql:us-south:a/54e8ffe85dcedf470db5b5ee6ac4a8d8:1b8f53db-fc2d-4e24-8470-f82b15c71717:backup:06392e97-df90-46d8-98e8-cb67e9e0a8e6",
"members_memory_allocation_mb": "3072"
}'







 Provisioning through the Resource Controller API 

Provision new deployments with the [Resource Controller API](https://cloud.ibm.com/apidocs/resource-controller/resource-controller). To use the Resource Controller API, you need some additional preparation.



1. [Obtain an IAM token from your API token](https://cloud.ibm.com/apidocs/resource-controller/resource-controllerauthentication).
2. You need to know the ID of the resource group that you would like to deploy to. This information is available through the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_commands_resourceibmcloud_resource_groups).

Use a command like:

ibmcloud resource groups
3. You need to know the region to which you would like to deploy.

To list all of the regions that deployments can be provisioned into from the current region, use the Cloud Databases CLI plug-in.

The command looks like:

ibmcloud cdb regions --json
invalid_generation_parameter 

Message: The generation query parameter is invalid.

For versions on and after 5/31/2019, the 'generation' query parameter must be set to 1 to allow VPC API requests for use with generation 1 compute resources and set to 2 to allow VPC API requests for use with generation 2 compute resources.

How to set the generation parameter

In the CLI: ibmcloud is target --gen 1

In the API:

curl -X GET "$rias_endpoint/v1/regions?version=$version&generation=1"
-H "Authorization: $iam_token"





 invalid_id_format 

Message: Bad ID format. Ensure format is correct.

Make sure that the ID you provided does not contain any malformed data.

You may get this error message if you provide a malformed start query when making a pagination request. For example, GET /v1/network_acls?start=23fbba08-ceb3-4cbe-a951-84ff20a06069?version=$version&generation=1 contains two ?s. Fix the query and try again.





 invalid_route 

Message: The requested route does not exist.

The requested route on the API URL you provided does not exist. Verify that the URL you specified to call the API endpoint is correct.





 invalid_request_field 

Message: A field provided in the request is not valid.

For example, to update the network ACL used by a subnet use the PATCH /v1/subnets/{subnet_id}?version=$version&generation=1 -d '{ "network_acl":{ "id": “{network_acl_id}” } }’ API.

The following request would be invalid because “networkacl” is not a valid field, PATCH /v1/subnets/{subnet_id}?version=$version&generation=1 -d '{ "networkacl":{ "id": “{network_acl_id}” } }’
Table 5. The base_model_version 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 







 character_insertion_bias 

An optional float between -1.0 and 1.0 that indicates whether the service is biased to recognize shorter (negative values) or longer (positive values) strings of characters when developing transcription hypotheses. By default, the service uses a default bias of 0.0. The value that you specify represents a change from a model's default. For more information, see [Character insertion bias](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-parsinginsertion-bias).



Table 6. The character_insertion_bias parameter

 Availability and usage Description 

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







 Content-Type 

An optional audio format (MIME type) that specifies the format of the audio data that you pass to the service. The service can automatically detect the format of most audio, so the parameter is optional for most formats. It is required for the audio/alaw, audio/basic, audio/l16, and audio/mulaw formats. For more information, see [Specifying an audio format](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formatsaudio-formats-specifying).



Table 7. The Content-Type parameter

 Availability and usage Description 

 Previous-generation models Generally available for all languages. 
 Next-generation models Generally available for all languages. 
 WebSocket content-type parameter of JSON start message
Some parameter values are Cloud Resource Names (CRNs), which uniquely identify a resource in the cloud. All parameter names and values are passed as strings.

For example, if a database is being provisioned from a particular backup and the new database deployment needs a total of 9 GB of memory across three members, then the command to provision 3 GBs per member looks like:

ibmcloud resource service-instance-create databases-for-elasticsearch <SERVICE_NAME> standard us-south -p '{
"backup_id": "crn:v1:blue:public:databases-for-elasticsearch:us-south:a/54e8ffe85dcedf470db5b5ee6ac4a8d8:1b8f53db-fc2d-4e24-8470-f82b15c71717:backup:06392e97-df90-46d8-98e8-cb67e9e0a8e6",
"members_memory_allocation_mb": "3072"
}'







 Provisioning through the Resource Controller API 

Follow these steps to provision using the [Resource Controller API](https://cloud.ibm.com/apidocs/resource-controller/resource-controller).



1. Obtain an [IAM token from your API token](https://cloud.ibm.com/apidocs/resource-controller/resource-controllerauthentication).
2. You need to know the ID of the resource group that you would like to deploy to. This information is available through the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_commands_resourceibmcloud_resource_groups).

Use a command like:

ibmcloud resource groups
3. You need to know the region you would like to deploy to.
For example, if you call the Hello World Cloud Functions web action, you might want to add the following information to pass in the message parameter that is accepted by that application:



Parameter example

 Key Value 

 message hello 



When calling a Cloud Functions web action, you cannot pass parameters with the same key as parameters that are defined as part of the web action. See [Protected parameters](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-actions_webactions_web_protect_parameters) for more details.
8. You can edit the dialog node response to include only the section of the response that you want to display to users.

The Hello World Cloud Functions web action includes a message name and value pair in its response, along with other information. To show only the content of the message, you can use <return-variable>.message syntax to extract the message section only from the response object.



Conditional responses example

 Condition Response 

 $webhook_result_1 The application returned "$webhook_result_1.message". 
 anything_else The call to the external application failed. Please try again later. 



9. When you are done, click the X to close the node. Your changes are automatically saved.







 Updating output.generic with a webhook 

You can use a webhook to update output.generic and provide dynamic responses. The blog article [How to Dynamically Add Response Options to Dialog Nodes in Watson Assistant](https://medium.com/ibm-data-ai/how-to-dynamically-add-response-options-to-dialog-nodes-in-watson-assistant-e14c5e08beca) shows you how.
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 

An optional boolean that indicates whether the service returns metrics about its processing of the input audio. By default (false), the service returns no processing metrics. For more information, see [Processing metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metricsprocessing-metrics).



Table 19. The processing_metrics 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 Not supported 
 Asynchronous HTTP Query parameter of POST /v1/recognitions method 







 processing_metrics_interval 

An optional float of at least 0.1 that indicates the interval at which the service is to return processing metrics. If the processing_metrics parameter is true, the service returns processing metrics every 1.0 seconds by default. For more information, see [Processing metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metricsprocessing-metrics).



Table 20. The processing_metrics_interval 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 Not supported 
 Asynchronous HTTP Query parameter of POST /v1/recognitions method