vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* Action: Update existing Subscription.

ibmcloud event-notifications subscription update --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES] [--instance-id INSTANCE-ID]
* Parameters to provide:

--id ID (string)
: Unique identifier for subscription. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

[--name NAME] (string)
: The updated description to be set for subscription.

The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9-:_]/.

[--instance-id INSTANCE-ID] (string)
: The Unique identifier for IBM Cloud Event Notifications instance.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--description DESCRIPTION] (string)
: The updated description to be set for subscription.

The default value is ``. The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9-:_]/.
<br> <br>For more information, see [Retrieving an instance ID](https://cloud.ibm.com/docs/key-protect?topic=key-protect-retrieve-instance-ID). 
 key_ring_ID Optional. The unique identifier of the key ring that the key is a part of. If unspecified, Key Protect will search for the key in every key ring associated with the specified instance. It is recommended to specify the key ring ID for a more optimized request. <br> <br>Note: The key ring ID of keys that are created without an x-kms-key-ring header is: default. <br>For more information, see [Grouping keys](https://cloud.ibm.com/docs/key-protect?topic=key-protect-grouping-keys). 
 correlation_ID Optional.The unique identifier that is used to track and correlate transactions. 
 key_ID_or_alias Required. The identifier or alias for the key that you want to retrieve. 



A successful GET api/v2/keys/<key_ID_or_alias> response returns details about your key and the key material. The following JSON object shows an example returned value for a standard key.

{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"id": "02fd6835-6001-4482-a892-13bd2085f75d",
"name": "test-standard-key",
"aliases":
"alias-1",
"alias-2"
],
"state": 1,
"expirationDate": "2020-03-15T03:50:12Z",
"extractable": true,
"id": "'$image_id'"
}
}'
Show more
* Create an instance using a private catalog image from the latest version of a catalog product offering.

curl -X POST "$vpc_api_endpoint/v1/instances?version=$api_version&generation=2" -H "Authorization:$iam_token" -d '{
"name": "my-instance",
"zone": {
"name": "us-south-3"
},
"vpc": {
"id": "'$vpc'"
},
"primary_network_interface": {
"subnet": {
"id": "'$subnet'"
}
},
"keys":[{"id": "'$key'"}],
"profile": {
"name": "'$profile_name'"
},
"catalog_offering": {
"offering": {
"crn": "'$offering_crn'"
}
}'
Show more
* Create an instance using a private catalog image from a specific version of a catalog product offering.

curl -X POST "$vpc_api_endpoint/v1/instances?version=$api_version&generation=2" -H "Authorization:$iam_token" -d '{
"name": "my-instance",
"zone": {
"name": "us-south-3"
},
"vpc": {
"id": "'$vpc'"
},
"primary_network_interface": {
"subnet": {
"id": "'$subnet'"
}
},
"keys":[{"id": "'$key'"}],
"profile": {
"name": "'$profile_name'"
},
"catalog_offering": {
"version": {
However, a different document ID was assigned to it and stored in the parent_document_id field. The assigned document ID is what was returned when you called the List documents method and is what had to be used as the document_id in the endpoint URL for a Delete document method request. When you used the Update document method to assign a new document_id, the original ID continued to be returned in query results. However, the assigned ID had to be used to delete the document. If you have an application that relies on the previous behavior, you can specify a version number earlier than 2023-03-31, such as 2020-08-30, in your API calls.



Notes about enhancing data:



* You cannot apply prebuilt or user-trained Smart Document Understanding models to JSON files.
* When you apply an enrichment to a field from the JSON file, the field data type is converted to an array. The field is converted to an array even if it contains a single value. For example, "field1": "Discovery" becomes "field1": ["Discovery"].
* Only the first 50,000 characters of a custom field from a JSON file are enriched.
* In project types where the Part of Speech (POS) enrichment is applied automatically, the enrichment is applied to the field that contains the bulk of the file content in the first JSON file that is added to the collection. This field is determined by the following rules:



* If a field is named text, the POS enrichment is applied to it.
* The field with the longest string value and highest number of distinct values is chosen.
* If more than one field meets the previous condition, one of the fields is chosen at random.



* If you want to apply an enrichment to a nested field, you must create a Content Mining project, and then apply the enrichment to the field. If you want to use a project type other than Content Mining, you can reuse the collection that you created with the Content Mining project type elsewhere.
* uniqueId - Provide a unique ID of the mapping that the rule to be deleted belongs to.



* Returns - An object of type SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking.

[Geo-blocking class](https://cloud.ibm.com/docs/CDN?topic=CDN-geoblocking-class)



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





 getGeoblocking 

Retrieves a mapping's Geographical Access Control behavior.



* Parameters:



* uniqueId - The unique ID of the mapping that the rule belongs to.



* Returns - An object of type SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking.

[Geo-blocking class](https://cloud.ibm.com/docs/CDN?topic=CDN-geoblocking-class)



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





 getGeoblockingAllowedTypesAndRegions 

Returns a list of the types and regions that are allowed for creating Geographical Access Control rules.



* Parameters: * uniqueId: The unique ID of your domain mapping.
* Returns: An object of type SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type.

[Geo-blocking class](https://cloud.ibm.com/docs/CDN?topic=CDN-geoblocking-class)



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







 API for Hotlink Protection 



 createHotlinkProtection 

Creates a new Hotlink Protection, and returns the newly created behavior.



* Parameters: A collection of type SoftLayer_Container_Network_CdnMarketplace_Configuration_Input. You can view all of the attributes in the Input container here:

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

The following attributes are part of the Input container and are required when creating a new Hotlink Protection:
* [Configuring a project to use a custom service ID](https://cloud.ibm.com/docs/codeengine?topic=codeengine-configure-bindaccessbind-custom-servid-project)



* [Next steps](https://cloud.ibm.com/docs/codeengine?topic=codeengine-configure-bindaccessservice-bindings-access-nextsteps)



[Binding a service instance to an app, job, or function workload](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-services)



* [Binding a service instance to a Code Engine app or job from the console](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-ui)



* [Binding a service instance with a new service access secret (with a Code Engine autogenerated credential)](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-credential-ui-newsecret-autocred)
* [Binding a service instance with a new service access secret (with an existing credential)](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-credential-ui-newsecret-existingcred)
* [Binding a service instance with an existing service access secret](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-credential-ui-existingsecret)



* [Binding a service instance to a Code Engine app, job, or function with the CLI](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-cli)



* [Binding a service instance with a new credential](https://cloud.ibm.com/docs/codeengine?topic=codeengine-bind-servicesbind-credentials)
"BroadcastTraceDir": null,
"DeliverTraceDir": null
},
"Metrics": {
"Provider": "disabled",
"Statsd": {
"Network": "udp",
"Address": "127.0.0.1:8125",
"WriteInterval": "30s",
"Prefix": null
}
}
}
Show more





 Providing your own customizations when you create an ordering service 

After you click Add ordering service on the nodes tab and step through the ordering service configuration panels, you can click Edit configuration JSON on the Summary panel to view and edit the JSON. Note that if you do not select any advanced options in the console, then the generated JSON is empty, but you can insert your own customizations.

Alternatively, if you do check any of the advanced options when you configure the ordering service, those settings are included in the JSON on the Summary panel. Any edits that you make to theJSON override what was specified in the console. You can insert additional fields or modify the generated JSON. The overrides that are visible in the JSON on the Summary page are what is used to override the default settings when the ordering node is deployed. If you are deploying multiple ordering nodes, then the overrides are applied to each ordering node.

You don't need to include the entire set of available parameters in the JSON, only any advanced deployment options that you selected in the console along with the parameters that you want to override. For example, if did not select any advanced options in the console and you want to deploy the ordering nodes with your own value for the ServerTimeout and the statsd address port, you would paste the following JSON into the Configuration JSON box:

{
"General": {
"Keepalive": {
"ServerTimeout": "60s"
}
},
"metrics": {
"statsd": {
"address": "127.0.0.1:9446"
}
}
}





 Modifying ordering node settings after deployment
Managing custom prompts 

The Tune by Example feature is beta functionality that is supported only for US English custom models and voices.

Tune by Example includes methods for listing all custom prompts for a custom model, for getting information about an individual prompt, and for deleting a prompt. These methods are in addition to the POST /v1/customizations/{customization_id}/prompts/{prompt_id} method for adding a prompt to a custom model; for more information, see [Add a custom prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-createtbe-create-add-prompt).



 Listing custom prompts 

Tune be Example provides two methods for listing information about the custom prompts for a specified custom model:



* The GET /v1/customizations/{customization_id}/prompts method lists information about all custom prompts that are defined for a custom model.
* The GET /v1/customizations/{customization_id}/prompts/{prompt_id} method lists information about a specific custom prompt from a custom model. Use this method to poll the service about the status of a request to add a prompt to a custom model.



The first method returns a prompts array that lists all of the prompts for a custom model. For each prompt that is listed in the array, the service provides the same information as it does for an individual prompt:



* prompt is the user-specified text of the prompt that was provided when the prompt was created.
* prompt_id is the user-specified identifier of the prompt that was provided at the prompt's creation. The prompt ID is used to identify the prompt in requests to the service, including in the SSML of speech synthesis requests.
* status is the current status of the prompt:



* processing indicates that the service received the request to add the prompt and is processing the prompt. This is the initial status of all prompts.
* available indicates that the service successfully validated the prompt. The prompt is now ready for use in a speech synthesis request.
* failed indicates that the service's validation of the prompt failed.
Key ID A unique key ID that was assigned to your key by the Key Protect service. You can use the ID value to make calls to the service with the [Key Protect API](https://cloud.ibm.com/apidocs/key-protect). 
 Key ring ID The [key ring](https://cloud.ibm.com/docs/key-protect?topic=key-protect-grouping-keys) the keys are associated with. These states include Deactivated, Destroyed, Disabled, and Enabled. 
 Last rotated The date the last time the key was rotated. 
 Key alias The [key alias](https://cloud.ibm.com/docs/key-protect?topic=key-protect-create-key-alias) (or aliases) of the key. 
 Type The [key type](https://cloud.ibm.com/docs/key-protect?topic=key-protect-envelope-encryptionkey-types) of the key (either a Root key or a Standard key). 
 State The [key state](https://cloud.ibm.com/docs/key-protect?topic=key-protect-key-states) of the key, one of Deactivated, Destroyed, Disabled, or Enabled. 



Other available fields in the table include:



* Last modified: indicating the last time the key was changed in any way.
* Created: the date the key was created.
* Deleted: showing whether a key is in a deleted state (awaiting purge) or not.
* Imported: indicating whether the key was created using key material supplied by the user.
* Rotation policy: showing whether this key has a rotation policy attached to it.
* Associated resources: shows whether the key is protecting any resources.



The search capability is limited to a volume of 5,000 keys. If you have more than 5,000 keys, and you cannot filter the number of keys that will be searched to less than 5,000 (for example, by filtering by key state to only look for Enabled keys), your search will fail unless it exactly matches a key ID or alias.
"id" : "cfbf9050-ab8e-ac97-b01b-ab5af830be8a",
"crn" : "crn:v1:staging:public:project:us-south:a/06580c923e40314421d3b6cb40c01c68:cfbf9050-ab8e-ac97-b01b-ab5af830be8a::",
"created_at" : "2023-02-22T19:51:23.253Z",
"definition" : {
"description" : "a project example",
"name" : "iaas-infra-prestage-env",
"destroy_on_delete" : false
},
"location" : "us-south",
"resource_group" : "Default",
"state" : "READY",
"cumulative_needs_attention_view" : {
"event" : "project.instance.update"
}, {
"event_id" : "489f0090-6d7c-4af5-8f20-9106543e4974"
}, {
"config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
}, {
"config_version" : 1
} ]
}, {
"id" : "1123ed42-4356-efa1-1101-235900fe9087",
"created_at" : "2023-02-22T19:51:23.253Z",
"definition" : {
"description" : "a project example",
"name" : "iaas-infra-stage-env",
"destroy_on_delete" : false
},
curl -X POST --header "Authorization: Bearer {token}" --header "Content-Type: audio/flac" --data-binary @audio-file.flac "{url}/v1/recognize?model=en-US_Telephony&language_customization_id={customization_id}"
* For the [asynchronous HTTP interface](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async), use the POST /v1/recognitions method. The specified custom model is used for that request.

IBM Cloud

curl -X POST -u "apikey:{apikey}" --header "Content-Type: audio/flac" --data-binary @audio-file.flac "{url}/v1/recognitions?model=en-US_Telephony&language_customization_id={customization_id}"

IBM Cloud Pak for Data

curl -X POST --header "Authorization: Bearer {token}" --header "Content-Type: audio/flac" --data-binary @audio-file.flac "{url}/v1/recognitions?model=en-US_Telephony&language_customization_id={customization_id}"







 Using customization weight 

A custom language model is a combination of the custom model and the base model that it customizes. You can tell the service how much weight to give to words from the custom language model compared to words from the base model for speech recognition. The weight that is assigned to a custom model is referred to as its customization weight.

You specify the relative weight for a custom language model as a double between 0.0 to 1.0:



* For custom models that are based on previous-generation models, the default customization weight is 0.3.
* For custom models that are based on most next-generation models, the default customization weight is 0.2.
* For custom models that are based on improved next-generation models, the default customization weight is 0.1.
month String Indicates the month that the user selects to view usage data. Included always in the event 
 enterprise_id String Indicates the ID of the enterprise. Included always in the event 
 account_id String Indicates the the sub-account IDs that is requested in the report. Optional 
 account_group_id String Indicates the account group when a user selects one. Optional <br>Included if the user filters data by selecting 1 account group. 









 Account IAM settings events (Deprecated) 

This section explains events that are generated when you configure the IAM account settings from the Access (IAM) > Settings dashboard.



 Configuring MFA 

When you set on MFA in your account by configuring the Account Login section in the Access (IAM) > Settings dashboard, you get 2 events:



* Event with action billing.account-traits.update that reports the type of MFA that is configured in the account in the requestData.mfa field.
* Event with action billing.account-mfa.set-on that indicates that MFA is enabled in the account.



When you set off MFA, you get the following 2 events:



* Event with action billing.account-traits.update that reports the type of MFA that is configured in the account in the requestData.mfa field.
* Event with action billing.account-mfa.set-off that indicates that MFA is disabled in the account.



For example, see the requestData field for the event billing.account-traits.update:

"action": "billing.account-traits.update",
"message": "Billing service: update account traits",
"requestData": {
"mfa": "",
"origin": "BSS"
}





 Configuring user list visibility restriction 

When you modify the User list visibility restriction IAM account setting in the Manage > Access (IAM) > Settings dashboard, you get 1 event with action billing.account-traits.update.

For example, see the requestData field for the event billing.account-traits.update:

"action": "billing.account-traits.update",
"message": "Billing service: update account traits",
"config_id" : "069ab83e-5016-4bf2-bd50-cc95cf678293"
}, {
"config_version" : 1
} ] ! ! ! ! ,
"definition" : {
"name" : "acme-microservice",
"description" : "A microservice to deploy on top of ACME infrastructure.",
"destroy_on_delete" : true
},
"event_notifications_crn" : "crn:v1:staging:public:event-notifications:us-south:a/06580c923e40314421d3b6cb40c01c68:instance-id::",
"location" : "us-south",
"resource_group" : "Default",
"state" : "READY"
}
<-- </section "id="section-project-get-cli-output" "> --><-- </section "id="section-project-cli-get-command" "> --><-- <section "id="section-project-cli-delete-command" "> --> ibmcloud project delete Delete a project document by the ID. A project can only be deleted after deleting all of its artifacts. ibmcloud project delete --id ID
<-- <section "id="section-project-delete-cli-options" "> --> Command options --id (string): The unique project ID. Required.
The maximum length is 128 characters. The value must match regular expression /^\.\-0-9a-zA-Z] ! ! ! ! ! +$/.
The value must match regular expression /^\.\-0-9a-zA-Z] +$/.
--config-id (string): The unique configuration ID. Required.
The maximum length is 128 characters. The value must match regular expression /^\.\-0-9a-zA-Z] ! ! ! ! +$/.
--version (int64): The configuration version. Required.<-- </section "id="section-project-config-draft-get-cli-options" "> --><-- <section "id="section-project-config-draft-get-examples" "> --> Example ibmcloud project config-draft-get --project-id=exampleString --config-id=exampleString --version=38
<-- </section "id="section-project-config-draft-get-examples" "> --><-- <section "id="section-project-config-draft-get-cli-output" "> --> Example output Sample response for a project configuration draft. {
"id" : "293c3c36-a094-4115-a12b-de0a9ca39be5",
"definition" : {
"name" : "env-stage",
"description" : "Stage environment configuration, which includes services common to all the environment regions. There must be a blueprint configuring all the services common to the stage regions. It is a terraform_template type of configuration that points to a GitHub repo hosting the Terraform modules that can be deployed by a Schematics workspace.",
"labels" : "env:stage", "governance:test", "build:0" ],
Otherwise, only the ID and name of each template is shown.







 ibmcloud catalog template 

View the detailed information of a specified boilerplate template.

ibmcloud catalog template TEMPLATE_ID



 Command options 

TEMPLATE_ID (required)
: The ID of the boilerplate template. Use ibmcloud templates to view all templates' IDs.





 Examples 

View details of the template mobileBackendStarter:

ibmcloud catalog template mobileBackendStarter







 ibmcloud catalog locations 

Get a choice subset of regions in your choice of format.

ibmcloud catalog locations [-i, --id ID] [-k, --kind KIND] [--col COLUMNS] [--global] [--csv]



 Command options 

-i, --id
: Specify geography by id.

-k, --kind
: Get a list of entries for the specified kind.

--col
: Specify more columns for the table. Currently, "group", "provider", and "tags".

--global
: Operate in a global scope.

--csv
: Output CSV file







 ibmcloud catalog runtime 

View the details of a runtime. This command is only available for public cloud.

ibmcloud catalog runtime RUNTIME_ID



 Examples 

Show details of runtime "nodejsHelloWorld":

ibmcloud catalog runtime nodejsHelloWorld







 ibmcloud catalog runtimes 

List all runtimes. This command is only available for public cloud.

ibmcloud catalog runtimes [-d]



 Command options 

-d
: Show the description of each runtime





 Examples 

List all runtimes along with their descriptions:

ibmcloud catalog runtimes -d