vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* For get_user, the summary would be Get a user



A summary MAY omit parts of the resource hierarchy as long as the resulting text remains clear. For example the get_farm_barn (GET /farms/{farm_id}/barns/{id}) operation could have the summary Get barn.

A summary MUST NOT contain CommonMark formatting.





 Operation descriptions 

The description value for an operation SHOULD be in full, grammatically correct sentences. The description SHOULD expand on the operation summary (without depending on the summary for context) and include any important details about the purpose and scope of the operation.

An operation description SHOULD also elaborate any important operation-spanning constraints or behaviors that cannot be clearly explained in property or parameter descriptions.

An operation description MAY contain paragraphs, lists, links, and other CommonMark formatting.







 Property and parameter descriptions 

The description value for a property or parameter SHOULD start with a sentence-fragment definition, ending with a period. For example, "A network-connected block storage device."

These descriptions SHOULD also elaborate on the purpose and usefulness of the property or parameter along with any constraints or behaviors that cannot be defined with native OpenAPI schema keywords, as recommended for various [Types](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-types).

A property or parameter description MAY contain paragraphs, lists, links, and other CommonMark formatting.
The Name section lists multiple API calls. Click the message call associated with your test utterance, and then click the Response column to see the API response body. It lists the intents and entities that were recognized in the user input with their confidence scores, and the values of context variables at the time of the call. To view the response body in structured format, click the Preview column.

![Shows how to view the API call details by using Chrome web browser developer tools.](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/api-browser-dev.png)

Previous topic:[Improving your conversation](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-dialog-tasks)

Next topic:[Connecting customers with support](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-dialog-support)
requestParams.startKeyDocId = documentsdocuments.length - 1] .id + 'u0000';
viewResult = (await service.postView(requestParams)).result;
}
}

paginate(3)
import json
from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance()
page_size = 3

diet = 'herbivore'
request_params = d = dict(
db='animaldb',
ddoc='views101',
view='diet',
limit=page_size,
start_key=diet,
end_key=diet,
)
response = service.post_view(request_params).get_result()

while len(response"rows"]) > 0:
documents = response"rows"]
print(json.dumps(documents, indent=2))
 The startKeyDocId of the next request becomes the last document id appended with u0000
request_params'start_key_doc_id'] = documents-1]"id"] !! + 'u0000'
response = service.post_view(request_params).get_result()
pageSize := core.Int64Ptr(5)
diet := "herbivore"
viewOptions := service.NewPostViewOptions(
"animaldb",
"views101",
"diet",
)
viewOptions.SetLimit(pageSize)
viewOptions.SetStartKey(diet)
viewOptions.SetEndKey(diet)

viewResult, _, err := service.PostView(viewOptions)
if err = nil {
panic(err)
}

for len(viewResult.Rows) > 0 {
documents := viewResult.Rows
To query information about an existing custom model, use the GET /v1/customizations/{customization_id} method. This is the most direct means of seeing all of the information about a model, including its metadata and the word/translation pairs and custom prompts that it contains.

IBM Cloud

curl -X GET -u "apikey:{apikey}" "{url}/v1/customizations/{customization_id}"

IBM Cloud Pak for Data

curl -X GET --header "Authorization: Bearer {token}" "{url}/v1/customizations/{customization_id}"

The method returns its results as a JSON object of the following form:

{
"customization_id": "64f4807f-a5f1-5867-924f-7bba1a84fe97",
"owner": "297cfd08-330a-22ba-93ce-1a73f454dd98",
"created": "2016-07-15T18:12:31.743Z",
"name": "Test",
"language": "en-US",
"description": "Customization test",
"last_modified": "2016-07-15T18:12:31.743Z",
"words": [],
"prompts": []
}

In addition to the information entered when the model was created, the output includes the credentials of the model's owner, the model's language, and the times at which the model was created and last modified. Because the model has not been modified since its creation, the two times in the example are the same.

The output also includes a words array that lists the model's custom words and a prompts array that lists the model's custom prompts. Because the model has yet to be updated, the arrays in the example are empty.





 Querying all custom models 

To see information about all of the custom models that you own, use the GET /v1/customizations method:

IBM Cloud
They are not available by using the API.

Discovery does not log query request data.

For more information about the options for labeling data in Discovery, see [Labeling data](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-information-securitylabeling).

The following stored information is not explicitly labeled and cannot be deleted by specifying the customer_id. Personal Data is not supported in these fields.

Any string fields (including but not limited to name and description) of the following stored items:



* Collections
* Projects







 Labeling data 

Data can be labeled by using the API, or by using the Discovery product user interface. For more information about labeling with the product user interface, see [Labeling data in the product user interface](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-information-securitylabelingtooling).

You cannot label data that is added by crawling external data sources.

Data is labeled by adding the customer_id of your choice to the optional X-Watson-Metadata header. Discovery can then delete it by customer_id.

You can label data with the API in different ways:



* When you ingest documents by using the POST /v2/projects/{project_id}/collections/{collection_id}/documents or POST /v2/projects/{project_id}/collections/{collection_id}/documents/ID operations, send an optional header X-Watson-Metadata. The X-Watson-Metadata header must include either of the following items:



* Semicolon separated field=value pairs (for example: customer_id=123)
* The customer_id field. By adding the customer_id in X-Watson-Metadata header, the request indicates that it contains data that belongs to this customer_id.





Optionally, you can include the customer_id field with the metadata multipart form part instead of including the X-Watson-Metadata header.

If you specify a customer_id in the metadata multipart form part and the X-Watson-Metadata header for the same document, then the customer_id in the X-Watson-Metadata header is used.
[Review operations table](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/extension-review-operations.png)

For each operation, a row in the table shows the following information:



* Operation: A description of the operation, which is derived from either the summary (if present) or description in the OpenAPI file.
* Method: The HTTP method used to send the API request for the operation.
* Resource: The path to the resource the operation acts upon.



To see more information about an operation, click the ![label](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/twistie.png) icon next to its row in the table. The following details are shown:



* Request parameters: The list of input parameters defined for the operation, along with the type of each parameter and whether the parameter is required or optional.
* Response properties: The properties of the response body that are mapped to variables the assistant can access.





7. If you are satisfied with the extension, click Finish.

If you want to change something, delete the extension, edit the JSON file to make your changes, and repeat the import process.



The new extension is now available as a tile in the Extensions section of the integrations catalog, and you can [add it to your assistant](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-add-custom-extension).
TIP: When you call the API, you can also set the HTTP host header on the API request to the value that you specified in the Custom Gateway URL field.



* Custom API URL In the Custom API URL text field, enter the URL. You use the Custom API URL to specify the URL for APIs that are deployed to a third-party gateway.

The Custom API URL represents the endpoint by which the API is known externally. The endpoint is published to the developer portal and used by an application developer to invoke or advertise the API.

If you are using a third-party gateway or external load balancer in this Catalog, supply the URL in this field. Any API endpoints that are displayed in the developer portal reflect the custom URL. These endpoints exist on the third-party gateway or load balancer and project a virtual address that is mapped to the API proxy or API assembly endpoints on the gateway. The endpoints that are derived from the custom API URL are typically published in production developer portals to advertise the address of the API.

Note: If you specify a custom API URL for a Catalog, it takes precedence over any host name that you specify when you configure the API. For more information, see [Specifying an alternative host for an API](https://www.ibm.com/support/knowledgecenter/en/SSFS6T/com.ibm.apic.toolkit.doc/task_apionprem_creating_apis.htmltask_tq2_11r_xt__enforce_step).
* Hostname for Developer Portal API Calls: In the Port API Endpoint window area, enter a host name for Developer Portal API calls. The host name that you enter can be the host name of your Management service. To access the Developer Portal API within the context of a Developer Portal, you must configure the base host name for the Developer Portal API calls. This action allows API Manager to map your host name to the provider organization and Catalog of the Developer Portal API calls. Your calls don't need to include the information.



7. Click the Save icon.





 Partitioning a Catalog
"href": "https://us-south.iaas.cloud.ibm.com/v1/regions/us-south/zones/us-south-2",
"name": "us-south-2",
"resource_type": "zone"
}
}
]
}





 Viewing volume details with the API 

Make a GET /volumes/{id} call to see details of a volume. See the following example.

curl -X GET "$vpc_api_endpoint/v1/volumes/$volume_id?version=2022-12-09&generation=2" -H "Authorization: $iam_token"

A successful response provides details of the volume, including capacity and IOPS, the volume status, and whether the volume is attached to an instance.

{
"active": true,
"bandwidth": 128,
"busy": false,
"capacity": 100,
"created_at": "2022-12-09T06:26:17Z",
"crn": "crn:[...]",
"encryption": "provider_managed",
"health_reasons": [],
"health_state": "ok",
"href": "https://us-south.iaas.cloud.ibm.com/v1/volumes/ccbe6fe1-5680-4865-94d3-687076a38293",
"id": "ccbe6fe1-5680-4865-94d3-687076a38293",
"iops": 1000,
"name": "my-volume-1",
"profile": {
"href": "https://us-south.iaas.cloud.ibm.com/v1/volume/profiles/general-purpose",
"name": "general-purpose"
},
"resource_group": {
(https://www.ibm.com/support/knowledgecenter/SSMNED_v10cloud/com.ibm.apic.devportal.doc/con_cmsportal_storefront.html)
* [Exploring the developer portal](https://www.ibm.com/support/knowledgecenter/SSMNED_v10cloud/com.ibm.apic.devportal.doc/capim_portal_APIs.html)
* [Registering an application](https://www.ibm.com/support/knowledgecenter/SSMNED_v10cloud/com.ibm.apic.devportal.doc/task_cmsportal_registerapps.html)
* [Viewing analytics about apps and APIs](https://www.ibm.com/support/knowledgecenter/SSMNED_v10cloud/com.ibm.apic.devportal.doc/capim_portal_analyticsparent.html)
<ETag>"0cbc6611f5540bd0809a388dc95a615b"</ETag>
<Size>4</Size>
<StorageClass>STANDARD</StorageClass>
</Contents>
</ListBucketResult>
Show more

Example request (continuation-token parameter)

This request lists the objects inside the "apiary" bucket with a continuation token specified.

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

Sample request (continuation-token parameter)

GET /apiary?list-type=2&max-keys=1&continuation-token=1dPe45g5uuxjyASPegLq80sQsZKL5OB2by4Iz_7YGR5NjiOENBPZXqvKJN6_PgKGVzZYTlws7qqdWaMklzb8HX2iDxxl72ane3rUFQrvNMeIih49MZ4APUjrAuYI83KxSMmfKHGZyKallFkD5N6PwKg HTTP/1.1
Authorization: 'AWS4-HMAC-SHA256 Credential={access-key}/{date}/{region}/s3/aws4_request,SignedHeaders=host;x-amz-date;,Signature={signature}'
x-amz-date: {timestamp}
Content-Type: text/plain
See the following example to list all documents in a database that match at least one of the specified keys:



* Curl
* Java
* Python
* Go
* Node



curl -H "Authorization: Bearer $API_BEARER_TOKEN" -X POST "$SERVICE_URL/orders/_all_docs" -H "Content-Type: application/json" --data '{
"include_docs": true,
"keys": ["somekey", "someotherkey"],
"limit": 10
}'

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.AllDocsResult;
import com.ibm.cloud.cloudant.v1.model.PostAllDocsOptions;

import java.util.Arrays;

Cloudant service = Cloudant.newInstance();

PostAllDocsOptions docsOptions =
new PostAllDocsOptions.Builder()
.db("orders")
.includeDocs(true)
.keys(Arrays.asList("somekey", "someotherkey"))
.limit(10)
.build();

AllDocsResult response =
service.postAllDocs(docsOptions).execute().getResult();

System.out.println(response);

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance()

response = service.post_all_docs(
db='orders',
include_docs=True,
keys=['somekey', 'someotherkey'],
limit=10
).get_result()

print(response)

postAllDocsOptions := service.NewPostAllDocsOptions(
"orders",
)
postAllDocsOptions.SetIncludeDocs(true)
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();

Response<ApiKey> response = service.updateApiKey(updateApiKeyOptions).execute();
ApiKey apiKey = response.getResult();
System.out.println(apiKey.toString());

api_key = iam_identity_service.update_api_key(
id=apikey_id,
if_match=apikey_etag,
description='This is an updated description'
).get_result()

print(json.dumps(api_key, indent=2))

updateAPIKeyOptions := iamIdentityService.NewUpdateAPIKeyOptions(apikeyID, apikeyEtag)
updateAPIKeyOptions.SetDescription("This is an updated description")

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

const params = {
id: apikeyId,
ifMatch: apikeyEtag,
description: 'This is an updated description',
};
* UI
* CLI
* API







 Listing and getting details of access requests 

List all access requests and get the details of an access request in your linked zone by using the UI, CLI, or API.



 Listing all access requests using the UI 

To list all access requests using the UI, take the following steps:



1. Navigate to the Zones section of your DNS Services instance, then select the DNS zones tab, which shows a list of all zones.
2. Check the Status column for pending requests.







 Getting the details of an access request using the UI 

To get the details of an access request using the UI, take the following steps:



1. Navigate to the Zones section of your DNS Services instance, then select the DNS zones tab.
2. Click the link in the Zone name column of the linked zone you want to view.







 Listing all access requests using the CLI 

To list an access request using the CLI, run the following command:

ibmcloud dns cross-account access-request ZONE_ID [-i, --instance INSTANCE] [--output FORMAT]

Where:



* ZONE_ID is the ID of the owner's zone.
* -i, --instance value is the instance name or ID. If not set, the context instance specified by ibmcloud dns instance-target INSTANCE is used.
* --output value specifies the output format. Currently, json is the only supported format.







 Getting the details of an access request using the CLI 

To get the details of an access request using the API, run the following command:

ibmcloud dns cross-account access-request ZONE_ID REQUEST_ID [-i, --instance INSTANCE] [--output FORMAT]

Where:



* ZONE_ID is the ID of the owner's zone.
* REQUEST_ID is the ID of the access request.
* -i, --instance value is the instance name or ID. If not set, the context instance specified by ibmcloud dns instance-target INSTANCE is used.
* --output value specifies the output format. Currently, json is the only supported format.
| [response.output.intents:intent::order,response.output.entities:entity::beverage] |





 Filtering v1 logs 

If your application is still using the v1 API, you can query and filter logs using the v1 /logs method. The filtering syntax is the same, but the structure of v1 logs and message requests is different. For more information, see [API Reference](https://cloud.ibm.com/apidocs/assistant-data-v1listlogs).

With the v1 /logs API, you can filter on the following fields:



* request.context.metadata.deployment
* request.context.system.assistant_id
* request.input.text
* response.entities
* response.input.text
* response.intents
* response.top_intent
* meta.message.entities_count
* workspace_id



Filtering on other fields is not currently supported.
Video tutorials 

The following videos help you to get provisioned and use IBM Cloud® Data Engine. The videos show you how to run queries, use the REST API, and how to connect to IBM Cloud® Object Storage through the command line.



  Get started 

The first video shows you how to provision IBM Cloud® Object Storage and IBM Cloud® Data Engine to get you started.





  Run queries 

The second video helps you to run a basic query from the console.





  Use sample queries, Notebooks, and REST API 

The following video gives a broader introduction to the service, introduces some of the sample queries in the UI, shows the use of real-life data, Notebooks, and REST API.





  Use the REST API 

The following video shows you how to use the REST API.





  Use the command line 

The next video shows you how to manage data files in an Object Storage instance through the command line.





  Run IBM Cloud® Data Engine end-to-end with the REST API 

The following video in this series shows you how to run Data Engine end-to-end with the REST API.





  In-depth overview 

Finally, the last video is an in-depth overview of IBM Cloud® Data Engine, offering an extensive introduction to the service.
: The name of the extension, as specified in the extension settings.

Operation
: The operation that was called.

Status
: The HTTP status code from the response. This code can help you determine if an error is being returned from the external service.

Request parameters
: The input parameters that were sent to the external API as part of the request.

Response properties
: The values of all properties included in the response from the external API. These are the values that are mapped to action variables after the call to the extension completes.

In the Request parameters and Response properties tables, long property names might be truncated to show only the last part of the JSON path. To see the complete path and property name, hover the mouse pointer over the property name in the table.
4. Click the Advanced tab in the extension inspector if you want to see the raw request and response data:



* The request is shown as a cURL command, which you can run at a command prompt or import into a tool such as [Postman](https://www.postman.com/). (For security reasons, the content of any Authorization header is not included.)
* The response is shown as the complete JSON data returned from the external API.









 Reconfiguring a missing extension 

An extension might become unavailable if someone removes it from the assistant on the Integrations page, or if the action is exported and then imported to a different assistant where the required extension is not configured. If this happens, any action step that calls the extension becomes invalid.

To correct the problem, follow these steps:



1. If necessary, recreate the extension using the same OpenAPI specification that was used before. (For more information, see [Building a custom extension](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-build-custom-extension).)
2. Make sure the extension has been added to the assistant. (For more information, see [Adding an extension to your assistant](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-add-custom-extension).)
3.
The previous Go example requires the following import block:

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



 Filter function req argument 

The req argument gives you access to aspects of the HTTP request by using the query property.

See the following example of supplying a req argument by using HTTP:

GET $SERVICE_URL/$DATABASE/_changes?filter=$DDOC/$FILTER_FUNCTION&status=new HTTP/1.1

See the following example of supplying a req argument:

The IBM Cloudant SDKs currently do not support status option for _changes request.

curl "$SERVICE_URL/$DATABASE/_changes?filter=$DDOC/$FILTER_FUNCTION&status=new"

See the following example filter by using a supplied req argument:

function(doc, req){
// we need only mail documents
if (doc.type != 'mail'){
return false;
}
// we're interested only in new ones
if (doc.status != req.query.status){
return false;
}
return true; // passed!
}







 Predefined filter functions 

A number of predefined filter functions are available:

[_design](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-design-documentsthe-_design-filter)
: Accepts only changes to design documents.

[_doc_ids](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-design-documentsthe-_doc_ids-filter)
: Accepts only changes for documents whose ID is specified in the doc_ids parameter or supplied JSON document.

[_selector](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-design-documentsthe-_selector-filter)
"requestURI":"/api/v2/keys/76c2c9cb-9095-5a24-811b-0ef4b24ac4d5?action=rotateu0026include_resource=true",
"instanceId":"fd692647-43d0-4699-9f83-f39a54b1327b"
},
"dataEvent":true,
"saveServiceCopy":true,
"correlationId":"ef56e7ed-abf5-4da4-bbf1-ac0d381891fd",
"logSourceCRN":"crn:v1:bluemix:public:kms:us-south:a/a12333e9bd28461a8c92385628efac9f:fd692647-43d0-4699-9f83-f39a54b1327b::"
}
Show more

This event shows the updated volume after a successful key rotation:

{
"payload": {
"id": "496cbc9b-3758-4eff-bc7d-f71a51be0e1d",
"eventTime": "2020-06-10T17:27:24.81+0000",
"action": "is.volume.volume.update",
"outcome": "success",
"message": "Block Storage for VPC: update volume my-encrypted-volume1",
"initiator": {
"id": "keyreact",
"typeURI": "service/security/account/user",
"name": "",
"host": {
"address": "192.0.2.0/24172",
"agent": "grpc-go/1.22.1"
},
"credential": {
"type": "token"
}