Introduction

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated dialog tools to create conversation flows between your apps and your users.

The code examples on this tab use the client library that is provided for Java.

Maven

<dependency>
  <groupId>com.ibm.watson.developer_cloud</groupId>
  <artifactId>java-sdk</artifactId>
  <version>6.11.0</version>
</dependency>

Gradle

compile 'com.ibm.watson.developer_cloud:java-sdk:6.11.0'

GitHub

The code examples on this tab use the client library that is provided for Node.js.

Installation

npm install --save watson-developer-cloud

GitHub

The code examples on this tab use the client library that is provided for Python.

Installation

pip install --upgrade "watson-developer-cloud>=2.5.1"

GitHub

The code examples on this tab use the client library that is provided for Ruby.

Installation

gem install ibm_watson

GitHub

The code examples on this tab use the client library that is provided for Go.

go get -u github.com/watson-developer-cloud/go-sdk/...

GitHub

Authentication

IBM Cloud is migrating to token-based Identity and Access Management (IAM) authentication.

  • With some service instances, you authenticate to the API by using IAM. You can pass either a bearer token in an Authorization header or an API key. Tokens support authenticated requests without embedding service credentials in every call. API keys use basic authentication. Learn more about IAM.

    If you pass in the apikey, the SDK manages the lifecycle of the tokens. If you pass a token, you maintain the token lifecycle. Learn more about IAM authentication with the SDK.

  • In other instances, you authenticate by providing the username and password for the service instance. For more information, see Service credentials for Watson services.

To find out which authentication to use, view the service credentials by clicking the service instance on the Dashboard.

You can also access the service credentials from the Watson Assistant tool:

  • To see the service credentials and the assistant ID of an assistant, go to the Assistants page and select View API Details from the menu of an assistant tile. (The assistant ID is used only by the v2 API.)
  • To see the service credentials and the workspace ID of a workspace, go to the Skills page and select View API Details from the menu of a skill tile. (The workspace ID is used only by the v1 API.)

The "username" and "password" in the service credentials are different from your IBM Cloud account IBMid and password.

IAM authentication. Replace {apikey} and {url} with your service credentials.

curl -u "apikey:{apikey}" "{url}/{method}"

Basic authentication. Replace {username}, {password}, and {url} with your service credentials.

curl -u "{username}:{password}" "{url}/{method}"

SDK managing the IAM token. Replace {apikey}, {version} and {url}.

IamOptions options = new IamOptions.Builder()
    .apiKey("{apikey}")
    .build();

Assistant assistant = new Assistant("{version}", options);

assistant.setEndPoint("{url}");

Basic authentication. Replace {username}, {password}, `, and{url}`. Use either of the two constructors.

Assistant assistant = new Assistant(
    "{version}",
    "{username}",
    "{password}");

assistant.setEndPoint("{url}");

or

Assistant assistant = new Assistant("{version}");
assistant.setUsernameAndPassword("{username}","{password}");

assistant.setEndPoint("{url}");

SDK managing the IAM token. Replace {apikey}, {version} and {url}.

var AssistantV1 = require('watson-developer-cloud/assistant/v1');

var assistant = new AssistantV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  url: '{url}'
});

Basic authentication. Replace {username}, {password}, `, and{url}`.

var  = require('watson-developer-cloud/assistant/v1');

var assistant = new AssistantV1({
  version: '{version}',
  username: '{username}',
  password: '{password}',
  url: '{url}'
});

SDK managing the IAM token. Replace {apikey}, {version} and {url}.

from watson_developer_cloud import AssistantV1

assistant = AssistantV1(
    version='{version}',
    iam_apikey='{apikey}',
    url='{url}'
)

Basic authentication. Replace {username}, {password}, `, and{url}`.

from watson_developer_cloud import AssistantV1

assistant = AssistantV1(
    version='{version}',
    username='{username}',
    password='{password}',
    url='{url}'
)

SDK managing the IAM token. Replace {apikey}, {version} and {url}.

require "ibm_watson"

assistant = IBMWatson::AssistantV1.new(
  version: "{version}",
  iam_apikey: "{apikey}",
  url:"{url}"
)

Basic authentication. Replace {username}, {password}, `, and{url}`.

require "ibm_watson"

assistant = IBMWatson::AssistantV1.new(
  version: "{version}",
  username: "{username}",
  password: "{password}",
  url:"{url}"
)

SDK managing the IAM token. Replace {apikey}, {version} and {url}.

import "github.com/watson-developer-cloud/go-sdk/assistantv1"

assistant, assistantErr := assistantv1.NewAssistantV1(&assistantv1.AssistantV1Options{
  Version: "{version}",
  IAMApiKey: "{apikey}",
  URL: "{url}",
})

Basic authentication. Replace {username}, {password}, `, and{url}`.

import "github.com/watson-developer-cloud/go-sdk/assistantv1"

assistant, assistantErr := assistantv1.NewAssistantV1(&assistantv1.AssistantV1Options{
  Version: "{version}",
  Username: "{username}",
  Password: "{password}",
  URL: "{url}",
})

Service endpoint

The service endpoint is based on the location of the service instance. For example, when Watson Assistant is hosted in Frankfurt, the base URL is https://gateway-fra.watsonplatform.net/assistant/api. The URL might also be different when you use IBM Cloud Dedicated.

To find out which URL to use, view the service credentials by clicking the service instance on the Dashboard.

Use that URL in your requests to Watson Assistant.

Set the correct service URL by calling the setEndPoint() method of the service instance.

Set the correct service URL by calling the url parameter when you create the service instance.

Set the correct service URL by calling the url parameter when you create the service instance or by calling the set_url() method of the service instance.

Set the correct service URL by calling the url parameter when you create the service instance or by calling the url= method of the service instance.

Set the correct service URL by the URL parameter when you create the service instance or by calling the SetURL= method of the service instance.

Service endpoints by location:

  • Dallas: https://gateway.watsonplatform.net/assistant/api
  • Washington, DC: https://gateway-wdc.watsonplatform.net/assistant/api
  • Frankfurt: https://gateway-fra.watsonplatform.net/assistant/api
  • Sydney: https://gateway-syd.watsonplatform.net/assistant/api
  • Tokyo: https://gateway-tok.watsonplatform.net/assistant/api
  • London: https://gateway-lon.watsonplatform.net/assistant/api

All locations might not support Watson Assistant. For details, see Service availability.

Dallas API endpoint

https://gateway.watsonplatform.net/assistant/api

Your service instance might not use this URL

Default URL

https://gateway.watsonplatform.net/assistant/api

Example for the Washington, DC location

Assistant assistant = new Assistant("{version}");
assistant.setEndPoint("https://gateway-wdc.watsonplatform.net/assistant/api");

Default URL

https://gateway.watsonplatform.net/assistant/api

Example for the Washington, DC location

var AssistantV1 = require('watson-developer-cloud/assistant/v1');

var assistant = new AssistantV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  url: 'https://gateway-wdc.watsonplatform.net/assistant/api'
});

Default URL

https://gateway.watsonplatform.net/assistant/api

Examples for the Washington, DC location in the constructor and after instantiation

assistant = AssistantV1(
  version='{version}',
  iam_apikey='{apikey}',
  url='https://gateway-wdc.watsonplatform.net/assistant/api'
)

or

assistant.set_url('https://gateway-wdc.watsonplatform.net/assistant/api')

Default URL

https://gateway.watsonplatform.net/assistant/api

Examples for the Washington, DC location in the constructor and after instantiation

assistant = IBMWatson::.new(
  version: "{version}",
  api_key: "{apikey}",
  url: "https://gateway-wdc.watsonplatform.net/assistant/api"
)

or

assistant.url = "https://gateway-wdc.watsonplatform.net/assistant/api"

Default URL

https://gateway.watsonplatform.net/assistant/api

Examples for the Washington, DC location in the constructor and after instantiation

assistant, assistantErr := assistantv1.NewAssistantV1(&assistantv1.AssistantV1Options{
  Version: "{version}",
  IAMApiKey: "{apikey}",
  URL: "https://gateway-wdc.watsonplatform.net/assistant/api",
})

or

assistant.SetURL("https://gateway-wdc.watsonplatform.net/assistant/api")

Versioning

API requests require a version parameter that takes a date in the format version=YYYY-MM-DD. When we change the API in a backwards-incompatible way, we release a new version date.

Send the version parameter with every API request. The service uses the API version for the date you specify, or the most recent version before that date. Don't default to the current date. Instead, specify a date that matches a version that is compatible with your app, and don't change it until your app is ready for a later version.

Specify the version to use on API requests with the version parameter when you create the service instance. The service uses the API version for the date you specify, or the most recent version before that date. Don't default to the current date. Instead, specify a date that matches a version that is compatible with your app, and don't change it until your app is ready for a later version.

This documentation describes the current version of Watson Assistant, 2018-09-20. In some cases, differences in earlier versions are noted in the descriptions of parameters and response models.

Error handling

The Watson Assistant service uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error that cannot be resolved by the user. Response codes are listed with the method.

ErrorResponse

Name Description
code
integer
The HTTP response code.
error
string
General description of an error.
errors
ErrorDetail[]
Collection of specific constraint violations associated with the error.

ErrorDetail

Name Description
message
string
Description of a specific constraint violation.
path
string
The location of the constraint violation.

The Java SDK generates an exception for any unsuccessful method invocation. All methods that accept an argument can also throw an IllegalArgumentException.

Exception Description
IllegalArgumentException An illegal argument was passed to the method.

When the Java SDK receives an error response from the Watson Assistant service, it generates an exception from the com.ibm.watson.developer_cloud.service.exception package. All service exceptions contain the following fields:

Field Description
statusCode The HTTP response code returned.
message A message that describes the error.

When the Node SDK receives an error response from the Watson Assistant service, it creates an Error object with information that describes the error that occurred. This error object is passed as the first parameter to the callback function for the method. The contents of the error object are as shown in the following table.

Error

Field Description
code The HTTP response code returned.
message A message that describes the error.

The Python SDK generates an exception for any unsuccessful method invocation. When the Python SDK receives an error response from the Watson Assistant service, it generates a WatsonApiException that contains the following fields.

Field Description
code The HTTP response code returned.
message A message that describes the error.
info A dictionary of additional information about the error.

When the Ruby SDK receives an error response from the Watson Assistant service, it generates a WatsonApiException that contains the following fields.

Field Description
code The HTTP response code returned.
message A message that describes the error.
info A dictionary of additional information about the error.

The Go SDK generates an error for any unsuccessful service instantiation and method invocation. You can check for the error immediately. The contents of the error object are as shown in the following table.

Error

Field Description
code The HTTP response code returned.
message A message that describes the error.

Example error handling

try {

    // Invoke a Watson Assistant method
} catch (NotFoundException e) {

    // Handle Not Found (404) exception
} catch (RequestTooLargeException e) {

    // Handle Request Too Large (413) exception
} catch (ServiceResponseException e) {

    // Base class for all exceptions caused by error responses from the service
    System.out.println("Service returned status code " + e.getStatusCode() + ": " + e.getMessage());
}

Example error handling

assistant.method(params,
  function (err, response) {
    // The error will be the first argument of the callback
    if (err.code == 404) {

      // Handle Not Found (404) error
    } else if (err.code == 413) {

      // Handle Request Too Large (413) error
    } else {
      console.log('Unexpected error: ', err.code);
      console.log('error:', err);
    }
  });

Example error handling

from watson_developer_cloud import WatsonApiException
try:
    # Invoke a Watson Assistant method
except WatsonApiException as ex:
    print "Method failed with status code " + str(ex.code) + ": " + ex.message

Example error handling

require "ibm_watson"
begin
  # Invoke a Watson Assistant method
rescue WatsonApiException => ex
  print "Method failed with status code #{ex.code}: #{ex.error}"
end

Example error handling

import "github.com/watson-developer-cloud/go-sdk/assistantv1"

// Instantiate a service
assistant, assistantErr := assistantv1.NewAssistantV1(&assistantv1.AssistantV1Options{})

// Check for error
if assistantErr != nil {
  panic(assistantErr)
}

// Call a method
response, responseErr := assistant.methodName(&methodOptions)

// Check for error
if responseErr != nil {
  panic(responseErr)
}

Data handling

Additional headers

Some Watson services accept special parameters in headers that are passed with the request. You can pass request header parameters in all requests or in a single request to the service.

To pass header parameters with every request, use the setDefaultHeaders method of the service object. See Data collection for an example use of this method.

To pass header parameters in a single request, use the addHeader method as a modifier on the request before you execute the request.

To pass header parameters with every request, specify the headers parameter when you create the service object. See Data collection for an example use of this method.

To pass header parameters in a single request, use the headers method as a modifier on the request before you execute the request.

To pass header parameters with every request, specify the set_default_headers method of the service object. See Data collection for an example use of this method.

To pass header parameters in a single request, include headers as a dict in the request.

To pass header parameters with every request, specify the add_default_headers method of the service object. See Data collection for an example use of this method.

To pass header parameters in a single request, specify the headers method as a chainable method in the request.

To pass header parameters with every request, specify the SetDefaultHeaders method of the service object. See Data collection for an example use of this method.

To pass header parameters in a single request, specify the Headers as a map in the request.

Example header parameter in a request

ReturnType returnValue = assistant.methodName(parameters)
        .addHeader("Custom-Header", "{header_value}")
        .execute();

Example header parameter in a request

assistant.methodName({
  parameters,
  headers: {
    'Custom-Header': '{header_value}'
  }
},
  function (err, response) {
    if (err) {
      console.log('error:', err);
    } else {
      console.log(response);
    }
  }
);

Example header parameter in a request

response = assistant.methodName(
    parameters,
    headers = {
        'Custom-Header': '{header_value}'
    })

Example header parameter in a request

response = assistant.headers(
  "Custom-Header" => "{header_value}"
).methodName(parameters)

Example header parameter in a request

response, _ := assistantv1.methodName(
  &methodOptions{
    Headers: map[string]string{
      "Accept": "application/json",
    },
  },
)

Response details

The Watson Assistant service might return information to the application in response headers.

To access information in the response headers, use one of the request methods that returns details with the response: executeWithDetails(), enqueueWithDetails(), or rxWithDetails(). These methods return a Response<T> object, where T is the expected response model. Use the getResult() method to access the response object for the method, and use the getHeaders() method to access information in response headers.

Example request to access response headers

Response<ReturnType> response = assistant.methodName(parameters)
        .executeWithDetails();
// Access response from methodName
ReturnType returnValue = response.getResult();
// Access information in response headers
Headers responseHeaders = response.getHeaders();

To access information in the response headers, specify the headers attribute on the third parameter (response) that is passed to the callback function.

Example request to access response headers

assistant.methodName({
  parameters
},
  function (err, result, response) {
    if (err) {
      console.log('error:', err);
    } else {
      console.log(response.headers);
    }
  }
);

The return value from all service methods is a DetailedResponse object. To access information in the result object or response headers, use the following methods.

DetailedResponse

Method Description
get_result() Returns the response for the service-specific method.
get_headers() Returns the response header information.
get_status_code() Returns the HTTP status code.

Example request to access response headers

assistant.set_detailed_response(True)
response = assistant.methodName(parameters)
// Access response from methodName
print(json.dumps(response.get_result(), indent=2))
// Access information in response headers
print(response.get_headers())
// Access HTTP response status
print(response.get_status_code())

The return value from all service methods is a DetailedResponse object. To access information in the response object, use the following properties.

DetailedResponse

Property Description
result Returns the response for the service-specific method.
headers Returns the response header information.
status Returns the HTTP status code.

Example request to access response headers

response = assistant.methodName(parameters)
# Access response from methodName
print response.result
# Access information in response headers
print response.headers
# Access HTTP response status
print response.status

The return value from all service methods is a DetailedResponse object. To access information in the result object or response headers, use the following methods.

DetailedResponse

Method Description
GetResult() Returns the response for the service-specific method.
GetHeaders() Returns the response header information.
GetStatusCode() Returns the HTTP status code.

Example request to access response headers

import "github.com/watson-developer-cloud/go-sdk/core"
response, _ := assistantv1.methodName(&methodOptions{})

// Access result
core.PrettyPrint(response.GetResult(), "Result ")

// Access response headers
core.PrettyPrint(response.GetHeaders(), "Headers ")

// Access status code
core.PrettyPrint(response.GetStatusCode(), "Status Code ")

Data labels

You can remove customer data if you associate the customer and the data when you send the information to a service. First you label the data with a customer ID, and then you can delete the data by the ID.

  • Use the X-Watson-Metadata header to associate a customer ID with the data. By adding a customer ID to a request, you indicate that it contains data that belongs to that customer.

    Specify a random or generic string for the customer ID. Do not include personal data, such as an email address. Pass the string customer_id={id} as the argument of the header.

  • Use the Delete labeled data method to remove data that is associated with a customer ID.

Labeling data is used only by methods that accept customer data. For more information about Watson Assistant and labeling data, see Information security.

For more information about how to pass headers, see Additional headers.

Data collection

By default, all Watson services log requests and their results. Logging is done only to improve the services for future users. The logged data is not shared or made public.

To prevent IBM usage of your data for an API request, set one of the following options.

  • To prevent IBM from accessing user input and Watson responses, set the X-Watson-Learning-Opt-Out header parameter to true when sending a message. You must set the header on each message request that you do not want IBM to access for general service improvements.
  • To prevent IBM from accessing user input and Watson responses, set the X-Watson-Learning-Opt-Out header parameter to true when sending a message. You can set the header by using the setDefaultHeaders method of the service object object you use to send message requests that you do not want to be accessed.
  • To prevent IBM from accessing user input and Watson responses, set the X-Watson-Learning-Opt-Out header parameter to true when sending a message. You can set the header by using the headers parameter when you create the service object you use to send message requests that you do not want to be accessed.
  • To prevent IBM from accessing user input and Watson responses, set the X-Watson-Learning-Opt-Out header parameter to true when sending a message. You can set the header by using the set_default_headers method of the service object you use to send message requests that you do not want to be accessed.
  • To prevent IBM from accessing user input and Watson responses, set the X-Watson-Learning-Opt-Out header parameter to true when sending a message. You can set the header by using the add_default_headers method of the service object you use to send message requests that you do not want to be accessed.
  • To prevent IBM from accessing user input and Watson responses, set the X-Watson-Learning-Opt-Out header parameter to true when sending a message. You can set the header by using the SetDefaultHeaders method of the service object you use to send message requests that you do not want to be accessed.
  • To prevent IBM from accessing training data such as intents and entities, set the X-Watson-Learning-Opt-Out header parameter to true when creating or updating a workspace. This option marks the workspace as opted out, and no training data for that workspace will be used. (This option does not apply to messages, which must be opted out individually.)
  • To prevent IBM from accessing training data such as intents and entities, set the X-Watson-Learning-Opt-Out header parameter to true when creating or updating a workspace. This option marks the workspace as opted out, and no training data for that workspace will be used. (This option does not apply to messages, which must be opted out individually.) You can set the header by using the setDefaultHeaders method of the service object you use to create or update the workspace.
  • To prevent IBM from accessing training data such as intents and entities, set the X-Watson-Learning-Opt-Out header parameter to true when creating or updating a workspace. This option marks the workspace as opted out, and no training data for that workspace will be used. (This option does not apply to messages, which must be opted out individually.) You can set the header by using the headers parameter when you create the service object you use to create or update the workspace.
  • To prevent IBM from accessing training data such as intents and entities, set the X-Watson-Learning-Opt-Out header parameter to true when creating or updating a workspace. This option marks the workspace as opted out, and no training data for that workspace will be used. (This option does not apply to messages, which must be opted out individually.) You can set the header by using the set_default_headers method of the service object you use to create or update the workspace.
  • To prevent IBM from accessing training data such as intents and entities, set the X-Watson-Learning-Opt-Out header parameter to true when creating or updating a workspace. This option marks the workspace as opted out, and no training data for that workspace will be used. (This option does not apply to messages, which must be opted out individually.) You can set the header by using the add_default_headers method of the service object you use to create or update the workspace.
  • To prevent IBM from accessing training data such as intents and entities, set the X-Watson-Learning-Opt-Out header parameter to true when creating or updating a workspace. This option marks the workspace as opted out, and no training data for that workspace will be used. (This option does not apply to messages, which must be opted out individually.) You can set the header by using the SetDefaultHeaders method of the service object you use to create or update the workspace.
  • You can also mark a workspace as opted out by specifying a value of true for the learning_opt_out property in the JSON data used to create or update a workspace. This option applies only to training data, not to messages. (The HTTP header always overrides the JSON property, if both are specified.)

Example request

curl -u "apikey:{apikey}" -H "X-Watson-Learning-Opt-Out: true" "{url}/{method}"

Example request

Map<String, String> headers = new HashMap<String, String>();
headers.put("X-Watson-Learning-Opt-Out", "true");

assistant.setDefaultHeaders(headers);

Example request

var  = require('watson-developer-cloud/');

var assistant = new AssistantV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  headers: {
    'X-Watson-Learning-Opt-Out': 'true'
  }
});

Example request

assistant.set_default_headers({'x-watson-learning-opt-out': "true"})

Example request

assistant.add_default_headers(headers: {"x-watson-learning-opt-out" => "true"})

Example request

import "net/http"

headers := http.Header{}
headers.Add("x-watson-learning-opt-out", "true")
assistantv1.Service.SetDefaultHeaders(headers)

Synchronous and asynchronous requests

The Java SDK supports both synchronous (blocking) and asynchronous (non-blocking) execution of service methods. All service methods implement the ServiceCall interface.

  • To call a method synchronously, use the execute method of the ServiceCall interface. You can call the execute method directly from an instance of the service.
  • To call a method asynchronously, use the enqueue method of the ServiceCall interface to receive a callback when the response arrives. The ServiceCallback interface of the method's argument provides onResponse and onFailure methods that you override to handle the callback.

The Ruby SDK supports both synchronous (blocking) and asynchronous (non-blocking) execution of service methods. All service methods implement the Concurrent::Async module. When you use the synchronous/asynchronous methods, an IVar object is returned. You access the DetailedResponse object by calling ivar_object.value.

For more information about the Ivar object, see the IVar class docs.

  • To call a method synchronously, either call the method directly, or use the .await chainable method of the Concurrent::Async module.

    Calling a method directly (without .await) returns a DetailedResponse object.

  • To call a method asynchronously, use the .async chainable method of the Concurrent::Async module.

You can call the .await and .async methods directly from an instance of the service.

Example synchronous request

ReturnType returnValue = assistant.method(parameters).execute();

Example asynchronous request

assistant.method(parameters).enqueue(new ServiceCallback<ReturnType>() {
        @Override public void onResponse(ReturnType response) {
            . . .
        }
        @Override public void onFailure(Exception e) {
            . . .
        }
    });

Example synchronous request

response = assistant.method_name(parameters)

or

response = assistant.await.method_name(parameters)

Example asynchronous request

response = assistant.async.method_name(parameters)

Rate limiting

Rate limits for API requests are enforced on a per-service-instance basis. If the number of requests for a particular method and endpoint reaches the request limit within the specified time window, no further requests are accepted until the timer expires. After the timer expires, a new time window begins with the next accepted request.

The response to each HTTP request includes headers you can use to determine whether you are close to the rate limit:

  • X-RateLimit-Reset: the time the current timer expires (in UNIX epoch time)
  • X-RateLimit-Remaining: the number of requests remaining in the current time window
  • X-RateLimit-Limit: the total number of requests allowed within the time window

An HTTP status code of 429 indicates that the rate limit has been exceeded.

The number of allowed requests, and the length of the time window, vary by method and endpoint. The reference information for each endpoint specifies the rate limit that applies.

Pagination

Some API requests might return a large number of results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page.

The default page size is 100 objects. To use a different page size, use the page_limit query parameter.

To change the attribute by which results are sorted, use the sort query parameter. If you include multiple sort parameters on the same query, the results are sorted first by the first sorting attribute, then the second, and so on.

The supported sorting attributes vary by endpoint; for more information, see the API Reference information for each request.

For any request that uses pagination, the response includes a pagination object that specifies pagination information. This object includes two URLs you can use to make subsequent requests:

  • refresh_url: The URL for requesting the same page of results again.
  • next_url: The URL for requesting the next page of results. The next_url property is omitted if there are no more results.

These URLs retain the same page_limit and sort parameters that were used for the initial request.

Pagination

Name Description
refresh_url
string
The URL that will return the same page of results.
next_url
string
The URL that will return the next page of results, if any.
total
integer
Reserved for future use.
matched
integer
Reserved for future use.

Methods

Get response to user input

Send user input to a workspace and receive a response.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

There is no rate limit for this operation.

POST /v1/workspaces/{workspace_id}/message
ServiceCall<MessageResponse> message(MessageOptions messageOptions)
message(params, callback())
message(self, workspace_id, input=None, alternate_intents=None, context=None, entities=None, intents=None, output=None, nodes_visited_details=None, **kwargs)
message(workspace_id:, input: nil, alternate_intents: nil, context: nil, entities: nil, intents: nil, output: nil, nodes_visited_details: nil)
Request

Use the MessageOptions.Builder to create a MessageOptions object that contains the parameter values for the message method.

Path Parameters

  • Unique identifier of the workspace.

Query Parameters

  • Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is 2018-09-20.

  • Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.

    Default: false

The message to be sent. This includes the user's input, along with optional intents, entities, and context from the last response.

Example:

The message options.

parameters

  • Unique identifier of the workspace.

  • An input object that includes the input text.

  • Whether to return more than one intent. Set to true to return all matching intents.

    Default: false

  • State information for the conversation. To maintain state, include the context from the previous response.

  • Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

    Example:
  • Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

  • An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

  • Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.

    Default: false

parameters

  • Unique identifier of the workspace.

  • An input object that includes the input text.

  • Whether to return more than one intent. Set to true to return all matching intents.

    Default: false

  • State information for the conversation. To maintain state, include the context from the previous response.

  • Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

    Example:
  • Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

  • An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

  • Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.

    Default: false

parameters

  • Unique identifier of the workspace.

  • An input object that includes the input text.

  • Whether to return more than one intent. Set to true to return all matching intents.

    Default: false

  • State information for the conversation. To maintain state, include the context from the previous response.

  • Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

    Example:
  • Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

  • An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

  • Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.

    Default: false

Example requests
Response

The response sent by the workspace, including the output text, detected intents and entities, and context.

The response sent by the workspace, including the output text, detected intents and entities, and context.

The response sent by the workspace, including the output text, detected intents and entities, and context.

The response sent by the workspace, including the output text, detected intents and entities, and context.

The response sent by the workspace, including the output text, detected intents and entities, and context.

Status Code

  • Successful request.

  • Invalid request.

Example responses

List workspaces

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

GET /v1/workspaces
ServiceCall<WorkspaceCollection> listWorkspaces(ListWorkspacesOptions listWorkspacesOptions)
listWorkspaces(params, callback())
list_workspaces(self, page_limit=None, include_count=None, sort=None, cursor=None, include_audit=None, **kwargs)
list_workspaces(page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
Request

Use the ListWorkspacesOptions.Builder to create a ListWorkspacesOptions object that contains the parameter values for the listWorkspaces method.

Query Parameters

  • Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is 2018-09-20.

  • The number of records to return in each page of results.

    Default: 100

  • Whether to include information about the number of records returned.

    Default: false

  • The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (-).

    Allowable values: [name,updated]

  • A token identifying the page of results to retrieve.

  • Whether to include the audit properties (created and updated timestamps) in the response.

    Default: false

The listWorkspaces options.

parameters

  • The number of records to return in each page of results.

    Default: 100

  • Whether to include information about the number of records returned.

    Default: false

  • The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (-).

    Allowable values: [name,updated]

  • A token identifying the page of results to retrieve.

  • Whether to include the audit properties (created and updated timestamps) in the response.

    Default: false

parameters

  • The number of records to return in each page of results.

    Default: 100

  • Whether to include information about the number of records returned.

    Default: false

  • The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (-).

    Allowable values: [name,updated]

  • A token identifying the page of results to retrieve.

  • Whether to include the audit properties (created and updated timestamps) in the response.

    Default: false

parameters

  • The number of records to return in each page of results.

    Default: 100

  • Whether to include information about the number of records returned.

    Default: false

  • The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (-).

    Allowable values: [name,updated]

  • A token identifying the page of results to retrieve.

  • Whether to include the audit properties (created and updated timestamps) in the response.

    Default: false

Example requests
Response

Status Code

  • Successful request.

  • Invalid request.

Example responses

Create workspace

Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

POST /v1/workspaces
ServiceCall<Workspace> createWorkspace(CreateWorkspaceOptions createWorkspaceOptions)
createWorkspace(params, callback())
create_workspace(self, name=None, description=None, language=None, intents=None, entities=None, dialog_nodes=None, counterexamples=None, metadata=None, learning_opt_out=None, system_settings=None, **kwargs)
create_workspace(name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil)
Request

Use the CreateWorkspaceOptions.Builder to create a CreateWorkspaceOptions object that contains the parameter values for the createWorkspace method.

Query Parameters

  • Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is 2018-09-20.

The content of the new workspace.

The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the workspace without intents and entities and then adding them separately.

The createWorkspace options.

parameters

  • The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

  • The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

  • The language of the workspace.

  • An array of objects defining the intents for the workspace.

  • An array of objects defining the entities for the workspace.

    Example:
  • An array of objects defining the nodes in the dialog.

  • An array of objects defining input examples that have been marked as irrelevant input.

  • Any metadata related to the workspace.

  • Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

    Default: false

  • Global settings for the workspace.

parameters

  • The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

  • The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

  • The language of the workspace.

  • An array of objects defining the intents for the workspace.

  • An array of objects defining the entities for the workspace.

    Example:
  • An array of objects defining the nodes in the dialog.

  • An array of objects defining input examples that have been marked as irrelevant input.

  • Any metadata related to the workspace.

  • Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

    Default: false

  • Global settings for the workspace.

parameters

  • The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

  • The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

  • The language of the workspace.

  • An array of objects defining the intents for the workspace.