vania-janet/multiturn-rag-retrieval-data huggingface dataset:
You can click the icon to highlight the path that your assistant traversed through the dialog tree to arrive at the response. See [Building a dialog](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-tasksdialog-tasks-test) for details.

New API version
: The current API version is now 2018-02-16. This version introduces the following changes:



* A new include_audit parameter is now supported on most GET requests. This is an optional boolean parameter that specifies whether the response should include the audit properties (created and updated timestamps). The default value is false. (If you are using an API version earlier than 2018-02-16, the default value is true.) For more information, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1).
* Responses from API calls using the new version include only properties with non-null values.
* The output.nodes_visited and output.nodes_visited_details properties of message responses now include nodes with the following types, which were previously omitted:
* Nodes with type=response_condition
* Nodes with type=event_handler and event_name=input







 9 February 2018 

Dutch system entities (Beta)
: Dutch language support has been enhanced to include the availability of [System entities](https://cloud.ibm.com/docs/assistant?topic=assistant-system-entities) in beta release. See [Supported languages](https://cloud.ibm.com/docs/assistant?topic=assistant-language-support) for details.





 29 January 2018 

Watson Assistant REST API now supports new request parameters
: 

* Use the append parameter when updating a workspace to indicate whether the new workspace data should be added to the existing data, rather than replacing it. For more information, see [Update workspace](https://cloud.ibm.com/apidocs/assistant/assistant-v1?curl=update-workspace).
Querying Edge Functions metrics with GraphQL 

This example uses the GraphQL Analytics API to query for Edge Functions Metrics over a specified time period. You can query up to one week of data for dates up to three months ago.

The following API call requests an Edge Functions script's metrics over a one day period, and outputs the requested fields. Adjust the datetimeStart, datetimeEnd, accountTag, and scriptName variables as needed.



 The API call 

PAYLOAD='{ "query":
"query GetEdgeFunctionsAnalytics($accountTag: string, $datetimeStart: string, $datetimeEnd: string, $scriptName: string) {
viewer {
accounts(filter: {accountTag: $accountTag}) {
workersInvocationsAdaptive(limit: 100, filter: {
scriptName: $scriptName,
datetime_geq: $datetimeStart,
datetime_leq: $datetimeEnd
}) {
sum {
subrequests
requests
errors
}
quantiles {
cpuTimeP50
cpuTimeP99
}
dimensions{
datetimeHour
scriptName
status
}
}
}
}
}",
"variables": {
"accountTag": "90f518ca7113dc0a91513972ba243ba5",
"datetimeStart": "2020-05-04T00:00:00.000Z",
"datetimeEnd": "2020-05-04T00:00:00.000Z",
"scriptName": "edge-function-subrequest-test-client"
}
}'

curl -X POST -H "Content-Type: application/json" -H "Authorization: IBM IAM TOKEN" --data "$(echo $PAYLOAD)" https://api.cis.cloud.ibm.com/v1/<crn>/zones/<zoneid>/graphql
Show more
Viewing details of an endpoint gateway using the API 

To view details of an endpoint gateway by using the API, follow these steps:



1. Set up your [API environment](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environmentapi-prerequisites-setup).
2. Store the following values in variables to be used in the API command:

export EndpointGatewayId=<endpoint_gateway_id>
3. When the variables are initiated, view details of the endpoint gateway:

curl -sH "Authorization:${iam_token}"
"$vpc_api_endpoint/v1/endpoint_gateways/$EndpointGatewayId?version=$api_version&generation=2"
Advanced status search 

You can search across all tabs on the [Status page](https://cloud.ibm.com/status), but did you know that you can build URL search values by using query parameters from outside the console?

The following list includes examples of URL search options:



*  Load the page with the Status tab selected: console.cloud.ibm.com/status?selected=status
*  Load the page with the Planned maintenance tab selected: console.cloud.ibm.com/status?selected=maintenance
*  Load the page with the Security bulletin tab selected: console.cloud.ibm.com/status?selected=security
*  Load the page with the Announcements tab selected: console.cloud.ibm.com/status?selected=announcement
*  Load the page with a search query entered: console.cloud.ibm.com/status?selected=<selected>&query=<query>
*  Land on the page with filters selected. For example, you can set the geographic location to North America by using the following URL search: console.cloud.ibm.com/status?selected=status&region=na
*  Use unique notification identifiers as a search parameter to go directly to the details for the notification. For example, query=INC1000001 targets items with the ID: INC1000001. In this example, INC1000001 is the case number for a maintenance notification.





  URL query filters: 

The following table provides information on URL query filters that you can use to search across all tabs on the status page.



Table 1. URL query filters

 URL Query Parameter  Description                                                                                                                  Values                                                                                                                                                 

 ?type                A filter that applies only to the Status tab. Use the ?type query to filter the Status tab by incidents or maintenance.      =incident, =maintenance                                                                                                                                
 ?region              Filter the page by geographic location.                                                                                      =na, =eu, =sa, =ap                                                                                                                                     
 ?component           Filter the page by IBM Cloud components. For example, you might filter by a service you are interested in.                   Applies to most global catalog IDs; for example, ?component=iotf-service filters the page and display events that affect Internet of Things Platform   



You can always use the Filter by filters, and then copy or bookmark the URL query that is generated. The filters are displayed in your URL and can help you build future queries.
If you only see one Plan, return to API Connect and ensure that your Product changes have been saved, staged, and published to the Sandbox Catalog.

![plans.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/plans.png)
3. Click to Subscribe to the Demo Plan, and select the application you just registered. Now, your application can call the APIs associated with this Plan, at a rate of up to one API call every minute.



We are ready to test this behavior and observe what happens when the application exceeds the specified rate.





 Calling a rate-limited API 



1. On the Weather Provider API Product page in the Developer Portal, click the API link.

![weatherproviderapi.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/weatherproviderapi.png)
2. The page refreshes to display details about the API, and to provide a place for testing the API. This is how your API consumers will discover and test out your API as well.
3. Locate the first Try this operation section.
4. To test the GET /current operation, enter your application's client secret and a valid US zip code.
5. Click the Call operation button. The response displays the 200 OK status and data about the current weather in the specified zip code.

![trythisop-1.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/trythisop-1.png)
The following example shows how the output object is represented in the dialog JSON editor:

{
"output": {
"generic": [
{
"values":
{
"text": "This is my response text."
}
],
"response_type": "text",
"selection_policy": "sequential"
}
]
}
}



In the resulting API /message response, the text response is formatted as follows:

{
"text": "This is my response text.",
"response_type": "text"
}

There are response types other than a text response that you can define. See [Responses](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overviewdialog-overview-responses) for more details.

For more information about the /message API call, see the [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v2).

For information about how to refer to these message objects within a conversation, see [Expressions for accessing objects](https://cloud.ibm.com/docs/assistant?topic=assistant-expression-language).



 Viewing API call details 

As you test your conversation, you might want to know what the underlying API calls look like that are being returned from the service. You can use the developer tools provided by your web browser to inspect them.

From Chrome, for example, open the developer tools. Open the Network tool. 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. It also lists 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.]
* URL - https://USERNAME:APIKEY@api.softlayer.com/rest/v3.1/SoftLayer_Product_Order/placeOrder
* Type - POST
* Request body -

{
"parameters":[{
"complexType": "SoftLayer_Container_Product_Order_Network_Storage_AsAService",
"packageId": 531,
"duplicateOriginVolumeId":<PrimaryId>,
"isDependentDuplicateFlag": 0,
"prices": {"id": 19497}, {"id": 16479}, {"id": 12931}, {"id": 15749}, {"id":10407}],
"quantity": 1,
"osFormatType":{
"keyName": "LINUX"
},
"location": 2,
"volumeSize":23
}]
}



To order a dependent duplicate for a Performance (custom IOPS) volume, make a POST /SoftLayer_Product_Order/placeOrder call like the following REST API example.



* URL - https://USERNAME:APIKEY@api.softlayer.com/rest/v3.1/SoftLayer_Product_Order/placeOrder
* Type - POST
* Request body -

{
"parameters":[{
"complexType": "SoftLayer_Container_Product_Order_Network_Storage_AsAService",
"packageId": 531,
"duplicateOriginVolumeId":1327277,
"isDependentDuplicateFlag": 1,
"prices": {"id": 15751}, {"id": 19487}, {"id": 18983}, {"id": 15749}, {"id":10407}],
"quantity": 1,
"iops":454,
"osFormatType":{
"keyName": "LINUX"
},
For more information, see the [API Reference](https://cloud.ibm.com/apidocs/assistant/assistant-data-v2message-stateless).

Architecture improvements
: The Skill-conversation microservice was removed. The microservice used to convert v2 API calls to v1 format and the other way around. The conversion is now done within the Store microservice. Reimplementing this function in the Store increased the overall speed with which v2 API requests are processed. The Spellchecker and CLU Embedding microservices were added. The word embeddings that are used by the language understanding pipeline (training, TAS, ED-MM) now are stored in the CLU Embedding microservice instead of MongoDB. For more information, see [Service architecture](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-architecture).

Slot prompt JSON editor
: You can now use the context or JSON editors for the slot response field where you define the question that your assistant asks to get information it needs from the customer. For more information about slots, see [Gathering information with slots](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-dialog-slots).

Bug fixes
: Multiple bug fixes were made.

Features not included
: This release does not include the following features, which are available for cloud instances at the time of this release:



* There are no metrics or analytics capabilities. Therefore, the Analytics page is not included in the product user interface.
* There are no deployment connectors or built-in integrations available. You must build a custom client application that can host the assistant. As a result, the Integrations page is not included in the product user interface.
* The @sys-person and @sys-location system entities are not supported and the new version of the numeric system entities is not available.
* There is no search function in the pages of the product.
* You cannot use the Activity Tracker service to track user actions.
![defaultoverview.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/defaultoverview.png)
4. Use the search bar to filter the data shown. You can also select a different time filter and/or auto-refresh rate. The visualizations update to reflect your selections.



There are other dashboards that are provided out of the box for you.



5. Click the folder icon to load a saved dashboard, and select api_default from the dropdown list.

![api_default.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/api_default.png)



This dashboard has a different set of visualizations that display API status, errors, response times, total number of calls, and calls per day.

![sandbox-api_default.png](https://cloud.ibm.com/docs-content/v1/content/78bb71851d95d7580503eb9ba10cf3ae31490ade/apiconnect/tutorials/images/sandbox-api_default.png)





 Activity 2: Viewing event details 

Visualizations are a great way to get a useful overview of data, but you also need a way to navigate into the event records that populate the charts.



1. Hover over the arrow icon in the bottom-left corner of any visualization. A small arrow appears.
2. Click the arrow to see a table of the data that is used in that visualization.
3. Click the View Events label to navigate into the individual event details for up to 100 records.
[Learn more](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-service_plans).
* Check that your user ID has permissions to launch the web UI, view or manage service keys, and view logs. [Learn more](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-view_logs).
* Check that the logging instance has the export feature enabled. [Learn more](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-export_config).







 Export API 

Use ENDPOINT/v2/export?QUERY_PARAMETERS" -u SERVICE_KEY: to export logs.

ENDPOINT represents the entry point to the service. Each region has a different URL. To export logs from a logging instance, see [Endpoints](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-endpoints).

QUERY_PARAMETERS are parameters that define the filtering criteria that is applied to the export request.

SERVICE_KEY is an API key that you must use to validate your credentials with the logging instance. For more information on how to get a service key, see [Service keys by using the API](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-service_keysservice_keys_api).

Add : after SERVICE_KEY.





 Query parameters 

You can define query parameters to refine the logs that you want to export.

The following table lists the query parameters that you can set:



Query parameters

 Query parameter Type Status Description 

 from int32 Required Start time. Set as UNIX timestamp in seconds or Javascript (milliseconds). 
 to int32 Required End time. Set as UNIX timestamp in seconds or Javascript (milliseconds). 
 size int32 Optional Number of log lines to include in each page of the export. The maximum and default is 10000. 
 hosts string Optional Comma-separated list of hosts. 
 apps string Optional Comma-separated list of applications.
PUT /_api/v2/user/capacity/throughput cloudantnosqldb.capacity-throughput.write 
 GET /_api/v2/user/current/throughput cloudantnosqldb.current-throughput.read 
 GET /_api/v2/user/activity_tracker/events cloudantnosqldb.activity-tracker-event-types.read 
 POST /_api/v2/user/activity_tracker/events cloudantnosqldb.activity-tracker-event-types.write 
 POST /_api/v2/api_keys cloudantnosqldb.sapi.apikeys 
 GET/POST /_api/v2/user/config/cors/ cloudantnosqldb.sapi.usercors 
 GET/PUT /_api/v2/user/plan cloudantnosqldb.sapi.userplan 
 GET /_api/v2/user/ccm_diagnostics cloudantnosqldb.sapi.userccmdiagnostics 
 GET /_api/v2/user/last_activity cloudantnosqldb.sapi.lastactivity 
 GET /_api/v2/support/tickets/$CASEID/files/$ATTACHMENTID cloudantnosqldb.sapi.supportattachments 
 GET/POST /_api/v2/support/tickets cloudantnosqldb.sapi.supporttickets 
 GET/PUT/DELETE /_api/v2/support/tickets/$CASEID cloudantnosqldb.sapi.supporttickets 
 GET /_api/v2/user cloudantnosqldb.sapi.userinfo 
 GET /_api/v2/usage/data_volume and /_api/v2/usage/$YEAR/$MONTH cloudantnosqldb.sapi.usage-data-volume 
 GET/HEAD / cloudantnosqldb.account-meta-info.read 
 GET/HEAD /_active_tasks cloudantnosqldb.account-active-tasks.read 
 GET/HEAD /_replicator cloudantnosqldb.replicator-database-info.read
[API reference](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi)



* [Retrieve your Kubernetes configuration with REST API](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-rest)



* [Authenticate with Cloud Identity and Access Management](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-iam)
* [Determine the GUID of your Code Engine project](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-guid)
* [Query the IBM Code Engine API](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-query-api)



* [Retrieving your Kubernetes configuration with the Code Engine CLI](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-cli)
* [Custom resource definition (CRD)](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-crd)



* [Batch CRD methods](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-crd-batch)
* [Serving CRD methods](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-crd-serving)
* [Source-to-image CRD methods](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-crd-s2i)
* [Subscription CRD methods](https://cloud.ibm.com/docs/codeengine?topic=codeengine-apiapi-crd-subscription)
index='freetext',
query='country:US',
limit=5,
)
response = service.post_search(request_params).get_result()

while len(response'rows']) > 0:
documents = response'rows']
print(json.dumps(documents, indent=2))
 The bookmark of the next request becomes the bookmark of this response
request_params'bookmark'] = response'bookmark'] !!!
response = service.post_search(request_params).get_result()
searchOptions := service.NewPostSearchOptions(
"cities",
"search",
"freetext",
"country:US"
)
searchOptions.SetLimit(5)

searchResult, _, err := service.PostSearch(searchOptions)
if err = nil {
panic(err)
}
for len(searchResult.Rows) > 0 {
documents := searchResult.Rows
b, err := json.MarshalIndent(documents, "", " ")
if err = nil {
panic(err)
}
fmt.Printf(string(b))
// The bookmark of the next request becomes the bookmark of this response
searchOptions.Bookmark = searchResult.Bookmark
searchResult, _, err = service.PostSearch(searchOptions)
if err = nil {
panic(err)
}
}
The previous Go example requires the following import block: import (
"encoding/json"
"fmt"
"github.com/IBM/cloudant-go-sdk/cloudantv1"
)
{
"total_rows": 65,
"rows":
deduplicate N/A Not supported in v2. 
 similar similar The format changed in v2. The similar:true parameter changed to similar.enable:true. The document_ids and fields parameters changed from strings to string arrays. The document_ids parameter now is required if enabled is true. 
 bias N/A Not supported in v2. 











 Training data 

You can use the v1 training data API to work with two related objects:



* trained queries
* examples that are used to train the queries



These two objects have separate API endpoints in v1. In v2, the examples that are used to train each query are provided together with the query and only one endpoint is used to work with the training data.

For example, to add a trained query and its training example documents in v2, you use the request POST /v2/projects/{project_id}/training_data/queries and pass the query and all examples in the payload of one call. Similarly, if you want to update one example in the training set in v2, you must pass the query and the modified example (along with all of the other examples) to the v2 update endpoint. In v1, to update the example information, you use the update example endpoint to modify one example only.

Another important difference between v1 and v2 is that in v1, the trained model is associated with a particular collection. In v2, the trained model is associated with a project. You can use the data from multiple collections within a project to train a relevancy model. When you create or update training examples in v2, the API requires the collection_id for the collection where the document is stored.



Training data API support details

 Action v1 API v2 API 

 List training data [GET /v1/environments/{environment_id}/collections/{collection_id}/training_data](https://cloud.ibm.com/apidocs/discoverylisttrainingdata) [GET /v2/projects/{project_id}/training_data /queries](https://cloud.ibm.com/apidocs/discovery-datalisttrainingqueries)
* [Requests and responses](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-request)



* [Example 1: Generating an HTML response from a Function](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-request1)
* [Example 2: Setting a response code and response header](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-request2)
* [Example 3: Generating a plain text response from a Function](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-request3)



* [Error handling and debugging](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-error)
* [Function data input/output characteristics](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-data)
* [Options for creating Functions](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-options)



* [Memory and CPU](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-combo)
* [Creating and running your app with environment variables](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-envvar)
* [Creating and running your Function when using secrets and configmaps](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-secconfigmap)



* [Considerations for Functions quotas](https://cloud.ibm.com/docs/codeengine?topic=codeengine-fun-workfunctions-quotas)