vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* Example parameters.json file:

{
"url": "www.url.example",
"features": {
"entities": {
"model": "your-model-id-here"
},
"relations": {
"model": "your-model-id-here"
}
}
}
* Example curl request:

curl --user "apikey":"{apikey}" "{url}/v1/analyze?version={date}" --request POST --header "Content-Type: application/json" --data @parameters.json







 Deleting custom entities and relations models 

To delete an entities or relations model from your service instance, use the Delete model method. Replace {url} and {apikey} with your service URL and API key, and replace {model_id} with the model ID of the model you want to delete.



* The following example undeploys an entities or relations model.

curl --user "apikey":"{apikey}" "{url}/v1/models/{model_id}?version={date}"
--request DELETE
{endpoint} virtual host style





 Optional query parameters 



 Name Type Description 

 prefix String Constrains response to object names beginning with prefix. 
 delimiter String Groups objects between the prefix and the delimiter. 
 encoding-type String If unicode characters that are not supported by XML are used in an object name, this parameter can be set to url to properly encode the response. 
 max-keys String Restricts the number of objects to display in the response. Default and maximum is 1,000. 
 marker String Specifies the object from where the listing should begin, in UTF-8 binary order. 



Example request

This request lists the objects inside the "apiary" bucket.

GET /apiary HTTP/1.1
Content-Type: text/plain
Host: s3.us.cloud-object-storage.appdomain.cloud
Authorization: Bearer {token}

Example request

GET /apiary HTTP/1.1
Authorization: 'AWS4-HMAC-SHA256 Credential={access-key}/{date}/{region}/s3/aws4_request,SignedHeaders=host;x-amz-date;,Signature={signature}'
x-amz-date: {timestamp}
Content-Type: text/plain
Host: s3.us.cloud-object-storage.appdomain.cloud

Example response

HTTP/1.1 200 OK
Date: Wed, 24 Aug 2016 17:36:24 GMT
X-Clv-Request-Id: 9f39ff2e-55d1-461b-a6f1-2d0b75138861
Accept-Ranges: bytes
Server: Cleversafe/3.9.0.115
X-Clv-S3-Version: 2.5
x-amz-request-id: 9f39ff2e-55d1-461b-a6f1-2d0b75138861
Content-Type: application/xml
Content-Length: 909
Parameters message DecryptRequest { bytes State = 1; bytes Ciphered = 2; } message DecryptResponse { bytes Plain = 3; } 
 Return values Wraps EP11 error into message Grep11Error. 



Code snippets



* Golang code snippet

DecryptRequest := &pb.DecryptRequest{
State: DecryptInitResponse.State,
Ciphered: ciphertext, // encrypted data from a previous encrypt operation
}

DecryptResponse, err := cryptoClient.Decrypt(context.Background(), DecryptRequest)
* JavaScript code snippet

client.Decrypt({
State: state,
Ciphered: ciphertext
}, (err, response) => {
callback(err, response);
});







 DecryptUpdate 

The DecryptUpdate function continues a multiple-part decryption operation. Before you call this function, make sure to run DecryptInit first.

Enterprise PKCS #11 over gRPC

Enterprise PKCS #11

PKCS #11





 Description Binds to EP11 m_DecryptUpdate, which is an implementation of PKCS #11 C_DecryptUpdate. 
 Parameters message DecryptUpdateRequest { bytes State = 1; bytes Ciphered = 2; } message DecryptUpdateResponse { bytes State = 1; bytes Plain = 3; } 
 Return values Wraps EP11 error into message Grep11Error. 



Code snippets



* Golang code snippet

// Use DecryptUpdate if you would like to breakup
// the decrypt operation into multiple suboperations
DecryptUpdateRequest1 := &pb.DecryptUpdateRequest{
State: DecryptInitResponse.State,
Ciphered: ciphertext[:16], // encrypted data from a previous encrypt operation
}
"ClientRequestProtocol": "string; HTTP protocol of client request",
"ClientRequestReferer": "string; HTTP request referrer",
"ClientRequestURI": "string; URI requested by the client",
"ClientRequestUserAgent": "string; User agent reported by the client",
"ClientSSLCipher": "string; Client SSL cipher",
"ClientSSLProtocol": "string; Client SSL (TLS) protocol",
"ClientSrcPort": "int; client source port",
"EdgeColoID": "int; Cloudflare edge colo id",
"EdgeEndTimestamp": "int or string; unix nanosecond timestamp the edge finished sending response to the client",
"EdgePathingOp": "string; indicates what type of response was issued for this request (unknown = no specific action)",
"EdgePathingSrc": "string; details how the request was classified based on security checks (unknown = no specific classification)",
"EdgePathingStatus": "string; indicates what data was used to determine the handling of this request (unknown = no data)",
"EdgeRateLimitAction": "string; the action taken by the blocking rule; empty if no action taken",
"EdgeRateLimitID": "int; the internal rule ID of the rate-limiting rule that triggered a block (ban) or simulate action. 0 if no action taken",
"EdgeRequestHost": "string; host header on the request from the edge to the origin",
"EdgeResponseBytes": "int; number of bytes returned by the edge to the client",
"EdgeResponseCompressionRatio": "float; edge response compression ratio",
"EdgeResponseContentType": "string; Edge response Content-Type header value",
"EdgeResponseStatus": "int; HTTP status code returned by Cloudflare to the client",
"EdgeServerIP": "string; IP of the edge server making a request to the origin",
7. On the workspace Settings page, in the Input variables section, review the default input variables and provide values that match your solution. Some parameters have default values. Make sure to mark as “sensitive” the parameters that contain sensitive information like API keys. The values that you must specify include:



 Component type Parameter values needed 

 User-specific information <br><br> * API key<br> * SSH key name. For example, "ibmcloud_ssh_key_name1,ibmcloud_ssh_key_name2,..."<br> * Resource Group<br> * IP address. Enter the IP address in the format: "public_ip_address1/32,public_ip_address2/32,...". For example, "103.42.91.78/32"<br> * Your local machine OS<br> * Prefix to add to resource names<br><br><br> 
 Region Regions where resources are deployed 
 OS type for each server <br><br> * Bastion Server<br> * App Server<br> * Web Server<br> * Db Server<br><br><br> 
 Image to use for region VSIs <br><br> * Bastion Server<br> * App Server<br> * Web Server<br> * Db Server<br><br><br> 
 Load Balancer <br><br> * Domain Name<br> * Region Code<br><br><br> 
 Auto scale App VSI parameters <br><br> * Min server<br> * Max servers<br> * CPU threshold<br><br><br> 
 Auto scale web VSI parameters <br><br> * Min server<br> * Max servers<br> * CPU threshold<br><br><br> 
 Anti-Affinity VSI parameters <br><br> * App spread strategy<br> * web spread strategy<br> * Db spread strategy<br><br><br> 



For a more detailed description of each of the parameters, check the GitHub repo readme file.
8. Click Save changes.
9.
MFA message parameters

 Parameter Description 

 %{display.logo} Displays the image that you configured for your Login Widget. 
 %{user.displayName} Displays the screen name a user chose to use when interacting with the app. 
 %{user.email} Displays the user's registered email address. 
 %{user.username} Displays the user's specified username when the authentication method is set to username and password. 
 %{user.firstName} Displays the user's specified given name. 
 %{user.formattedName} Displays the user's full name. 
 %{user.lastName} Displays the user's specified surname. 
 %{mfa.code} Displays a one-time MFA verification code. 



If a user does not supply the information that is pulled by the parameter, it appears blank.







 With the APIs 

Be sure that you have the following prerequisites:



* Your App ID instance's tenant ID. This ID can be found in the Service Credentials section of the dashboard.
* Your Identity and Access Management (IAM) token. For help with obtaining an IAM token, check out the [IAM docs](https://cloud.ibm.com/docs/account?topic=account-iamtoken_from_apikeyiamtoken_from_apikey).



To enable MFA:



1. Enable MFA by making a PUT request to the /config/cloud_directory/mfa endpoint with your MFA configuration to set isActive to true.

curl -X PUT https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/config/cloud_directory/mfa --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer <IAMToken>' -d '"isActive": true'
2. Enable your MFA channel by making a PUT request to the /mfa/channels/<channel> endpoint with your MFA configuration. When isActive is set to true, your MFA channel is enabled.
syntax 

curl -u <ADMIN_MQ_USER>:<ADMIN_API_KEY> -H "Accept: application/json" -H "Content-Type: application/json" -H "ibm-mq-rest-gateway-qmgr: <GATEWAY_QUEUE_MANAGER>" <ADMIN_REST_ENDPOINT>/<REMOTE_QUEUE_MANAGER_NAME>/queue -k

e.g.

curl -u mamgainp:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -H "Accept: application/json" -H "Content-Type: application/json" -H "ibm-mq-rest-gateway-qmgr: QM1" https://web-qm1-b779.qm2.us-preprod.mq.test.appdomain.cloud/ibmmq/rest/v1/admin/qmgr/QM2/queue -k

The above command returns the list of queue running in the remote queue manager.

where



* <ADMIN_MQ_USER> - this is 'mqUsername' in the file platformApiKey.json of your gateway queue manager(i.e. QM1 in our case) .
* <QUEUE_MANAGER_NAME> - this is 'queueManagerName' in the file connection_info.json of your gateway queue manager(i.e. QM1 in our case).
* <ADMIN_API_KEY> = 'apiKey' in the file platformApiKey.json of your gateway queue manager(i.e. QM1 in our case).
* <ADMIN_REST_ENDPOINT> = this is 'adminREST' in the file connection_info.json of your gateway queue manager(i.e. QM1 in our case).

Note - In this case the adminREST property point will be pointing to the gateway queue manager name, replace the gateway queue manager with the remote queue manager name.
: Specifies the format of the command output. Valid options are json, yaml, jsonpath=JSONPATH_EXPRESSION, and jsonpath-as-json=JSONPATH_EXPRESSION. Use jsonpath to specify the path to an element of the JSON output. This value is optional.

--password, -p
: The password that is used to authenticate to the Kafka instance. If you specify the --password option, you must not specify the --secret option. This value is optional.

--path
: The path within the destination application where events are forwarded; for example, /events. The default path is the root URL of the destination application. This option can only be specified if destination-type is app. This value is optional.

--quiet, -q
: Specify this option to reduce the output of the command. This value is optional. The default value is false.

--secret, -s
: The name of the secret that is used to authenticate to the Kafka instance and which includes both username and password keys. If you specify the --secret option, you must not specify the --username or --password options. This value is optional.

--username, -u
: The username that is used to authenticate to the Kafka instance. If you specify the --username option, you must specify the --password option and must not specify the --secret option. This value is optional. The default value is token.

--wait, -w
: Create the Kafka event subscription and wait for the subscription to be ready. If you specify the --wait option, the subscription create waits for a maximum time in seconds, as set by the --wait-timeout option, for the subscription to become ready. If the subscription is not ready within the specified --wait-timeout period, the Kafka event subscription create fails. This value is optional. The default value is true.

--wait-timeout, --wto
This flag is optional.

--feed ACTION_NAME, -f ACTION_NAME
: Sets the type of trigger as a feed. This flag is optional.

--paramKEYVALUE, -pKEYVALUE
: 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 create mytrigger --param name Bob

ibmcloud fn trigger create mytrigger --trigger-param name Bob

Starting in functions plug-in CLI version 1.0.38, two new options are available for the trigger command: --trigger-param and --feed-param. These options are an extension to creating and updating a trigger, making the trigger create and update commands more flexible.

Previously, you created and updated a trigger with a parameter on it with the following command:

ibmcloud fn trigger create triggerHelloWorld --param msg “Hello World!”

This command creates a trigger called triggerHelloWorld with a parameter of KEY msg and VALUE of Hello World!. This is very simple and straightforward. However, it becomes a little complicated when you create a trigger that contains a feed, especially when you want to add parameters on both the trigger and the trigger feed. For example, if you want to create a trigger with alarm feed, then you must run a command similar to the following example:

ibmcloud fn trigger create triggerCron --feed /whisk.system/alarms/alarm --param cron “0,1,2,3,4,5”

In this case, the KEY and VALUE pair that follows --param are consumed by feed and are treated as feed parameters.
For more information, see [Using a custom acoustic model for speech recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acousticUse).



Table 2. The acoustic_customization_id parameter

 Availability and usage Description 

 Previous-generation models Generally available or beta for all models that support acoustic model customization. For more information, see [Customization support for previous-generation models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-supportcustom-language-support-pg). 
 Next-generation models Not available. 
 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 







 audio_metrics 

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



Table 3. The audio_metrics 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 







 background_audio_suppression 

An optional float between 0.0 and 1.0 that indicates the level to which background audio and side conversations are to be suppressed in the input audio. The default is 0.0, which provides no suppression of background audio. For more information, see [Background audio suppression](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detectiondetection-parameters-suppression).



Table 4.
<-- </section "id="section-kp-keys-example-1" "> --><-- <section "id="section-kp-keys-example-2" "> --> Example 2 List all keys and show the cloud resource name (CRN) using the --crn parameter. list all keys and show the cloud resource name (CRN)
$ ibmcloud kp keys -c

Retrieving keys...
OK
Key ID Key Name CRN
5f2cc155-fe16-492c-845c-4d1f0688c7ba my-root-key crn:v1:bluemix:public:kms:us-south:a/ea998d3389c3473aa0987652b46fb146:390086ac-76fa-4094-8cf3-c0829bd69526:key:5f2cc155-fe16-492c-845c-4d1f0688c7ba
c36e9f3a-feaf-4033-8603-687784dc7e51 my-root-key crn:v1:bluemix:public:kms:us-south:a/ea998d3389c3473aa0987652b46fb146:390086ac-76fa-4094-8cf3-c0829bd69526:key:c36e9f3a-feaf-4033-8603-687784dc7e51
<-- </section "id="section-kp-keys-example-2" "> --><-- <section "id="section-kp-keys-example-3" "> --> Example 3 List all keys in JSON format.The --output json parameter implies the --crn (cloud resource name) parameter. list all keys
$ ibmcloud kp keys --output json


{
By default, no custom model is used. For more information, see [Using a custom language model for speech recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageUse).



Table 15. The language_customization_id parameter

 Availability and usage Description 

 Previous-generation models Generally available or beta for all models that support language model customization. For more information, see [Customization support for previous-generation models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-supportcustom-language-support-pg). 
 Next-generation models Generally available or beta for all models that support language model customization. For more information, see [Customization support for next-generation models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-supportcustom-language-support-ng). 
 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 







 low_latency 

An optional boolean that indicates whether the service is to produce results more quickly at the possible expense of transcription accuracy. By default (false), low latency is not enabled. For more information, see [Low latency](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interimlow-latency).



Table 16. The low_latency parameter

 Availability and usage Description 

 Previous-generation models Not available. 
 Next-generation models Generally available or beta for next-generation models that support low latency. For more information, see [Supported next-generation language models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ngmodels-ng-supported). 
 WebSocket Parameter of JSON start message
The aliases current or previous are also allowed.



Table 9. Lock secret request parameters

 Query parameters Description 

 limit The number of locks to retrieve. Default is 25. To retrieve a different set of items, use limit with offset to page through your available resources. 
 offset The number of locks to skip. Default is 0. By specifying offset, you retrieve a subset of locks that starts with the offset value. Use offset with limit to page through your available secrets locks. 
 search Filter locks that contain the specified string in their name. 





 Example request 

List locks for a specific version of an arbitrary secret.

curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/arbitrary/locks/{secret_id}/versions/{version_id}" -H 'Accept: application/json' -H 'X-Vault-Token: {Vault-Token}'

List locks for the current version of a user credentials secret in an existing secret group.

curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}/versions/current" -H 'Accept: application/json' -H 'X-Vault-Token: {Vault-Token}'

Page through available locks by using limit and offset.

curl -X GET "https://{instance_id}.{region}.secrets-manager.appdomain.cloud/v1/ibmcloud/username_password/locks/groups/{group_id}/{secret_id}/versions/current?limit={limit}&offset={offset}" -H 'Accept: application/json' -H 'X-Vault-Token: {Vault-Token}'

Filter for locks that contain book in their names.

curl -X GET "https://{instance_id}.
X-Watson-Assistant-Session-History-Key: dev::latest::212033::0a64c30d-c558-4055-85ad-ef75ad6cc29d::978f1fd7-4e24-47d8-adb0-24a8a6eff69e::b5ffd6c2-902f-4658-b586-e3fc170a6cf3::7ad616a350cc48078f17e3ee3df551de
Contact: sip:a@atlanta.example.com
Content-Length: 0

This example shows the metadata passed into the Refer-To header as query parameters (as defined by [SIP RFC 3261](https://tools.ietf.org/html/rfc3261)).

REFER sip:b@atlanta.example.com SIP/2.0
Via: SIP/2.0/UDP agenta.atlanta.example.com;branch=z9hG4bK2293940223
To: <sip:b@atlanta.example.com>
From: <sip:a@atlanta.example.com>;tag=193402342
Call-ID: 898234234@agenta.atlanta.example.com
CSeq: 23 REFER
Max-Forwards: 70
Refer-To: sip:user@domain.com?User-to-User=dev::latest::893499::dff9c274-adc4-4f63-93de-781166760bf8::978f1fd7-4e24-47d8-adb0-24a8a6eff69e::b5ffd6c2-902f-4658-b586-e3fc170a6cf3::7ad616a350cc48078f17e3ee3df551de%3Bencoding%3Dascii
Contact: sip:a@atlanta.example.com
Content-Length: 0
If the pagination implementation makes paging in reverse expensive or impractical, the previous link MAY be omitted.

The last link SHOULD be included for all pages (including the first and last pages). If it is expensive or impractical to provide a last page link, the last link MAY be omitted.

When any of the above fields are omitted, they should be absent from the response entirely and not included with null values. A request made to a next or previous URL MUST NOT affect the response of a subsequent request to the same URL.





 Token-based pagination 

Collections SHOULD implement token-based pagination wherever practical, but MAY implement offset and limit pagination when deemed necessary for collection use-cases.

Token-based pagination MUST support a page token query parameter, which SHOULD be named start but MAY be named token, for accepting a page token that specifies the resource to start the page on or after. The collection MAY also support the limit query parameter.

Page tokens MUST be string values and SHOULD be presented as opaque values. If it is impractical for page tokens to be opaque, clients SHOULD still be discouraged from generating their own tokens. Page tokens MUST have an enforced maximum length and that length SHOULD be documented and SHOULD be no more than 512 characters.

A request made using a page token from next, previous, or last MUST NOT affect the response of a subsequent request using the same page token.

If a page token is passed in the page token query parameter of a request, the service MUST fail the request if any other parameters of the request are not consistent with the page token.

Token-based pagination can be implemented in a number of ways (including keyset pagination or cursor-based pagination). However, any implementation of token-based pagination SHOULD attempt to ensure that resources are not duplicated or omitted

[3]if all pages in a collection are requested in sequence.



 Page token query parameter 

The page token query parameter, which SHOULD be named start but MAY be named token, MUST be used to determine what resource to start the page on or after. If the page token query parameter is unspecified, the logical first page of results MUST be returned.