Introduction

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

Beginning with version 4.0.0, the Node SDK returns a Promise for all methods when a callback is not specified.

The package location moved to ibm-watson. It remains available at watson-developer-cloud but is not updated there. Use ibm-watson to stay up to date.

The IBM Watson Unity SDK has the following requirements.

  • The SDK requires Unity version 2018.2 or later to support TLS 1.2.
    • Set the project settings for both the Scripting Runtime Version and the Api Compatibility Level to .NET 4.x Equivalent.
    • For more information, see TLS 1.0 support.
  • The SDK does not support the WebGL projects. Change your build settings to any platform except WebGL.

For information about how to install and configure the SDK and SDK Core, see https://github.com/watson-developer-cloud/unity-sdk.

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

Maven

<dependency>
  <groupId>com.ibm.watson</groupId>
  <artifactId>ibm-watson</artifactId>
  <version>7.3.1</version>
</dependency>

Gradle

compile 'com.ibm.watson:ibm-watson:7.3.1'

GitHub

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

Installation

npm install ibm-watson

GitHub

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

Installation

pip install --upgrade "ibm-watson>=3.3.0"

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

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

Cocoapods

pod 'IBMWatsonAssistantV1', '~> 2.2.0'

Carthage

github "watson-developer-cloud/swift-sdk" ~> 2.2.0

Swift Package Manager

.package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "2.2.0")

GitHub

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

Package Manager

Install-Package IBM.Watson.Assistant.v1 -Version 3.4.0

.NET CLI

dotnet add package IBM.Watson.Assistant.v1 -version 3.4.0

PackageReference

<PackageReference Include="IBM.Watson.Assistant.v1" Version="3.4.0" />

GitHub

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

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 an API key, use apikey for the username and the value of the API key as the password.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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.

    If you pass in the value of the API key, 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 in the Resource list.

You can also access the service credentials from the Watson Assistant user interface:

  • To see the service credentials and the assistant ID of an assistant, open the assistant settings and click API Details. (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}" -X {request_method} "{url}/{method}"

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

curl -u "{username}:{password}" -X {request_method} "{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}, {version}, 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}.

const AssistantV1 = require('ibm-watson/assistant/v1');

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

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

const  = require('ibm-watson/assistant/v1');

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

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

from ibm_watson import AssistantV1

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

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

from ibm_watson 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}, {version}, 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}, {version}, 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}",
})

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

let assistant = Assistant(version: "{version}", apiKey: "{apikey}")

assistant.serviceURL = "{url}"

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

let assistant = Assistant(version: "{version}", username: "{username}", password: "{password}")

assistant.serviceURL = "{url}"

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

IamConfig config = new IamConfig(
    apikey: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", config);
assistant.SetEndpoint("{url}");

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

BasicAuthConfig config = new BasicauthConfig(
    username: "{username}",
    password: "{password}"
);

Assistant assistant = new Assistant("{version}", config);
assistant.SetEndpoint("{url}");

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

IamTokenOptions tokenOptions = new IamTokenOptions()
{
    IamApiKey = "{apikey}"
};
Credentials credentials = new Credentials(tokenOptions);
while (!credentials.HasTokenData())
{
    yield return null;
}

AssistantService assistant = new AssistantService("{version}", credentials);
assistant.Url = "{url}";

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

Credentials credentials = new Credentials("{username}", "{password}");

AssistantService assistant = new AssistantService("{version}", credentials);
assistant.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 in the Resource list.

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.

Set the correct service URL by setting the serviceURL property of the service instance.

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

Set the correct service URL by setting the Url property 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 example

curl -u "apikey:{apikey}" -X {request_method} "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

const AssistantV1 = require('ibm-watson/assistant/v1');

const 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")

Default URL

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

Example for the Washington, DC location

let assistant = Assistant(version: "{version}", apiKey: "{apikey}")
assistant.serviceURL = "https://gateway-wdc.watsonplatform.net/assistant/api"

Default URL

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

Example for the Washington, DC location

IamConfig config = new IamConfig(
    apikey: "{apikey}"
    );

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

Default URL

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

Example for the Washington, DC location

IamTokenOptions tokenOptions = new IamTokenOptions()
{
    IamApiKey = "{apikey}"
};
Credentials credentials = new Credentials(tokenOptions);
while (!credentials.HasTokenData())
{
    yield return null;
}

AssistantService assistant = new AssistantService("{version}", credentials);
assistant.Url = "https://gateway-wdc.watsonplatform.net/assistant/api";

Disabling SSL verification

All Watson services use Secure Sockets Layer (SSL) (or Transport Layer Security (TLS)) for secure connections between the client and server. The connection is verified against the local certificate store to ensure authentication, integrity, and confidentiality.

If you use a self-signed certificate, you need to disable SSL verification to make a successful connection.

Enabling SSL verification is highly recommended. Disabling SSL jeopardizes the security of the connection and data. Disable SSL only if absolutely necessary, and take steps to enable SSL as soon as possible.

To disable SSL verification for a curl request, use the --insecure (-k) option with the request.

To disable SSL verification, create an HttpConfigOptions object and set the disableSslVerification property to true. Then pass the object to the service instance by using the configureClient method.

To disable SSL verification, set the disable_ssl_verification parameter to true when you create the service instance.

To disable SSL verification, call the disable_SSL_verification method on the service instance.

To disable SSL verification, call the configure_http_client method on the service instance and set the disable_ssl parameter to true.

To disable SSL verification, call the DisableSSLVerification method on the service instance.

To disable SSL verification, call the disableSSLVerification() method on the service instance. You cannot disable SSL verification on Linux.

To disable SSL verification, set the DisableSslVerification method to true on the service instance.

To disable SSL verification, call the DisableSslVerification method on the service instance.

Example that disables SSL verification

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

curl -k -u "apikey:{apikey}" -X {request_method} "{url}/{method}"

Example that disables SSL verification

IamOptions options = new IamOptions.Builder()
    .apiKey("{apikey}")
    .build();
Assistant assistant = new Assistant("{version}", options);
assistant.setEndPoint("{url}");

HttpConfigOptions configOptions = new HttpConfigOptions.Builder()
  .disableSslVerification(true)
  .build();
assistant.configureClient(configOptions);

Example that disables SSL verification

const AssistantV1 = require('ibm-watson/assistant/v1');

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

Example that disables SSL verification

from ibm_watson import AssistantV1

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

Example that disables SSL verification

require "ibm_watson"

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

Example that disables SSL verification

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

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

Example that disables SSL verification


let assistant = Assistant(version: "{version}", apiKey: "{apikey}")
assistant.disableSSLVerification()

Example that disables SSL verification

IamConfig config = new IamConfig(
    apikey: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", config);
assistant.SetEndpoint("{url}");
assistant.DisableSslVerification(true);

Example that disables SSL verification

IamTokenOptions tokenOptions = new IamTokenOptions()
{
    IamApiKey = "{apikey}"
};
Credentials credentials = new Credentials(tokenOptions);
while (!credentials.HasTokenData())
{
    yield return null;
}

AssistantService assistant = new AssistantService("{version}", credentials);
assistant.Url = "{url}";

assistant.DisableSslVerification = true;

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, 2019-02-28. 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 that is 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 that is 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 an ApiException that contains the following fields.

Field Description
code The HTTP response code that is 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 an ApiException that contains the following fields.

Field Description
code The HTTP response code that is 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 that is returned.
message A message that describes the error.

The Swift SDK returns a WatsonError in the completionHandler any unsuccessful method invocation. This error type is an enum that conforms to LocalizedError and contains an errorDescription property that returns an error message. Some of the WatsonError cases contain associated values that reveal more information about the error.

Field Description
errorDescription A message that describes the error.

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

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

When the Unity SDK receives an error response from the Watson Assistant service, it generates an IBMError that contains the following fields.

Field Description
Url The URL that generated the error.
StatusCode The HTTP response code returned.
ErrorMessage A message that describes the error.
Response The contents of the response from the server.
ResponseHeaders A dictionary of headers returned by the request.

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)
  .catch(err => {
    console.log('error:', err);
  });

Example error handling

from ibm_watson import ApiException
try:
    # Invoke a Watson Assistant method
except ApiException 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 IBMWatson::ApiException => 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 errors
if assistantErr != nil {
  panic(assistantErr)
}

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

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

Example error handling

assistant.method() {
  response, error in

  if let error = error {
    switch error {
    case let .http(statusCode, message, metadata):
      switch statusCode {
      case .some(404):
        // Handle Not Found (404) exception
        print("Not found")
      case .some(413):
        // Handle Request Too Large (413) exception
        print("Payload too large")
      default:
        if let statusCode = statusCode {
          print("Error - code: \(statusCode), \(message ?? "")")
        }
      }
    default:
      print(error.localizedDescription)
    }
    return
  }

  guard let result = response?.result else {
    print(error?.localizedDescription ?? "unknown error")
    return
  }

  print(result)
}

Example error handling

try
{
    // Invoke a Watson assistant method
}
catch(ServiceResponseException e)
{
    Console.WriteLine("Error: " + e.Message);
}
catch (Exception e)
{
    Console.WriteLine("Error: " + e.Message);
}

Example error handling

// Invoke a method
assistant.MethodName(Callback, Parameters);

// Check for errors
private void Callback(DetailedResponse<ExampleResponse> response, IBMError error)
{
    if (error == null)
    {
        Log.Debug("ExampleCallback", "Response received: {0}", response.Response);
    }
    else
    {
        Log.Debug("ExampleCallback", "Error received: {0}, {1}, {3}", error.StatusCode, error.ErrorMessage, error.Response);
    }
}

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 a request header, use the --header (-H) option with a curl request.

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 it.

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 it.

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.

To pass header parameters with every request, add them to the defaultHeaders property of the service object. See Data collection for an example use of this method.

To pass header parameters in a single request, pass the headers parameter to the request method.

To pass header parameters in a single request, use the WithHeader() method as a modifier on the request before you execute it.

To pass header parameters in a single request, use the WithHeader() method as a modifier on the request before you execute it.

Example header parameter in a request

curl -u "apikey:{apikey}" -X {request_method} --header "Request-Header: {header_value}" "{url}/{method}"

Example header parameter in a request

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

Example header parameter in a request

const parameters = {
  {parameters}
};

assistant.methodName(
  parameters,
  headers: {
    'Custom-Header': '{header_value}'
  })
   .then(result => {
    console.log(response);
  })
  .catch(err => {
    console.log('error:', err);
  });

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",
    },
  },
)

Example header parameter in a request

let customHeader: [String: String] = ["Custom-Header": "{header_value}"]
assistant.methodName(parameters, headers: customHeader) {
  response, error in
}

Example header parameter in a request

IamConfig iamConfig = new IamConfig(
    apikey: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", iamConfig);
assistant.SetEndpoint("{url}");
assistant.WithHeader("Custom-Header", "header_value");

Example header parameter in a request

IamTokenOptions tokenOptions = new IamTokenOptions()
{
    IamApiKey = "{apikey}"
};
Credentials credentials = new Credentials(tokenOptions);
while (!credentials.HasTokenData())
{
    yield return null;
}

AssistantService assistant = new AssistantService("{version}", credentials);
assistant.Url = "{url}";
assistant.WithHeader("Custom-Header", "header_value");

Response details

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

To access all response headers that the service returns, include the --include (-i) option with a curl request. To see detailed response data for the request, including request headers, response headers, and additional debugging information, include the --verbose (-v) option with the request.

Example request to access response headers

curl -u "apikey:{apikey}" -X {request_method} --include "{url}/{method}"

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, add the return_response parameter set to true and specify the headers attribute on the response object that is returned by the method. To access information in the response object, use the following properties.

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

const parameters = {
  {parameters}
};

parameters.return_response = true;

assistant.methodName(parameters)
  .then(response => {
    console.log(response.headers);
  })
  .catch(err => {
    console.log('error:', err);
  });

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 response 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/IBM/go-sdk-core/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 ")

All response data is available in the WatsonResponse<T> object that is returned in each method's completionHandler.

Example request to access response headers

assistant.methodName(parameters) {
  response, error in

  guard let result = response?.result else {
    print(error?.localizedDescription ?? "unknown error")
    return
  }
  print(result) // The data returned by the service
  print(response?.statusCode)
  print(response?.headers)
}

The response contains fields for response headers, response JSON, and the status code.

DetailedResponse

Property Description
Result Returns the result for the service-specific method.
Response Returns the raw JSON response for the service-specific method.
Headers Returns the response header information.
StatusCode Returns the HTTP status code.

Example request to access response headers

var results = assistant.MethodName(parameters);

var result = results.Result;            //  The result object
var responseHeaders = results.Headers;  //  The response headers
var responseJson = results.Response;    //  The raw response JSON
var statusCode = results.StatusCode;    //  The response status code

The response contains fields for response headers, response JSON, and the status code.

DetailedResponse

Property Description
Result Returns the result for the service-specific method.
Response Returns the raw JSON response for the service-specific method.
Headers Returns the response header information.
StatusCode Returns the HTTP status code.

Example request to access response headers

private void Example()
{
    assistant.MethodName(Callback, Parameters);
}

private void Callback(DetailedResponse<ResponseType> response, IBMError error)
{
    var result = response.Result;                 //  The result object
    var responseHeaders = response.Headers;       //  The response headers
    var responseJson = reresponsesults.Response;  //  The raw response JSON
    var statusCode = response.StatusCode;         //  The response 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 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 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 adding it to the defaultHeaders property 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.
  • 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 adding it to the defaultHeaders property 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 WithHeader() 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

const AssistantV1 = require('ibm-watson/assistant/v1');

const assistant = new AssistantV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  url: '{url}',
  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)

Example request

assistant.defaultHeaders["X-Watson-Learning-Opt-Out"] = "true"

Example request

IamConfig config = new IamConfig(
    apikey: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", config);
assistant.SetEndpoint("{url}");
assistant.WithHeader("X-Watson-Learning-Opt-Out", "true");

Example request

IamTokenOptions tokenOptions = new IamTokenOptions()
{
    IamApiKey = "{apikey}"
};
Credentials credentials = new Credentials(tokenOptions,);
while (!credentials.HasTokenData())
{
    yield return null;
}

AssistantService assistant = new AssistantService("{version}", credentials);
assistant.Url = "{url}";
assistant.WithHeader("X-Watson-Learning-Opt-Out", "true");

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 or 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 that 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 returns the same page of results.
next_url
string
The URL that returns 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.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

Send user input to a workspace and receive a response.

Note: For most applications, there are significant advantages to using the v2 runtime API instead. These advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the documentation.

There is no rate limit for this operation.

POST /v1/workspaces/{workspace_id}/message
(assistant *AssistantV1) Message(messageOptions *MessageOptions) (*core.DetailedResponse, error)
ServiceCall<MessageResponse> message(MessageOptions messageOptions)
message(params, [callback()])
message(self, workspace_id, input=None, intents=None, entities=None, alternate_intents=None, context=None, output=None, nodes_visited_details=None, **kwargs)
message(workspace_id:, input: nil, intents: nil, entities: nil, alternate_intents: nil, context: nil, output: nil, nodes_visited_details: nil)
func message(
    workspaceID: String,
    input: MessageInput? = nil,
    intents: [RuntimeIntent]? = nil,
    entities: [RuntimeEntity]? = nil,
    alternateIntents: Bool? = nil,
    context: Context? = nil,
    output: OutputData? = nil,
    nodesVisitedDetails: Bool? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<MessageResponse>?, WatsonError?) -> Void)
Message(string workspaceId, MessageInput input = null, List<RuntimeIntent> intents = null, List<RuntimeEntity> entities = null, bool? alternateIntents = null, Context context = null, OutputData output = null, bool? nodesVisitedDetails = null)
Request

Instantiate the MessageOptions struct and set the fields to provide parameter values for the Message method.

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 2019-02-28.

  • 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.

The Message options.

The message options.

parameters

  • Unique identifier of the workspace.

  • An input object that includes the input text.

  • 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.

  • 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:
  • Whether to return more than one intent. A value of true indicates that all matching intents are returned.

    Default: false

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

  • 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.

  • 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.

  • 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:
  • Whether to return more than one intent. A value of true indicates that all matching intents are returned.

    Default: false

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

  • 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.

  • 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.

  • 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:
  • Whether to return more than one intent. A value of true indicates that all matching intents are returned.

    Default: false

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

  • 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.

  • 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.

  • 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:
  • Whether to return more than one intent. A value of true indicates that all matching intents are returned.

    Default: false

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

  • 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.

  • 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.

  • 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:
  • Whether to return more than one intent. A value of true indicates that all matching intents are returned.

    Default: false

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

  • 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

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.