vania-janet/multiturn-rag-retrieval-data huggingface dataset:
If the value provided for limit is not a positive integer or is greater than the maximum limit, the server SHOULD return a 400 status code and appropriate error response model.





 Additional response fields 

Collections using token-based pagination MUST return a page token field, having the same name as the page token query parameter, in any next, previous, and last fields whenever these are present according the conditions defined for [Link-based pagination](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-paginationlink-based-pagination). The value of the page token field can be passed in the page token query parameter on a subsequent request to retrieve the next, previous, or last page of results, respectively.

There is no need for a page token field in first since the first page of results can be obtained by simply omitting the page token query parameter from the request.

If the limit query parameter is supported, the limit MUST be included in the collection response. The value for this field MUST be an integer, and MUST be included whether it was explicitly provided by the user or provided by a default.

A total_count field MAY also be included in the collection response. If present, this field MUST contain an integer representing the total number of resources in the collection (accounting for filtering, but not for paging). If it is expensive or impractical to provide a total_count value, the total_count field SHOULD be omitted.





 Accuracy and consistency 

If it is deemed critical that a client be able to retrieve all pages without any duplicated or omitted resources, one of two approaches MAY be implemented:



1. Pagination MAY be performed across an ephemeral snapshot of the collection made with the first request and referenced by the token.[4] This approach guarantees that all pages in a paginated set represent the resources in the collection at the time of the initial request.
2. A paginated collection MAY require that sorting be performed only on immutable fields, while each request is still made against live data. This approach guarantees that all resources that existed for the entire duration of paginated requests are neither omitted nor duplicated if all pages in a collection are requested in sequence.







 Example token-based pagination response 

{
apiKey, response, err := iamIdentityService.CreateAPIKey(createAPIKeyOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(apiKey, "", " ")
fmt.Println(string(b))
apikeyID = apiKey.ID

const params = {
name: apikeyName,
iamId: iamId,
description: 'Example ApiKey',
};

iamIdentityService.createApiKey(params)
.then(res => {
apikeyId = res.result.id
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});





 Updating an API key for a service ID using the API 

To edit an API key for a service ID by using the API, call the [IAM Identity Service API](https://cloud.ibm.com/apidocs/iam-identity-token-api?code=goupdate-api-key) as shown in the following example:



* Curl
* Java
* Python
* Go
* Node



curl -X PUT 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID' -H 'Authorization: Bearer TOKEN' -H 'If-Match: <value of etag header from GET request>' -H 'Content-Type: application/json' -d '{
"name": "Service-apikey",
"description": "my service key"
}'

UpdateApiKeyOptions updateApiKeyOptions = new UpdateApiKeyOptions.Builder()
.id(apikeyId)
.ifMatch(apikeyEtag)
.description("This is an updated description")
.build();
The AWS CLI also allows direct API calls that provide the same responses as direct HTTP requests by using the s3api command.



 Listing buckets: 

$ aws --endpoint-url {endpoint} s3api list-buckets
{
"Owner": {
"DisplayName": "{storage-account-uuid}",
"ID": "{storage-account-uuid}"
},
"Buckets": [
{
"CreationDate": "2016-09-09T12:48:52.442Z",
"Name": "bucket-1"
},
{
"CreationDate": "2016-09-16T21:29:00.912Z",
"Name": "bucket-2"
}
]
}
Show more





 Listing objects within a bucket 

$ aws --endpoint-url {endpoint} s3api list-objects --bucket bucket-1

{
"Contents": [
{
"LastModified": "2016-09-28T15:36:56.807Z",
"ETag": ""13d567d518c650414c50a81805fff7f2"",
"StorageClass": "STANDARD",
"Key": "c1ca2-filename-00001",
"Owner": {
"DisplayName": "{storage-account-uuid}",
"ID": "{storage-account-uuid}"
},
"Size": 837
},
{
"LastModified": "2016-09-09T12:49:58.018Z",
"ETag": ""3ca744fa96cb95e92081708887f63de5"",
"StorageClass": "STANDARD",
"Key": "c9872-filename-00002",
An API key is used to track and control how the API is being used, for example, to prevent malicious use or abuse of the API.





 API operation 

A unit of a REST API that can be invoked. An API operation comprises an HTTP verb and a URL path that is subordinate to the context root of the API.





 API resource 

A unit of a REST API that can be invoked. An API resource comprises an HTTP verb and a unique URL path that is subordinate to the context root of the API.





 app 

A web or mobile device application. See also [web application](https://cloud.ibm.com/docs/overview?topic=overview-glossaryx2116500), [mobile application](https://cloud.ibm.com/docs/overview?topic=overview-glossaryx4258535).





 artifact 

An entity that is used or produced by a software or systems development process. Examples of artifacts include designs, requirements, source files, plans, scripts, simulations, models, test plans, and binary executable files. In an HTTP context, artifacts have a URI and are called resources.





 assembly 

An application programming interface that provides rich functionality for interacting with an application. The assembly makes side calls to external services and then transforms and aggregates the response before a response is relayed to the calling application.





 asset 

Tangible or intangible goods, services, or property represented as an entity that is traded on a blockchain network.





 attachment 

In Security and Compliance Center, the connection between a profile and scope.





 attribute 

A characteristic or trait of an entity that describes the entity; for example, the telephone number of an employee is one of the employee attributes.





 authentication (AuthN) 

The process of validating the identity of a user or server.





 AuthN 

See [authentication](https://cloud.ibm.com/docs/overview?topic=overview-glossaryx2014567).





 authorization (AuthZ) 

In computer security, the right granted to a user to communicate with or make use of a computer system.





 AuthZ
"object_1": {
"property_1": "Another string value"
}
}
}
]
},
"user_id": "faf4a112-f09f-4a95-a0be-43c496e6ac9a"
}
Show more

Your application can parse and display the data in any way you choose.







 Example: Implementing option responses 

To show how a client application might handle option responses, which prompt the user to select from a list of choices, we can extend the client example described in [Building a client application](https://cloud.ibm.com/docs/assistant?topic=assistant-api-client). This is a simplified client app that uses standard input and output to handle three intents (sending a greeting, showing the current time, and exiting from the app):

Welcome to the Watson Assistant example!
>> hello
Good day to you.
>> what time is it?
The current time is 12:40:42 PM.
>> goodbye
OK! See you later.

If you want to try the example code shown in this topic, you should first set up the required workspace and obtain the API details you will need. For more information, see [Building a client application](https://cloud.ibm.com/docs/assistant?topic=assistant-api-client).



 Receiving an option response 

The option response can be used when you want to present the user with a finite list of choices, rather than interpreting natural language input. This can be used in any situation where you want to enable the user to quickly select from a set of unambiguous options.

In our simplified client app, we will use this capability to select from a list of the actions the assistant supports (greetings, displaying the time, and exiting). In addition to the three intents previously shown (hello, time, and goodbye), the example workspace supports a fourth intent: menu, which is matched when the use asks to see a list of available actions.

When the workspace recognizes the menu intent, the dialog responds with an option response:

{
"output": {
* [Resource Bindings APIs](https://cloud.ibm.com/apidocs/resource-controller/resource-controllerlist-resource-bindings)
* [Resource Aliases APIs](https://cloud.ibm.com/apidocs/resource-controller/resource-controllerlist-resource-aliases)
* [IAM Policy APIs](https://cloud.ibm.com/apidocs/iam-policy-managementlist-policies)
* [Global Search APIs](https://cloud.ibm.com/apidocs/search)
* Global Tagging [Attach](https://cloud.ibm.com/apidocs/taggingattach-tag) and [Detach](https://cloud.ibm.com/apidocs/taggingdetach-tag) APIs
* [Context-based Restriction Rule APIs](https://cloud.ibm.com/apidocs/context-based-restrictionscreate-rule)





 DNS Services CBR Limitations 



* The CBR rules created on DNS Services don't apply to platform actions such as Global Search and Tagging, resource instance creation and deletion on DNS Services instances. You can still view DNS Services instances on IBM Cloud Resource Explorer.
* When you create a rule, it might take up to 10 minutes to become enforced.









 Creating rules 

Context-based restrictions for DNS Services can be scoped to a service instance or resource group by using resource attributes.

You can select a service instance by entering the ID. Alternatively, you can use the * wildcard to select all applicable service instances. You can also specify which resource group the rule is applied to in the command.



 Creating rules by using the API 

Review the following example requests to create rules. For more information about the v1/rules API, see the [API docs](https://cloud.ibm.com/apidocs/context-based-restrictionscreate-rule).

When you create a rule with context attribute to restrict requests to private endpoint, it is not possible to restrict access to an overlay IP for an individual VPC virtual server instance or bare-metal server.
allDocsQueries := []cloudantv1.AllDocsQuery{
{
Keys: []string{
"small-appliances:1000042",
"small-appliances:1000043",
},
},
{
Limit: core.Int64Ptr(3),
Skip: core.Int64Ptr(2),
},
}
postAllDocsQueriesOptions := service.NewPostAllDocsQueriesOptions(
"products",
allDocsQueries,
)

allDocsQueriesResult, response, err := service.PostAllDocsQueries(postAllDocsQueriesOptions)
if err != nil {
panic(err)
}

b, _ := json.MarshalIndent(allDocsQueriesResult, "", " ")
fmt.Println(string(b))

import { CloudantV1 } from '@ibm-cloud/cloudant';

const service = CloudantV1.newInstance({});

const allDocsQueries: CloudantV1.AllDocsQuery[] = [{
keys: 'small-appliances:1000042', 'small-appliances:1000043'],
},
{
limit: 3,
skip: 2
}];

service.postAllDocsQueries({
db: 'products',
queries: allDocsQueries
}).then(response => {
console.log(response.result);
});

The previous Go example requires the following import block:

import (
"encoding/json"
"fmt"
"github.com/IBM/cloudant-go-sdk/cloudantv1"
)

All Go examples require the service object to be initialized.
* See [Delete a binding API](https://cloud.ibm.com/apidocs/codeengine/v2delete-binding).



Added support for service access secrets which are required for service binding operations. Specify to create service access secrets with the format field and specify the details of service access secrets with the service_access field.
: 

* See [Create a secret API](https://cloud.ibm.com/apidocs/codeengine/v2create-secret).







 30 May 2023 

Added support to get status details for a project.
: 

* See [Get the status details for a project API](https://cloud.ibm.com/apidocs/codeengine/v2get-project-status-details).







 27 Mar 2023 

Added support to provide private and public egress IP addresses for a project.
: 

* See [List egress IP addresses for projects API](https://cloud.ibm.com/apidocs/codeengine/v2get-project-egress-ips).



: 

* See [Code Engine public and private IP addresses](https://cloud.ibm.com/docs/codeengine?topic=codeengine-network-addresses).



Improved documentation for create and update of secrets to include the One of fields for specific secret formats as part of the data field.
: 

* See [Create a secret API](https://cloud.ibm.com/apidocs/codeengine/v2create-secret).



: 

* See [Update secret API](https://cloud.ibm.com/apidocs/codeengine/v2replace-secret).







 9 Dec 2022 

IBM Cloud® Code Engine API Version 2.0.0

API Version 2.0.0 released
: This version of the API is enhanced to support more Code Engine resources, and more regions.



* The API supports the following Code Engine resources: projects, reclamations, apps, revisions, job, job runs, builds, build runs, config maps, and secrets.
Syntax

GET https://{endpoint}/{bucket-name}?list-type=2 path style
GET https://{bucket-name}.{endpoint}?list-type=2 virtual host style



 Optional query parameters 



 Name Type Description 

 list-type String Indicates version 2 of the API and the value must be 2. 
 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. 
 fetch-owner String Version 2 of the API does not include the Owner information by default. Set this parameter to true if Owner information is desired in the response. 
 continuation-token String Specifies the next set of objects to be returned when your response is truncated (IsTruncated element returns true). <br> <br>Your initial response will include the NextContinuationToken element. Use this token in the next request as the value for continuation-token. 
 start-after String Returns key names after a specific key object. <br> <br>This parameter is only valid in your initial request. If a continuation-token parameter is included in your request, this parameter is ignored. 



Example request (simple)

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

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

Sample request (simple)

GET /apiary?list-type=2 HTTP/1.1
Authorization: 'AWS4-HMAC-SHA256 Credential={access-key}/{date}/{region}/s3/aws4_request,SignedHeaders=host;x-amz-date;,Signature={signature}'
Select get /getweatherdata from the list of operations.
![select-operation-1.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/select-operation-1.png)
7. Scroll down to the zip_code field, enter 10504.
![test-api-1.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/test-api-1.png)
8. Click Invoke. The API returns the current weather.
![test-wdata-result.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/test-wdata-result.png)







 Conclusion 

In this tutorial, you completed the following activities:



1. Set up a REST API definition
2. Configured an API to invoke an existing web service and return its output
3. Tested your API definition







 Next step 

[Secure your API using OAuth 2.0](https://cloud.ibm.com/docs/apiconnect/tutorials?topic=apiconnect-tut_secure_oauth_2).

Create > Manage > Secure > Socialize > Analyze
[Get a service key](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-service_keys).





 Step 2. Identify the data to pass through the export parameters 

When you use the export API, you can define 1 or more parameters to refine the set of events that you export. For example, consider the following parameters:



* levels: This parameter is used to filter events based on the criticality of a request.
* query: This parameter is used to define the search query that is used to filter events.
* hosts: This parameter is used to list the services from which you want to export data.



To verify that the query that you enter returns the set of events that you are looking for, define the search query through the UI.

Consider the following information when you define the search query through the UI



1. Select the sources.

Sources represent IBM Cloud services.

The values that you identify will be required to set the hosts parameter.

If you set the host field in the query, this parameter is not required.
2. Select the levels.

In Activity Tracker, level maps to the [severity event field](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-eventseverity). Severity defines the level of threat an action may have on the IBM Cloud.

Valid severity values are critical, warning, and normal.

If you set the field severity in the query, this parameter is not required.
3. Define the search query.

To get more information on how to search, see [Select the set of events to display through a view by applying a search query](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-viewsviews_step2).

Refine the query until you can only see the events that you want to export.







 Step 3. Map the data to the query parameters 

To define the parameters that you need for the export request, complete the following steps:



1. Map your sources to the hosts parameter. The hosts parameter is a comma-separated list of services.
2.
{"_id":"4048023","_rev":"1-744baaba02218fd84b350e8982c0b783","name":"Bessemer","latitude":33.40178,"longitude":-86.95444,"country":"US","population":27456,"timezone":"America/Chicago"},
{"_id":"4048662","_rev":"1-e95c97013ece566b37583e451c1864ee","name":"Paducah","latitude":37.08339,"longitude":-88.60005,"country":"US","population":25024,"timezone":"America/Chicago"}
] ,
"bookmark": "g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58"
}
Show more
The response includes an array of docs, and a bookmark, which you use to paginate through the results in the next request. When you need page two of the results, you repeat the query by passing IBM Cloudant the bookmark from the first response. curl -X POST -H "Authorization: Bearer $API_BEARER_TOKEN" -H 'Content-type: application/json' -d '{"selector":{"country":{"$eq": "US"}},"limit":5,"bookmark":"g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58"}' "$SERVICE_URL/cities/_find"
{
"docs":
: The new APIs are functionally identical to the existing Conversation APIs, which continue to be supported. For more information about the Watson Assistant APIs, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1).

Dialog enhancements
: The following features were added to the dialog tool:



* Simple variable name and value fields are now available that you can use to add context variables or update context variable values. You do not need to open the JSON editor unless you want to. See [Defining a context variable](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-runtime-contextdialog-runtime-context-var-define) for more details.
* Organize your dialog by using folders to group together related dialog nodes. See [Organizing the dialog with folders](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-tasksdialog-tasks-folders) for more details.
* Support was added for customizing how each dialog node participates in user-initiated digressions away from the designated dialog flow. See [Digressions](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-runtimedialog-runtime-digressions) for more details.



Search intents and entities
: A new search feature has been added that allows you to [search intents](https://cloud.ibm.com/docs/assistant?topic=assistant-intentsintents-search) for user examples, intent names, or descriptions, or to [search entity](https://cloud.ibm.com/docs/assistant?topic=assistant-entitiesentities-search) values and synonyms.

Content catalogs
: The new [content catalogs](https://cloud.ibm.com/docs/assistant?topic=assistant-catalogcatalog-add) contain a single category of prebuilt common intents and entities that you can add to your application. For example, most applications require a general greeting-type intent that starts a dialog with the user.
Adding and deleting storage 

You can increase or decrease the NFS storage capacity of your deployment by adding or deleting storage to and from a cluster.



1.  In the VMware Solutions console, click Resources > VMware as a Service from the left navigation pane.
2.  In the VMware as a Service table, click the Cloud director sites tab, then click an instance name..
3.  Click the Infrastructure tab.
4.  On the Clusters tab, click a cluster name to expand its details.
5.  Click Edit NFS storage.
6.  In the Edit shared storage window, increase or decrease the current sizings for the performance tiers available.
7.  Review the new cost, select the confirmation checkbox, and click Change to confirm.



Editing the storage details might take up to 24 hours to complete. If a storage update is in progress, you cannot edit the storage until the previous operation is complete.



  Related links 



*  [Adding virtual data centers](https://cloud.ibm.com/docs/vmware-service?topic=vmware-service-vdc-adding)
*  [Viewing and deleting virtual data centers](https://cloud.ibm.com/docs/vmware-service?topic=vmware-service-vdc-view-delete)
*  [Viewing VMware as a Service instances](https://cloud.ibm.com/docs/vmware-service?topic=vmware-service-tenant-viewing)
* CLI
* API







 Managing storage limits 

By default, you can provision a combined total of 700 Block Storage for Classic and File Storage for Classic volumes globally. By following this process, you can increase the number of volumes that you can provision.

For more information about increasing your storage volume capacity beyond 12 TB, see [expanding Block Storage for Classic capacity](https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-expandingcapacityincreasecapacityover12TB).



 Confirming your current limit and provisioning count from the CLI 

If you're unsure how many volumes you have, you can confirm the numbers by using multiple methods.



 SLCLI 

You can list the number of your volumes by using the [volume-limits](https://softlayer-python.readthedocs.io/en/latest/cli/block/block-volume-limits) command in slcli (version 5.8.5 or higher).

 slcli block volume-limits

The output looks similar to the following example.

[{'datacenterName': 'global', 'maximumAvailableCount': 700, 'provisioned Count':117}]
:............:.......................:..................:
: Datacenter : maximumAvailableCount : ProvisionedCount :
:............:.......................:..................:
: global : 700 : 117 :
:............:.......................:..................:





 IBM Cloud CLI
Unmount, then mount the modified volume, so the OS can recognize the extra storage space.





 Resizing storage with the API 

You can increase your storage capacity by using an API call to the SOAP web service. The following sample API calls can be called from the scripting language of your choice.

For more information about the SLAPI, see the [SLDN](http://sldn.softlayer.com/reference/softlayerapi).



* Increase capacity on a Performance storage volume.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.service.softlayer.com/soap/v3.1/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Header>
<ns1:authenticate>
</ns1:authenticate>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ns1:placeOrder>
<orderData xsi:type="ns1:SoftLayer_Container_Product_Order_Network_Storage_AsAService_Upgrade">
<volume xsi:type="ns1:SoftLayer_Network_Storage">
<id xsi:type="xsd:int">XXXXXXXX</id> <!--where XXXXXXXXis the VolumeID-->
</volume>
<volumeSize xsi:type="xsd:int">2007</volumeSize>