vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* protocol - (Required) Supported protocols are HTTP, HTTPS, or HTTP_AND_HTTPS.
* certificateType - (Required) for HTTPS protocol. SHARED_SAN_CERT or WILDCARD_CERT.
* path - Path from which the cached content is served. Default path is /.
* httpPort, httpsPort, or both - (Required for Host Server) These two options must correspond to the wanted protocol. If the protocol is HTTP, then httpPort must be set, and httpsPort must not be set. Likewise, if the protocol is HTTPS, then httpsPort must be set, and httpPort must not be set. If the protocol is HTTP_AND_HTTPS, then bothhttpPort and httpsPortmust be set. Akamai has certain limitations on port numbers. See the [FAQ](https://cloud.ibm.com/docs/CDN?topic=CDN-faqsare-there-any-restrictions-on-what-port-numbers-are-allowed) for allowed port numbers.
* header - Specifies host header information that is used by the origin server.
* respectHeader - A Boolean value that, if set to true, causes TTL settings in the origin to override CDN TTL settings.
* cname - Provide an alias to the hostname. The CNAME is generated if one is not provided.
* bucketName - (Required for Object Storage only) Bucket name for your S3 Object Storage.
* fileExtension - (optional for Object Storage) File extensions that are allowed to be cached.
* cacheKeyQueryRule - The following options are available to configure Cache Key behavior. If no cacheKeyQueryRule arguments are supplied, it defaults to "include-all".



* include-all - Includes all query arguments default.
* ignore-all - Ignores 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).
"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
: A JSON structure to describe the interactions with price plans and/or other custom parameters.

This value is optional, and all subsequent values that are appended to parameters.associations.<value> are optional.

"type": "text",
"associations": {
"plan": {
"showFor": ["apsMyserviceParametersDemo-entry","apsMyserviceParametersDemo-enterprise"]
}
}

parameters.associations.plan
: A JSON structure to describe the interaction with price plans.

parameters.associations.plan.showFor
: An array of price plan IDs. If specified, the parameter is shown in the UI when the corresponding price plan is selected.

parameters.associations.plan.optionsRefresh
: When specified, the optionsUrl is called when the associated price plan is selected.

parameters.associations.parameters
: An array of JSON describing the interaction with other custom parameters.

parameters.associations.parameters.name
: The name of the other custom parameter that you want to interact with.

Required when parameters.associations.parameters is in use.

parameters.associations.parameters.showFor
: 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.
An optional double between 0.0 and 1.0 that specifies the threshold at which the service reports acoustically similar alternatives for words of the input audio. By default, word alternatives are not returned. For more information, see [Word alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-spottingword-alternatives).



Table 29. The word_alternatives_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 







 word_confidence 

An optional boolean that indicates whether the service provides confidence measures for the words of the transcript. By default (false), word confidence measures are not returned. For more information, see [Word confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metadataword-confidence).



Table 30. The word_confidence parameter

 Availability and usage Description 

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







 X-Watson-Learning-Opt-Out 

IBM Cloud

An optional boolean that indicates whether you opt out of the default request logging that IBM performs to improve the service for future users. To prevent IBM from accessing your data for general service improvements, specify true for the parameter. If you opt out, the service logs no user data from your requests, saving no audio or text to disk. You can also opt out at the account level. For more information, see [Request logging](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-data-securitydata-security-request-logging).



Table 31.
* --name: New name of the connection.
* --output json: Optional: Specify if you want the output displayed in JSON format.
* --help | -h: Optional: Get help on this command.





 Example 

This example illustrates updating the name of a connection to MyConn2:

ibmcloud tg cu $gateway $connection --name MyConn2







 Editing a connection with the API 

You can update the name of a connection for a transit gateway with the API.



 Request 

To edit a connection, set the following parameters:



Table 1. Path parameters for editing a connection

 Path parameters Details 

 transit_gateway_id <br>Required <br>string The Transit Gateway identifier 
 id <br>Required <br>string The connection identifier 





Table 2. Query parameters for editing a connection

 Query parameters Details 

 version <br>Required <br>string Requests the version of the API as of a date in the format YYYY-MM-DD. Any date up to the current date may be provided. Specify the current date to request the latest version. <br>Possible values: Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ 
 Request Body <br>Required <br>TransitGatewayConnectionActions The action template 
 name <br>Name The user-defined name for this transit gateway connection. <br>Name specification is required for network type gre_tunnel and unbound_gre_tunnel connections. <br>Possible values: 1 ≤ length ≤ 63, Value must match regular expression ^([a-zA-Z] 





 Example Request 

This example illustrates editing the name of a transit gateway connection:

PATCH
/transit_gateways/{transit_gateway_id}/connections/{id}
{
"name": "Transit_Service_BWTN_SJ_DL",
"prefix_filters_default": "permit"
}







 Response 

The following response shows after you initiate the request:



Table 3. Initiation request

 Response body Details
* Queue manager platform: UNIX
* Queue manager command level: (930/922)
* Command issued: dmpmqcfg -c default -m <queue_manager_1_name> -u <username> -a


This is an important step as when running the next command, some of the optional parameters used won't provide a chance to input an apikey, but will instead read the first line of the specified file.

With the apikey added to the configuration file, it can now be applied to other queue managers. Using runmqsc, the optional parameter -f <filename> the input can be processed from the .mqsc file created in the previous task. The optional parameter -c must be used to ensure a client connection. The queue manager this configuration is being applied to must also be provided, for example:

runmqsc -f /mq/backups/<queue_manager_1_name>.mqsc -c -u <username> <queue_manager_2_name>

This will read the file created in the previous step and process every command. Once completed successfully, the settings of the second queue manager will match the settings of the first queue manager.





 Conclusion 

You have successfully:



* Created a configuration backup of a queue manager
* Applied a backup of a queue manager's configuration to a new queue manager.
curl -X POST https://web-qm1-abcd.qm.eu-gb.mqcloud.ibm.com/ibmmq/rest/v3/admin/action/qmgr/QM1/mqsc -H "Accept: application/json" -H "Content-Type: application/json" -H "ibm-mq-rest-csrf-token: value" --data '{
"type": "runCommand",
"parameters": {
"command": "DEFINE QLOCAL(TEST.QUEUE)"
}
}' -b cookiejar.txt

You can then display the created queue by running the following command.

curl -X POST https://web-qm1-abcd.qm.eu-gb.mqcloud.ibm.com/ibmmq/rest/v3/admin/action/qmgr/QM1/mqsc -H "Accept: application/json" -H "Content-Type: application/json" -H "ibm-mq-rest-csrf-token: value" --data '{
"type": "runCommand",
"parameters": {
"command": "DISPLAY QLOCAL(TEST.QUEUE)"
}
}' -b cookiejar.txt







 Sending and receiving messages 

The messaging REST API allows you to send and retrieve messages on a desired queue within an IBM queue manager.

The messaging REST API documentation can be found [here](https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.dev.doc/q130960_.htm).



 Non 'DEV.' queues 

If a new queue has been created whose name does not start with 'DEV.' the predefined authorization records will not apply. Therefore applications will not have the required permissions to send or receive messages to this queue.
* Flag: --upload-id-marker value



* 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. (default: 1000).



* Flag: --page-size SIZE



* Optional: The total NUMBER of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. (default: 0).



* Flag: --max-items NUMBER



* Optional: The REGION where the bucket is present. If this flag is not provided, the program uses the default option that is specified in config.



* Flag: --region REGION



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



* Flag: --output FORMAT











 List objects 



* Action: List files present in a bucket in a user's IBM Cloud Object Storage Account. This operation is currently limited to the 1000 most recently created objects and can't be filtered.
* Usage:ibmcloud cos objects --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--starting-token TOKEN] [--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
* RECIP(value) is the value of -dn of Receiver(i.e. bob) in this tutorial.
* Detailed explanation about SET POLICY command can be found [here](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.ref.adm.doc/q120800_.html).



![Image showing AMS Protection Policy set on queue](https://cloud.ibm.com/docs-content/v1/content/3a120b16db5fdc3e70d071af8a63ce5515c1b096/mqcloud/images/mqoc_app_ams_policy_set.png)
7. Verify the AMS policy we just defined: to make sure the policy is defined and configured correctly with signing and encryption as per our setup, use the following command.

DISPLAY POLICY(DEV.QUEUE.1)

![Image showing AMS Protection Policy display from runmqsc](https://cloud.ibm.com/docs-content/v1/content/3a120b16db5fdc3e70d071af8a63ce5515c1b096/mqcloud/images/mqoc_app_ams_policy_display.png)





 Create an Alias Queue to verify message encryption 

To demonstrate that the messages are encrypted when stored in a queue, we use an alias queue. Retrieving messages via the alias queue will not trigger the interceptors on the target queue, so the message will be retrieved as it is, that is without decryption, and so it will give an accurate view on whether the message is plain text or encrypted.



1. Create an alias queue that targets to a queue

DEFINE QALIAS (DEV.QUEUE.1.ALIAS) TARGET (DEV.QUEUE.1)



* DEV.QUEUE.1.ALIAS is our name for the alias queue
* DEV.QUEUE.1 is the target queue we are using in this tutorial



!
For more information about the message request body, see the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2message).

The following sample shows how a simple request body is formatted.

{
"event": {
"name": "message_processed"
},
"options": {},
"payload": {
"output": {
"intents": [
{
"intent": "General_Greetings",
"confidence": 1
}
],
"entities": [],
"generic": [
{
"response_type": "text",
"text": "Hello. Good evening"
}
]
},
"user_id": "test user",
"context": {
"global": {
"system": {
"user_id": "test user",
"turn_count": 11
},
"session_id": "sxxx"
},
"skills": {
"actions skill": {
"user_defined": {
"var": "anthony"
},
"system": {
"state": "nnn"
}
}
}
}
}
Show more





 Example 1 

This example shows you how to add y'all to the end of each response from the assistant.

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



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



The postmessage webhook calls an IBM Cloud Functions web action name add_southern_charm.
They are the same parameters as the input.auto.tfvars file that you use with the cli.







 Catalog Tile deployment 

When you use the Catalog Tile for deployment, you:



* Select the SAP NetWeaver (ABAP stack) with Db2 standard system tile from the catalog
* Enter information for your workspace. The Catalog Tile creates a Schematics workspace for you.
* Modify the parameters for your bastion server, personal credential information, and other parameters specific to your solution.







 Support - Terraform and Schematics 

There are no warranties of any kind, and there is no service or technical support available for these materials from IBM®. As a recommended practice, review carefully any materials that you download from this site before using them on a live system.

Though the materials provided herein are not supported by the IBM Service organization, your comments are welcomed by the developers, who reserve the right to revise, re-adapt or remove the materials at any time. To report a problem, or provide suggestions or comments, open a GitHub issue.





 Support - Catalog Tile 

The Catalog Tile offering is IBM Cloud supported. For more information, see [Getting help and support from IBM Cloud or SAP](https://cloud.ibm.com/docs/sap?topic=sap-help-support&interface=ui).

If client issues are identified with SAP software, then SAP Support will assist client. Please follow the recommendations of SAP Note 90835, which describes the SAP Incident Escalation Procedure. This SAP Note (and others) is found at [https://support.sap.com/en/index.html](https://support.sap.com/en/index.html)





 Before you begin 

Before you use the scripts in the Bastion cli or Schematics:



* Set up your account to access the VPC. Make sure that your account is [upgraded to a paid account](https://cloud.ibm.com/docs/account?topic=account-accountfaqschangeacct).
* If you have not already, create a bastion server to store the SAP kits.
Detailed information about the restore request parameters are available in the [API Reference](https://cloud.ibm.com/docs/services/cloud-object-storage/api-reference?topic=cloud-object-storage-object-operationsobject-operations-archive-restore)

function restoreItem(bucketName, itemName) {
var params = {
Bucket: bucketName,
Key: itemName,
RestoreRequest: {
Days: <number-of-days>,
GlacierJobParameters: {
Tier: 'Bulk'
},
}
};

return cos.restoreObject(params).promise()
.then(() => {
console.log(Restoring item: ${itemName} from bucket: ${bucketName});
})
.catch((e) => {
console.log(ERROR: ${e.code} - ${e.message}n);
});
}
Show more

Key Values



* <number-of-days> - Number of days to keep the restored file



SDK References



* [restoreObject](https://ibm.github.io/ibm-cos-sdk-js/AWS/S3.html)







 View HEAD information for an object 

function getHEADItem(bucketName, itemName) {
return cos.headObject({
Bucket: bucketName,
Key: itemName
}).promise()
.then((data) => {
console.log(Retrieving HEAD for item: ${itemName} from bucket: ${bucketName});
console.log(JSON.stringify(data, null, 4));
})
.catch((e) => {
console.log(ERROR: ${e.code} - ${e.message}n);
});
}

SDK References
For more information about the message request body, see the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2message).

The following sample shows how a simple request body is formatted.

{
"event": {
"name": "message_processed"
},
"options": {},
"payload": {
"output": {
"intents": [
{
"intent": "General_Greetings",
"confidence": 1
}
],
"entities": [],
"generic": [
{
"response_type": "text",
"text": "Hello. Good evening"
}
]
},
"user_id": "test user",
"context": {
"global": {
"system": {
"user_id": "test user",
"turn_count": 11
},
"session_id": "sxxx"
},
"skills": {
"main skill": {
"user_defined": {
"var": "anthony"
},
"system": {
"state": "nnn"
}
}
}
}
}
Show more





 Example 1 

This example shows you how to add y'all to the end of each response from the assistant.

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



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



The postmessage webhook calls an IBM Cloud Functions web action name add_southern_charm.
: Parameter values in the KEYVALUE format. This flag is optional.

--param-fileFILE, -PFILE
: A JSON file that contains parameter KEYS and VALUES. This flag is optional.

--trigger-paramKEYVALUE, -pKEYVALUE
: Trigger parameter values in the KEYVALUE format. This flag is optional.

--feed-paramKEYVALUE, -pKEYVALUE
: Feed parameter values in the KEYVALUE format. This flag is optional.





 Examples 

ibmcloud fn trigger update mytrigger --param name Jim

ibmcloud fn trigger update mytrigger --trigger-param name Jim

ibmcloud fn trigger update mytrigger --feed-param cron "0,1,2,3,4"
"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",
"x-global-k8fdic-transaction-id": "11fd03071bd0841d3a00f52354ab880f",
"x-real-ip": "XXX.XX.XX.XX",
"x-request-id": "11fd03071bd0841d3a00f52354ab880f"
},
"__ow_method": "get",
"__ow_path": ""
}







 HTTP context 

All web actions, when invoked, receive HTTP request details as input parameters to the action argument.



HTTP parameter descriptions.

 HTTP parameter Type Description 

 __ow_method String The HTTP method of the request. 
 __ow_headers Map string to string The request headers. 
 __ow_path String The unmatched path of the request (matching stops once the action extension is consumed). 
 __ow_user String The namespace_ID that identifies the Cloud Functions-authenticated subject. 
 __ow_body String The request body entity, as a base64 encoded string when content is a binary file, or plain string otherwise. 
 __ow_query String The query parameters from the request as an unparsed string. 



A request cannot override any of the named __ow_ parameters. Doing so, results in a failed request with status equal to 400 Bad Request.
If no cacheKeyQueryRule arguments are supplied, it defaults to "include-all".



* include-all - Includes all query arguments default.
* ignore-all - Ignores 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).



* dynamicContentAcceleration - (Required for Dynamic Content Acceleration only) Provide the DCA parameters. [DCA container](https://cloud.ibm.com/docs/CDN?topic=CDN-dynamic-content-acceleration-container)



* Return - A collection of type SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping.

The collection provides a uniqueId value, which must be sent as input for subsequent API calls related to mapping and origin path.

[Mapping container](https://cloud.ibm.com/docs/CDN?topic=CDN-mapping-container)



--------------------





 deleteDomainMapping 

Deletes the domain mapping based on the uniqueId. The domain mapping must be in one of the following states: RUNNING, STOPPED, DELETED, ERROR, CNAME_CONFIGURATION, or SSL_CONFIGURATION.



* Parameters- uniqueId- (Required) the unique ID of the mapping to be deleted.
* Return- A collection of type SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping.

[Mapping container](https://cloud.ibm.com/docs/CDN?topic=CDN-mapping-container)



--------------------





 verifyDomainMapping 

Verifies the status of the CDN, and updates the status of the CDN mapping if it changed. When a CDN mapping is created initially, its status shows as CNAME_CONFIGURATION. At this point, you must update the DNS record so that the CDN mapping points the hostname to the CNAME.
The value must match regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at (string)
: Optional. Return only managed keys whose creation time matches the parameter. The value must match regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-min (string)
: Optional. Return only managed keys whose creation time is at or after the parameter value. This query parameter cannot be used in conjunction with the created_at query parameter. The value must match regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--created-at-max (string)
: Optional. Return only managed keys whose creation time is at or before the parameter value. This query parameter cannot be used in conjunction with the created_at query parameter. The value must match regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at (string)
: Optional. Return only managed keys whose update time matches the parameter. The value must match regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-min (string)
: Optional. Return only managed keys whose update time is after the parameter value. This query parameter cannot be used in conjunction with the updated_at query parameter. The value must match regular expression /[0-9]{4}-[0-9]{2}-[0-9]{2}/.

--updated-at-max (string)
: Optional. Return only managed keys whose update time is before the parameter value. This query parameter cannot be used in conjunction with the updated_at query parameter.