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.

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 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>8.0.0</version>
</dependency>

Gradle

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

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>=4.0.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

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

Cocoapods

pod 'IBMWatsonAssistantV1', '~> 3.0.0'

Carthage

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

Swift Package Manager

.package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "3.0.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 4.0.0

.NET CLI

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

PackageReference

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

GitHub

Authentication

You authenticate by providing the API key for your service instance. A Watson Assistant v1 cluster has a single instance of the service and a single API key.

The SDK manages the lifecycle of the tokens for the API key.

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

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443.

curl -u "apikey:{apikey}" -X {request_method} "https://{icp_cluster_host}{:port}/assistant/api/v1/{method}"

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

Assistant assistant = new Assistant("{version}");
assistant.setUsernameAndPassword("apikey","{apikey}");
assistant.setEndPoint("https://{icp_cluster_host}{:port}/assistant/api");

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

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

const assistant = new AssistantV1({
  version: '{version}',
  username: 'apikey',
  password: '{apikey}',
  url: 'https://{icp_cluster_host}{:port}/assistant/api',
});

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

from ibm_watson import AssistantV1

assistant = AssistantV1(
    version='{version}',
    username='apikey',
    password='{apikey}',
    url='https://{icp_cluster_host}{:port}/assistant/api'
)

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

require "ibm_watson"

assistant = IBMWatson::AssistantV1.new(
  version: "{version}",
  username: "apikey",
  password: "{apikey}",
  url:"https://{icp_cluster_host}{:port}/assistant/api"
)

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

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

assistant, assistantErr := assistantv1.NewAssistantV1(&assistantv1.AssistantV1Options{
  Version:  "{version}",
  Username: "apikey",
  Password: "{apikey}",
  URL:      "https://{icp_cluster_host}{:port}/assistant/api",
})

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host} and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

let assistant = Assistant(version: "{version}", apikey: "{apikey}")
assistant.serviceURL = "https://{icp_cluster_host}{:port}/assistant/api"

Replace {apikey} with the API key for your service instance. Replace {icp_cluster_host and {port} with the name or IP address of the host on which your Watson Assistant v1 cluster is deployed and the port number on which the service listens. The default port is 443. Replace {version} with the service version date.

BasicAuthConfig basicAuthConfig = new BasicAuthConfig(
    username: "apikey",
    password: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", basicAuthConfig);
assistant.SetEndpoint("https://{icp_cluster_host}{:port}/assistant/api");

Service endpoint

The service endpoint for Watson Assistant v1 is always the following base URL:

https://{icp_cluster_host}{:port}/assistant/api

Replace {icp_cluster_host} with the name or IP address of the host on which your cluster is deployed. Replace {port} with the port number on which the service listens. The default port is 443.

Use that URL in your requests to Watson Assistant v1.

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.

Example

curl -u "apikey:{apikey}" -X {request_method} "https://{icp_cluster_host}{:port}/assistant/api/{method}"

Example

Assistant assistant = new Assistant("{version}");
assistant.setUsernameAndPassword("apikey","{apikey}");
assistant.setEndPoint("https://{icp_cluster_host}{:port}/assistant/api");

Example

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

const assistant = new AssistantV1({
  version: '{version}',
  username: 'apikey',
  password: '{apikey}',
  url: 'https://{icp_cluster_host}{:port}/assistant/api',
});

Examples in the constructor and after instantiation

from ibm_watson import AssistantV1

assistant = AssistantV1(
    version='{version}',
    username='apikey',
    password='{apikey}',
    url='https://{icp_cluster_host}{:port}/assistant/api'
)

or

assistant.set_url('https://{icp_cluster_host}{:port}/assistant/api')

Examples in the constructor and after instantiation

require "ibm_watson"

assistant = IBMWatson::AssistantV1.new(
  version: "{version}",
  username: "apikey",
  password: "{apikey}",
  url:"https://{icp_cluster_host}{:port}/assistant/api"
)

or

assistant.url = "https://{icp_cluster_host}{:port}/assistant/api"

Examples in the constructor and after instantiation

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

assistant, assistantErr := assistantv1.NewAssistantV1(&assistantv1.AssistantV1Options{
  Version:  "{version}",
  Username: "apikey",
  Password: "{apikey}",
  URL:      "https://{icp_cluster_host}{:port}/assistant/api",
})

or

assistant.SetURL("https://{icp_cluster_host}{:port}/assistant/api")

Example

let assistant = Assistant(version: "{version}", apikey: "{apikey}")
assistant.serviceURL = "https://{icp_cluster_host}{:port}/assistant/api"

Example

BasicAuthConfig basicAuthConfig = new BasicAuthConfig(
    username: "apikey",
    password: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", basicAuthConfig);
assistant.SetEndpoint("https://{icp_cluster_host}{:port}/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 property to true on the service instance.

Example that disables SSL verification

curl -k -u "apikey:{apikey}" -X {request_method} "https://{icp_cluster_host}{:port}/assistant/api/v1/{method}"

Example that disables SSL verification

Assistant assistant = new Assistant("{version}");
assistant.setUsernameAndPassword("apikey","{apikey}");
assistant.setEndPoint("https://{icp_cluster_host}{:port}/assistant/api");

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

Example that disables SSL verification

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

const assistant = new AssistantV1({
  version: '{version}',
  username: 'apikey',
  password: '{apikey}',
  url: 'https://{icp_cluster_host}{:port}/assistant/api',
  disable_ssl_verification: true,
});

Example that disables SSL verification

from ibm_watson import AssistantV1

assistant = AssistantV1(
    version='{version}',
    username='apikey',
    password='{apikey}',
    url='https://{icp_cluster_host}{:port}/assistant/api'
)
assistant.disable_SSL_verification()

Example that disables SSL verification

require "ibm_watson"

assistant = IBMWatson::AssistantV1.new(
  version: "{version}",
  username: "apikey",
  password: "{apikey}",
  url:"https://{icp_cluster_host}{:port}/assistant/api"
)
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}",
  Username: "apikey",
  Password: "{apikey}",
  URL:      "https://{icp_cluster_host}{:port}/assistant/api",
})
assistant.DisableSSLVerification()

Example that disables SSL verification


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

Example that disables SSL verification

BasicAuthConfig basicAuthConfig = new BasicAuthConfig(
    username: "apikey",
    password: "{apikey}"
    );

Assistant assistant = new Assistant("{version}", basicAuthConfig);
assistant.SetEndpoint("https://{icp_cluster_host}{:port}/assistant/api");
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 v1, 2018-09-20. In some cases, differences in earlier versions are noted in the descriptions of parameters and response models.

Error handling

Watson Assistant v1 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 v1 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 v1 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 v1 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 v1 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.

Example error handling

try {
  // Invoke a Watson Assistant v1 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 v1 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 v1 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 error
if assistantErr != nil {
  panic(assistantErr)
}

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

// Check for error
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);
}

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.

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.

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.

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.

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.

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.

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.

Example header parameter in a request

curl -u "apikey:{apikey}" -X {request_method} --header "Request-Header: {header_value}" "https://{icp_cluster_host}{:port}/assistant/api/{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

BasicAuthConfig basicAuthConfig = new BasicAuthConfig(
    username: "apikey",
    password: "{apikey}"
    );
Assistant assistant = new Assistant("{version}", basicAuthConfig);
assistant.SetEndpoint("https://{icp_cluster_host}{:port}/assistant/api");
assistant.WithHeader("Custom-Header", "header_value");

Response details

Watson Assistant v1 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 "https://{icp_cluster_host}{:port}/assistant/api/{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

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 v1 and labeling data, see Information security.

For more information about how to pass headers, see Additional 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 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)

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.

Send user input to a workspace and receive a response.

Send user input to a workspace and receive a response.

Send user input to a workspace and receive a response.

Send user input to a workspace and receive a response.

Send user input to a workspace and receive a response.

Send user input to a workspace and receive a response.

POST /v1/workspaces/{workspace_id}/message
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)
(assistant *AssistantV1) Message(messageOptions *MessageOptions) (result *MessageResponse, response *core.DetailedResponse, err error)
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)
Request

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

Instantiate the MessageOptions struct and set the fields to provide 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.

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

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

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.