vania-janet/multiturn-rag-retrieval-data huggingface dataset:
: Specifies the format of the command output. Valid values 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
Message: The value must match one of the subschemas.

Make sure your request conforms to the [API documentation](https://cloud.ibm.com/apidocs/vpc-on-classic).





 validation_discriminator_forbidden 

Message: The discriminator field forbids this substructure.

For example, if you specify

{
protocol: icmp
port_min: 5
port_max: 100
}

The protocol is icmp, and port_min is a tcp field, so you'll get an error.



1. validation_discriminator_required for missing icmp rules
2. validation_discriminator_forbidden for tcp fields with icmp specified



Make sure your request conforms to the [API documentation](https://cloud.ibm.com/apidocs/vpc-on-classic). If this problem persists, [contact support](https://cloud.ibm.com/docs/vpc-on-classic?topic=vpc-on-classic-getting-help-and-support).





 validation_internal_error 

Message: None

Make sure your request conforms to the [API documentation](https://cloud.ibm.com/apidocs/vpc-on-classic). If this problem persists, [contact support](https://cloud.ibm.com/docs/vpc-on-classic?topic=vpc-on-classic-getting-help-and-support).





 validation_invalid_name 

Message: The value is not a valid name.

Make sure your request conforms to the [API documentation](https://cloud.ibm.com/apidocs/vpc-on-classic). If this problem persists, [contact support](https://cloud.ibm.com/docs/vpc-on-classic?topic=vpc-on-classic-getting-help-and-support).





 validation_invalid_ref 

Message: The value is not a valid HREF.
Add any data that you want to pass to the external application as key and value pairs in the Parameters section.

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_webprotected-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 saved automatically.
props.put("security.protocol", "SASL_SSL");
props.put("sasl.mechanism", "PLAIN");
props.put("ssl.protocol", "TLSv1.2");
props.put("ssl.enabled.protocols", "TLSv1.2");
props.put("ssl.endpoint.identification.algorithm", "HTTPS");

To consume messages, you also need to specify deserializers for the keys and values, as in the following example.

props.put("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
props.put("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");

Then, use a KafkaConsumer to consume messages, where each message is represented by a ConsumerRecord. The most common way to consume messages is to put the consumer in a consumer group by setting the group ID, and then call subscribe() for a list of topics. The consumer is assigned some partitions to consume, although if more consumers exist in the group than partitions in the topic, the consumer might not be assigned any partitions. Next, call poll() in a loop, receiving a batch of messages to process, where each message is represented by a ConsumerRecord.

props.put("group.id", "G1");
Consumer<String, String> consumer = new KafkaConsumer<>(props);
consumer.subscribe(Arrays.asList("T1"));
while (true) {
ConsumerRecords<String, String> records = consumer.poll(100);
for (ConsumerRecord<String, String> record : records)
System.out.printf("offset = %d, key = %s, value = %s%n", record.offset(), record.key(), record.value());
}
* Optional: Specifies CACHING_DIRECTIVES for the request and reply chain.



* Flag: --cache-control CACHING_DIRECTIVES



* Optional: Specifies presentation information (DIRECTIVES).



* Flag: --content-disposition DIRECTIVES



* Optional: Specifies the content encoding (CONTENT_ENCODING) of the object..



* Flag: --content-encoding CONTENT_ENCODING



* Optional: The LANGUAGE the content is in.



* Flag: --content-language LANGUAGE



* Optional: A standard MIME type describing the format of the object data.



* Flag: --content-type MIME



* Optional: A MAP of metadata to store.



* Flag: --metadata MAP JSON Syntax: The --metadata flag takes the file:// prefix that is used to load the JSON structure from the specified file.





{
"file_name": "file_20xxxxxxxxxxxx45.zip",
"label": "texas",
"state": "Texas",
"Date_to": "2019-11-09T16:00:00.000Z",
"Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
"Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
}



* 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











 Delete an existing bucket 



* Action: Delete an existing bucket in an IBM Cloud Object Storage instance.
* Usage:ibmcloud cos bucket-delete --bucket BUCKET_NAME [--region REGION] [--force] [--output FORMAT]
* Parameters to provide:



* The name of the bucket.



* Flag: --bucket BUCKET_NAME



* Optional: The REGION where the bucket is present.
ibmcloud watson-query virtualized-table-publish --catalog-id 12c60f7e-c366-4cda-ba3a-bfbb577a5f56 --allow-duplicates true --virtualized-schema DV_IBMID_6610020D12 --virtualized-table EMPLOYEE









 Schema examples 

The following schema examples represent the data that you need to specify for a command option. These examples model the data structure and include placeholder values for the expected value type. When you run a command, replace these values with the values that apply to your environment as appropriate.



 CatalogPublishParametersAssetsItem[] 

The following example shows the format of the CatalogPublishParametersAssetsItem[] object.

[ {
"schema" : "db2inst1",
"table" : "EMPLOYEE"
} ]





 PostDatasourceConnectionParametersProperties 

The following example shows the format of the PostDatasourceConnectionParametersProperties object.

{
"access_token" : "exampleString",
"account_name" : "exampleString",
"api_key" : "exampleString",
"auth_type" : "exampleString",
"client_id" : "exampleString",
"client_secret" : "exampleString",
"collection" : "exampleString",
"credentials" : "exampleString",
"database" : "TPCDS",
"host" : "192.168.0.1",
"http_path" : "exampleString",
"jar_uris" : "exampleString",
"jdbc_driver" : "exampleString",
"jdbc_url" : "exampleString",
"password" : "password",
"port" : "50000",
"project_id" : "exampleString",
"properties" : "exampleString",
"errorMsg": "Unauthorized: The user does not have access to the specified resource"
}
]
}









 Sorted by HTTP status code order 

These are the error messages, sorted the the HTTP status code.



 HTTP 400 - Bad Request 



* Collection total does not match number of resources - [details](https://cloud.ibm.com/docs/key-protect?topic=key-protect-error-messageserror-messages-collection-total-mismatch-err)
* Data in body does not match data required by query parameter - [details](https://cloud.ibm.com/docs/key-protect?topic=key-protect-error-messageserror-messages-body-query-param-mismatch-err)
* Extracting the subject from the bearer token failed: Make sure the bearer token passed is the correct one (and correct format) and is allowed to perform requested actions - [details](https://cloud.ibm.com/docs/key-protect?topic=key-protect-error-messageserror-messages-bearer-sub-extraction-err)
* Invalid body data was passed: Please ensure the data passed had valid formatting with no invalid characters - [details](https://cloud.ibm.com/docs/key-protect?topic=key-protect-error-messageserror-messages-bad-body-err)
* Invalid field error: for wrap The field 'plaintext' must be: a base64 encoded key material if invalid plaintext is passed in the request; and The field 'ciphertext' must be: the original base64 encoded ciphertext from the wrap operation for unwrap if invalid ciphertext is passed. - [details](https://cloud.ibm.com/docs/key-protect?topic=key-protect-error-messageserror-messages-invalid-field-err)
* Key restoration has expired - [details](https://cloud.ibm.com/docs/key-protect?topic=key-protect-error-messageserror-messages-key-restore-expired)
: 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.

--topic, -t
: Set a topic in the Kafka source. Topics are used to filter messages to consume. This option can be specified multiple times. 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.





 Example 

The following example updates a Kafka event subscription to use kafka-topic2 instead of kafka-topic1.

ibmcloud ce subscription kafka update --name mykafkasubscription --topic kafka-topic2





 Example output 

Updating Kafka event subscription 'mykafkasubscription'...
Run 'ibmcloud ce subscription kafka get -n mykafkasubscription' to check the Kafka event subscription status.
OK









 Version command 

Display the version of the code-engine command-line interface.



 ibmcloud ce version 

Display the version of the code-engine command-line interface.

ibmcloud ce version [--quiet]



 Command Options 

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





 Example 

ibmcloud ce version





 Example output 

version: v1.17.0
commit: 3ab130b746f4784c9ff8d3da7bb05b6e7acda6d5
--assets ([CatalogPublishParametersAssetsItem[]](https://cloud.ibm.com/docs/watson-query-cli-plugin?topic=watson-query-cli-plugin-CLI-namecli-catalog-publish-parameters-assets-item-example-schema))
: Asset description. Example: "[{"schema": "db2inst1","table": "employee"}]". Required.





 Examples 

Publish virtualized tables to WKC

ibmcloud watson-query virtualized-table-publish --catalog-id 12c60f7e-c366-4cda-ba3a-bfbb577a5f56 --allow-duplicates true --virtualized-schema DV_IBMID_6610020D12 --virtualized-table EMPLOYEE









 Schema examples 

The following schema examples represent the data that you need to specify for a command option. These examples model the data structure and include placeholder values for the expected value type. When you run a command, replace these values with the values that apply to your environment as appropriate.



 CatalogPublishParametersAssetsItem[] 

The following example shows the format of the CatalogPublishParametersAssetsItem[] object.

[ {
"schema" : "db2inst1",
"table" : "EMPLOYEE"
} ]





 PostDatasourceConnectionParametersProperties 

The following example shows the format of the PostDatasourceConnectionParametersProperties object.

{
"access_token" : "exampleString",
"account_name" : "exampleString",
"api_key" : "exampleString",
"auth_type" : "exampleString",
"client_id" : "exampleString",
"client_secret" : "exampleString",
"collection" : "exampleString",
"credentials" : "exampleString",
default_routing_table_name argument for [ibm_is_vpc](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/is_vpcargument-reference) resources<br> * Support quote_id argument for [ibm_compute_vm_instance](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/compute_vm_instanceargument-reference) resources<br> * Support serve_stale_content argument for [ibm_cis_cache_settings](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/cis_cache_settingsargument-reference) resources<br> * Support alias, key_ring_id argument for [ibm_kms_key](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/kms_keyargument-reference) resources and aliases attribute for [ibm_kms_key](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/kms_keyattribute-reference)
"emails": "myemail@ibm.com"],
"triggerlimit": 15,
"triggerinterval": "5m",
"immediate": true,
"terminal": true,
"operator": "presence",
"timezone": "Europe/London"
}
]
}'
Show more





 Modifying a view by adding an alert 

The following modifies a view by adding an alert.

curl --request PUT 
--url https://api.us-south.logging.cloud.ibm.com/v1/config/view/<VIEWID> 
--header 'Content-Type: application/json' 
-H 'servicekey: <SERVICE_KEY>' 
-d '{
"name": "My RC 200",
"query": "reasonCode:200",
"hosts": ["myHostName"],
"category": ["<CATEGORY"],
"channels": [
{
"integration": "email",
"emails": "myemail@ibm.com"],
"triggerlimit": 15,
"triggerinterval": "5m",
"immediate": true,
"terminal": true,
"operator": "presence",
"timezone": "Europe/London"
}
]
}'
Show more





 Deleting a view 

The following sample deletes a view.

curl --request DELETE 
--url https://api.us-south.logging.cloud.ibm.com/v1/config/view/<VIEWID> 
-H 'content-type: application/json' 
-H 'servicekey: <SERVICE_KEY>'
Service key crn:v1:bluemix:public:messagehub:us-south:a/e43abfcbd191404cb17ef650e9681dd3:c0736069-3f4a-438a-b614-6846877d692d:resource-key:4c8edfdb-abcd-abcd-abcd-abcdabcdabcd was created.

Name: myeventstream-key
ID: crn:v1:bluemix:public:messagehub:us-south:a/e43abfcbd191404cb17ef650e9681dd3:c0736069-3f4a-438a-b614-6846877d692d:resource-key:4c8edfdb-abcd-abcd-abcd-abcdabcdabcd
Created At: Mon Mar 21 18:36:09 UTC 2022
State: active
Credentials:
api_key: abcdeH9tu3qE5Sn8VbJfcDEWtjR_l0iPisB3abcdefgh
apikey: abcdeH9tu3qE5Sn8VbJfcDEWtjR_l0iPisB3abcdefgh
iam_apikey_description: Auto-generated for key crn:v1:bluemix:public:messagehub:us-south:a/e43abfcbd191404cb17ef650e9681dd3:c0736069-3f4a-438a-b614-6846877d692d:resource-key:4c8edfdb-abcd-abcd-abcd-abcdabcdabcd
iam_apikey_name: myeventstream-key
iam_role_crn: crn:v1:bluemix:public:iam::::serviceRole:Manager
"exchange": "mailserver.example.com",
"preference": 10
}
}'





 Response 

{
"created_on": "2019-08-16 08:21:20.308716 +0000 UTC",
"modified_on": "2019-08-16 08:21:20.308716 +0000 UTC",
"rtype": "MX",
"ttl": 60,
"name": "mx1.example.com",
"id": "MX:8e1b201e-00dd-46a0-a3ec-46573f908870",
"rdata": {
"preference": 10,
"exchange": "mailserver.example.com"
}
}







 Creating type 'PTR' resource record 



 Request 

curl -X POST $DNSSVCS_ENDPOINT/v1/instances/$INSTANCE_ID/dnszones/$DNSZONE_ID/resource_records -H "Authorization: $TOKEN" -d '{
"type": "PTR",
"name": "192.168.10.100",
"rdata": {
"ptrdname": "www1.example.com"
}
}'





 Response 

{
"created_on": "2019-08-30 06:48:16.971764628 +0000 UTC",
"modified_on": "2019-08-30 06:48:16.971764628 +0000 UTC",
"rtype": "PTR",
"ttl": 60,
"name": "100.10.168.192.in-addr.arpa",
"id": "PTR:a47dd63a-e65a-4280-8f53-3cdb433cc78a",
"rdata": {
"ptrdname": "www1.example.com"
}
}
This flag is optional.

--summary
: Get a summary of the action details. Parameters with the prefix "*" are bound; parameters with the prefix "**" are bound and finalized. This flag is optional.

--url
: Get the URL only for the action. This flag is optional.





 Example 

ibmcloud fn action get hello

Output

ok: got action hello
{
"namespace": "<namespace_ID>",
"name": "hello",
"version": "0.0.1",
"exec": {
"kind": "nodejs:10",
"binary": false
},
"annotations": [
{
"KEY": "exec",
"VALUE": "nodejs:10"
}
],
"LIMIT s": {
"timeout": 60000,
"memory": 256,
"logs": 10
},
"publish": false
}







 ibmcloud fn action invoke 

Run an action to test it.

ibmcloud fn action invoke ACTION_NAME [--blocking] [--param KEY VALUE] [--param-file FILE] [--result]



 Command options 

ACTION_NAME
: The name of the action. This value is required.

--blocking, -b
: Blocking invocations use a request and response style to wait for the activation result to be available. The wait period is the lesser of 60 seconds or the action's [time LIMITVALUE](https://cloud.ibm.com/docs/openwhisk?topic=openwhisk-limits). 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.
For more information, see [End a recognition request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-websocketsws-stop).



content-type (optional string)
: Identifies the format (MIME type) of the audio data for the request. The parameter is required for the audio/alaw, audio/basic, audio/l16, and audio/mulaw formats. For more information, see [Audio formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formatsaudio-formats-list).

The message can also include optional parameters to specify other aspects of how the request is to be processed and the information that is to be returned. These additional parameters include the interim_results parameter, which is available only with the WebSocket interface.



* For more information about all speech recognition features, see the [Parameter summary](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-summary).
* For more information about the interim_results parameter, see [Interim results](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interiminterim-results).



The following snippet of JavaScript code sends initialization parameters for the recognition request over the WebSocket connection. The calls are included in the client's onOpen function to ensure that they are sent only after the connection is established.

function onOpen(evt) {
var message = {
action: 'start',
content-type: 'audio/l16;rate=22050'
};
websocket.send(JSON.stringify(message));
}

If it receives the request successfully, the service returns the following text message to indicate that it is listening. The listening state indicates that the service instance is configured (the JSON start message was valid) and is ready to accept audio for a recognition request.

{'state': 'listening'}
The following table lists requestData fields that you can find in events that are generated when user details are modified from the Users dashboard:



Table 15. User management requestData fields

 Field Type Description 

 2FA Boolean Defines the MFA requirements for users in the account. <br>This field is set to true when MFA is enabled for users. 
 allowed_ip_addresses String List of IP addresses from where a user is allowed to access account resources. 
 ips_added String The new IP adresses that are added to the allowed_ip_addresses. 
 ips_removed String The IP adresses that are removed from the allowed_ip_addresses. 
 iam_id String Defines the IBM ID of the user whose settings are being modified. 
 initialValue String The original value for a specific user setting. Not applicable for allowed_ip_addresses. 
 newValue String The new value for a specific user setting. Not applicable for allowed_ip_addresses. 
 updateType String The specific user setting that is updated. 
 security_questions_setup Boolean Defines when a user requires security questions to log in to the account. <br>This field is set to true to indicate that questions are required. 
 self_manage Boolean Defines whether a user can configure his log in settings on how to log in to the account. <br>This field is set to true to allow a user to set password expiration, turn on security questions for login, and define allowed IP addresses for log in to IBM Cloud and from classic infrastructure API calls. 
 totalNumberChanges The number of settings updated. 









 Events for managing account usage reports 

This section explains events that are generated when a user looks at the information that is provided through the Manage > Billing and usage > Usage section, or request an export of the data.

You can get events with reason.reasonCode = 404 that are generated when there is no usage data available for the request. The severity is set to normal.



 requestData fields 

The following table lists the fields that are available through the requestData field in the events with actions billing.account-summary.read, billing.account-summary.download, and billing.account-instances-usage-report.download:



Table 16.
For example, a service might require you to input a language parameter to set the default language that is returned in the resource key that is generated.

To create a resource key, call the [Resource Controller API](https://cloud.ibm.com/apidocs/resource-controller/resource-controllercreate-resource-key) as shown in the following example:



* Curl
* Java
* Python
* Go
* Node



curl -X POST https://resource-controller.cloud.ibm.com/v2/resource_keys -H 'Authorization: Bearer <IAM_TOKEN>' -H 'Content-Type: application/json' -d '{
"name": "my-instance-key-1",
"source": "267bf377-7fa2-43f6-94ec-09103a8e89d4",
"role": "Writer"
}'

ResourceKeyPostParameters parameters = new ResourceKeyPostParameters.Builder()
.add("exampleParameter", "exampleValue")
.build();
CreateResourceKeyOptions createResourceKeyOptions = new CreateResourceKeyOptions.Builder()
.name(keyName)
.source(instanceGuid)
.parameters(parameters)
.build();

Response<ResourceKey> response = service.createResourceKey(createResourceKeyOptions).execute();
ResourceKey resourceKey = response.getResult();

System.out.printf("createResourceKey() response:n%sn", resourceKey.toString());

parameters = {
'exampleParameter': 'exampleValue'
}
resource_key = resource_controller_service.create_resource_key(
name=key_name,
source=instance_guid,
parameters=parameters
).get_result()

print('ncreate_resource_key() response:n',
json.dumps(resource_key, indent=2))