vania-janet/multiturn-rag-retrieval-data huggingface dataset:
It is only required to specify the unique resource by name inside this VPC.
* --output: Specify output format, only JSON is supported. One of: JSON.
* -q, --quiet: Suppress verbose output.



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







 ibmcloud is load-balancer-listener-policy-rule-create 

Create a load balancer listener policy rule.

ibmcloud is load-balancer-listener-policy-rule-create LOAD_BALANCER LISTENER_ID POLICY (--condition contains | equals | matches_regex) (--type header | hostname | path | query | body) --value VALUE [--vpc VPC] [--field FIELD] [--output JSON] [-q, --quiet]



 Command examples 



* ibmcloud is load-balancer-listener-policy-rule-create 72251a2e-d6c5-42b4-97b0-b5f8e8d1f479 72b27b5c-f4b0-48bb-b954-5becc7c1dcb3 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --condition equals --type header --field my-app-header --value match-value --output JSON
* ibmcloud is load-balancer-listener-policy-rule-create my-lb 72b27b5c-f4b0-48bb-b954-5becc7c1dcb3 my-policy --condition equals --type header --field my-app-header --value match-value --output JSON







 Command options 



* LOAD_BALANCER: ID or name of the load balancer.
* LISTENER_ID: ID of the listener.
* POLICY: ID or name of the policy.
* --vpc: ID or name of the VPC. It is only required to specify the unique resource by name inside this VPC.
* --condition: The condition of the rule.
* The requestData.initialValue.PolicyKCIAAttrIRK field includes if your key creation and importation policy previously allowed imported root keys.
* The requestData.newValue.PolicyKCIAAttrIRK field includes if your key creation and importation policy allows imported root keys.
* The requestData.initialValue.PolicyKCIAAttrISK field includes if your key creation and importation policy previously allowed imported standard keys.
* The requestData.newValue.PolicyKCIAAttrISK field includes if your key creation and importation policy allows imported standard keys.
* The requestData.initialValue.PolicyKCIAAttrET field includes if your key creation and importation policy previously required keys to be imported through import token.
* The requestData.newValue.PolicyKCIAAttrET field includes if your key creation and importation policy requires keys to be imported through import token.









 Import token events 



 Create import token 

The following fields include extra information:



* The responseData.expirationDate field includes the expiration date of the import token.
* The responseData.maxAllowedRetrievals field includes the maximum number of times the import token can be retrieved within the expiration time before it is no longer accessible.







 Retrieve import token 

The following fields include extra information:



* The responseData.maxAllowedRetrievals field includes the maximum number of times the import token can be retrieved within the expiration time before it is no longer accessible.
* The responseData.remainingRetrievals field includes the number of times the import token can be retrieved within the expiration time before it is no longer accessible.









 Registration events 



 List registrations 

The following field includes extra information:



* The responseData.totalResources field includes the total number of registrations that are returned in the response.









 Trusted Key Entry events 

The following table lists the returned values that indicate a successful TKE event.



Table 14. Returned values of a successful TKE event

 Field name Returned value 

 outcome success 
 reason.reasonCode 200 
 reason.reasonType OK 



The following common fields for TKE events include extra information:
* The requestData.newValue.policyAllowedNetworkEnabled field includes if your allowed network policy is currently enabled or disabled.
* The requestData.newValue.policyAllowedNetworkAttribute field includes if your allowed network policy is currently only for public networks or both public and private networks.







 Dual Auth Delete Policies 

The following fields include extra information:



* The requestData.initialValue.policyDualAuthDeleteEnabled field includes if your dual auth delete policy was previously enabled or disabled.
* The requestData.newValue.policyDualAuthDeleteEnabled field includes if your dual auth delete policy is currently enabled or disabled.







 Allowed IP Policies 

The following fields include extra information:



* The requestData.initialValue.policyAllowedIPAttribute field includes if your allowed IP policy was previously enabled or disabled.
* The requestData.newValue.policyAllowedIPAttribute field includes if your allowed IP policy is currently enabled or disabled.







 Key Creation and Importation Access Policies 

The following fields include extra information:



* The requestData.initialValue.PolicyKCIAEnabled field includes if your key creation and importation policy was previously enabled or disabled.
* The requestData.newValue.PolicyKCIAEnabled field includes if your key creation and importation policy is currently enabled or disabled.
* The requestData.initialValue.PolicyKCIAAttrCRK field includes if your key creation and importation policy previously allowed the creation of root keys.
* The requestData.newValue.PolicyKCIAAttrCRK field includes if your key creation and importation policy allows the creation of root keys.
* The requestData.initialValue.PolicyKCIAAttrCSK field includes if your key creation and importation policy previously allowed the creation of standard keys.
* The requestData.newValue.PolicyKCIAAttrCSK field includes if your key creation and importation policy allows the creation of standard keys.
* The requestData.initialValue.PolicyKCIAAttrIRK field includes if your key creation and importation policy previously allowed imported root keys.
verifyCdnAccountExists 

Checks whether a CDN account exists for the user calling the API, for the given vendorName.



* Parameters- vendorName- (Required) Provide the name of a valid CDN provider.
* Return- true if an account exists, else false.



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







 API for Domain Mapping 



 createDomainMapping 

Using the provided inputs, this function creates a domain mapping for the given vendor and associates it with the IBM Cloud Infrastructure Account ID of the user. The CDN account must first be created by using placeOrder for this API to work (see an example of the placeOrder API call in the [Code examples](https://cloud.ibm.com/docs/CDN?topic=CDN-code-examples-using-the-cdn-api)). After successfully creating the CDN, a defaultTTL is created with a value of 3600 seconds.



* 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 can be provided when creating a domain mapping (attributes are optional unless otherwise noted):



* vendorName - (Required) Provide the name of a valid IBM Cloud CDN provider.



* origin - (Required) Provide the origin server address as a string.
* originType - (Required) Origin type can be HOST_SERVER or OBJECT_STORAGE.
* domain - (Required) Provide your hostname as a string.
* 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.
--locality ([]string)
: The Locality (L) values to define in the subject field of the resulting certificate.

The list items must match regular expression /(.?)/. The maximum length is 10 items. The minimum length is 0 items.

--province ([]string)
: The Province (ST) values to define in the subject field of the resulting certificate.

The list items must match regular expression /(.?)/. The maximum length is 10 items. The minimum length is 0 items.

--street-address ([]string)
: The street address values to define in the subject field of the resulting certificate.

The list items must match regular expression /(.?)/. The maximum length is 10 items. The minimum length is 0 items.

--postal-code ([]string)
: The postal code values to define in the subject field of the resulting certificate.

The list items must match regular expression /(.?)/. The maximum length is 10 items. The minimum length is 0 items.

--serial-number (string)
: The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.

The maximum length is 64 characters. The minimum length is 32 characters. The value must match regular expression /[^a-fA-F0-9]/.

--require-cn (bool)
: This field indicates whether to require a common name to create a private certificate.

By default, a common name is required to generate a certificate. To make the common_name field optional, set the require_cn option to false.

--policy-identifiers ([]string)
: A list of policy Object Identifiers (OIDs).

The list items must match regular expression /(.?)/. The maximum length is 100 items. The minimum length is 0 items.

--basic-constraints-valid-for-non-ca (bool)
If you or your company is a business associate of a covered entity, [contact IBM Cloud Sales](https://www.ibm.com/account/reg/us-en/signup?formid=MAIL-wcp) to accept the applicable BAA. For more information about HIPAA definitions of covered entities and business associates, see the [US Department of Health & Human Services](https://www.hhs.gov/hipaa/for-professionals/covered-entities/index.html) website.







 Define the auditing instances strategy 

IBM Cloud Activity Tracker collects and aggregates events in one centralized system.



* Data is hosted on the IBM Cloud.
* Data is collocated in the location where an IBM Cloud Activity Tracker instance is provisioned, except for events that report on global actions.





 Locations 

You can provision instances of the IBM Cloud Activity Tracker service in any of the supported locations in the IBM Cloud. For more information, see [Locations](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-regions).

Per location (region), you can provision 1 auditing instance.



* Events from enabled-AT services in the IBM Cloud are collected automatically.
* Each location represents the geographic area where your IBM Cloud Activity Tracker requests are handled and processed for that instance, and where data is resident.
* Each MZR location has three different data centers for redundancy. The data for each location is kept in the three data centers near that location. If all three data centers in a location fail, the IBM Cloud Activity Tracker service for that location becomes unavailable.
* Each MZR configuration can accept a single data center failure.



When you choose the locations where you plan to provision IBM Cloud Activity Tracker instances, check the regulatory and high availability (HA) specifications of each location.

For example, in Europe, only the Frankfurt region is EU-supported.

You can also check [ensure zero downtime](https://cloud.ibm.com/docs/overview?topic=overview-zero-downtimezero-downtime) to learn more about the high availability and disaster recovery standards in IBM Cloud.





 Resource groups 

Resource groups are a logical container for organizing your IAM-enabled resources.
* The requestData.newValue.policyAllowedNetworkEnabled field includes if your allowed network policy is enabled or disabled.
* The requestData.newValue.policyAllowedNetworkAttribute field includes if your allowed network policy is only for public networks or both public and private networks.







 Dual auth delete policies 

The following fields include extra information:



* The requestData.initialValue.policyDualAuthDeleteEnabled field includes if your dual auth delete policy was previously enabled or disabled.
* The requestData.newValue.policyDualAuthDeleteEnabled field includes if your dual auth delete policy is enabled or disabled.







 Key creation and importation access policies 

The following fields include extra information:



* The requestData.initialValue.PolicyKCIAEnabled field includes if your key creation and importation policy was previously enabled or disabled.
* The requestData.newValue.PolicyKCIAEnabled field includes if your key creation and importation policy is enabled or disabled.
* The requestData.initialValue.PolicyKCIAAttrCRK field includes if your key creation and importation policy previously allowed the creation of root keys.
* The requestData.newValue.PolicyKCIAAttrCRK field includes if your key creation and importation policy allows the creation of root keys.
* The requestData.initialValue.PolicyKCIAAttrCSK field includes if your key creation and importation policy previously allowed the creation of standard keys.
* The requestData.newValue.PolicyKCIAAttrCSK field includes if your key creation and importation policy allows the creation of standard keys.
* The requestData.initialValue.PolicyKCIAAttrIRK field includes if your key creation and importation policy previously allowed imported root keys.
* The requestData.newValue.PolicyKCIAAttrIRK field includes if your key creation and importation policy allows imported root keys.
* The requestData.initialValue.PolicyKCIAAttrISK field includes if your key creation and importation policy previously allowed imported standard keys.
pitch_percentage (optional integer)
: Specifies the global speaking pitch for the entire synthesis request. The speaking pitch represents the tone of the speech that the service synthesizes. It represents how high or low the tone of the voice is perceived by the listener. A higher pitch results in speech that is spoken at a higher tone; a lower pitch results in speech that is spoken in a lower tone. The parameter changes the per-voice default pitch for an entire request. For more information, see [Modifying the speaking pitch](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-paramsparams-pitch-percentage).

spell_out_mode (optional string)
: For German voices, specifies how individual characters of a string are to be spelled out. By default, the service spells out individual characters at the same rate at which it synthesizes text for a language. You can use the parameter to direct the service to spell out individual characters more slowly, in groups of one (singles), two (pairs), or three (triples). For more information, see [Specifying how strings are spelled out](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-paramsparams-spell-out-mode).

x-watson-metadata (optional string)
: Associates a customer ID with data that is passed over the connection. The parameter accepts the argument customer_id={id}, where id is a random or generic string that is to be associated with the data. You must URL-encode the argument to the parameter, for example, customer_id%3dmy_customer_ID. By default, no customer ID is associated with the data. For more information, see [Information security](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-information-security).

x-watson-learning-opt-out (optional boolean)
:
IBM Cloud

Indicates whether the service logs requests and results that are sent over the connection.
You can use the values from this file to complete your configuration file.If your are using the APIs: You can call GET /ak/api/v2/components]GET _components] ! ! ! ! ! to get the connection information of your CA. If you created the CA with the Create a Fabric CA API, you can also find the necessary information in the response body.<-- <ul> --> * The "cahost" and "caport" values are visible in the ca_url field in the response body or CA JSON file that you exported. For example, if your ca_url is https://9.30.94.174:30167, the value of the "cahost" would be 9.30.94.174 and the "caport" would be 30167. * The "caname" is the name of the CA that was specified when you deployed the CA. This is the value of the ca_name field in the response body or the exported JSON file. * The "cacert" is the base64-encoded TLS certificate of your CA. This is the value of the pem field in the response body or the exported JSON file. * The fields in the "tls" section below require the same information as you passed to the component sections above, except you need to use the value of the CA TLS instance name that is specified during CA deployment. Replace caname with the value of tlsca_name in the response body or the exported JSON file. Use the same TLS cert for the "cacert" value.
"tls": {
"cahost": "",
"caport": "",
"caname": "",
"catls": {
"cacert": ""
A comma-delimited list that is the source of the tuples from which features are to be selected. The format of the <from list> is similar to the format of the <from list> of the select statement. However, if the extract statement does not have a pattern specification, then the <from list> can contain a single item.
* [having <having clause>]

Specifies a filtering predicate (in the <having clause>) that is applied to each extracted output tuple. The field names that are specified in the <having clause> refer to any aliases that are specified in the <select list>. This clause is optional.
* [consolidate on <column>using '<policy>' ]]

Defines how to handle overlapping spans as defined in the consolidation <policy>. In this specification, <column> must be the name of an output field, which is part of the extract statement. This clause is optional.
* [limit<maximum number of output tuples for each document>]

Limits the number of output tuples from each document to the specified maximum. This clause is optional.







 Usage notes 

The semantics of the extract statement are as follows:



* Evaluate the extraction specification over each tuple of the input relation. For each result that the extraction produces, an output tuple that contains the extracted values, along with any columns of the original tuple that were specified in the <select list>, is produced.
* Rename the columns of the output tuple according to the aliases specified as part of the <select list> and the <extraction specification>.
* Apply any predicates in the optional having clause to the resulting output tuple.
* Consolidate tuples that pass the predicates according to the optional consolidation clause, and add the resulting tuples to the output.
* If the optional limit clause is present, limit the output to the specified number of tuples for each document.



The semantics of the from clause of an extract pattern statement are different from other forms of extract statements that do not have a pattern specification. If at least one of the views in the <from list> does not contain any tuples on a particular document, then the output of the extract statement is empty.
Using fields, functions, and expressions 

Along with actions, fields and expressions are the building blocks of firewall rules. These two elements work together when defining the criteria to use when a firewall rule is matched.



 Fields 

When CIS receives an HTTP request, it is examined and a table of fields is produced to match against. This field table exists for as long as the current request is being processed. Think of it as a table that holds the request properties to be matched against expressions.

Each field value can be sourced from different places, such as:



* Primitive properties, obtained directly from the traffic – for example, http.request.uri.path.
* Derived values, resulting from a transformation, composition, or basic operation – for example, making the value of http.request.uri.path all lowercase and available as a field of another field.
* Computer values, resulting from a lookup, computation, or other intelligence – for example, a cf.threat_score calculated dynamically by a machine learning process that inspects related primitive and derived values.





 Available fields 



Table 1. Available fields

 Field name Type Example value Notes 

 http.cookie String session=A12345;-background=light Entire cookie as a string 
 http.cookie String www.example.com The host name used in the full request URI 
 http.referer String HTTP referer header 
 http.request.full_uri String https://www.example.com/articles/index?section=539061&expand=comments The full URI as received by the web server (does not include #fragment which is not sent to web servers) 
 http.request.method String POST The HTTP method, in upper case 
 http.request.uri String /articles/index?section=539061&expand=comments The absolute URI of the request 
 http.request.uri.path String /articles/index The path of the request 
 http.request.uri.query String section=539061&expand=comments The whole query string, minus the delimiting prefix "?"
"$or": [
{
"age": {
"$gt": 5
}
},
{
"twitter": {
"$exists":true
}
},
{
"type": {
"$in":
"starch",
"protein"
]
}
}
]
}
Show more

The first part of the JSON query is straightforward to convert to Lucene; the test determines whether the age field has a numerical value greater than 5. The { character in the range expression means that the value 5 isn't considered a match.

To implement the "twitter": {"$exists":true} part of the JSON query in Lucene, the first test is to determine whether a twitter field exists. However, the field might be either an array or an object, so the match must succeed when the value is an array or an object.

This requirement means that the $fieldnames field must have entries that contain either twitter.* or twitter:. The . character is represented in the query as the ASCII character sequence _2e. Similarly, the : character is represented in the query as the ASCII character sequence _3a. This representation requires the use of a two clause OR query for the twitter field, ending in _2e and _3a. Implementing this query as two phrases instead of a single twitter query prevents an accidental match with a field name such as twitter_handle or similar.

The last of the three main clauses are a search for starch or protein. This search is more complicated. The $in operator has some special semantics for array values that are inherited from the way MongoDB behaves. In particular, the $in operator applies to the value or any of the values that are contained in an array that is named by the field. In this example, the expression means that both "type":"starch"and"type":["protein"] would match the example argument to $in. Earlier, the type_3astring expression was converted to type:string.