IBM Cloud API Docs
Discovery

Introduction

IBM Watson™ Discovery is a cognitive search and content analytics engine that you can add to applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual filtering of results.

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.0</version>
</dependency>

Gradle

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

GitHub

https://github.com/watson-developer-cloud/java-sdk

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

Installation

npm install ibm-watson

GitHub

https://github.com/watson-developer-cloud/node-sdk

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

Installation

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

GitHub

https://github.com/watson-developer-cloud/python-sdk

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

Installation

gem install ibm_watson

GitHub

https://github.com/watson-developer-cloud/ruby-sdk

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

https://github.com/watson-developer-cloud/go-sdk

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

Cocoapods

pod 'IBMWatsonDiscoveryV1', '~> 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

https://github.com/watson-developer-cloud/swift-sdk

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

Package Manager

Install-Package IBM.Watson.Discovery.v1 -Version 3.3.0

.NET CLI

dotnet add package IBM.Watson.Discovery.v1 -version 3.3.0

PackageReference

<PackageReference Include="IBM.Watson.Discovery.v1" Version="3.3.0" />

GitHub

https://github.com/watson-developer-cloud/dotnet-standard-sdk

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

Github

https://github.com/watson-developer-cloud/unity-sdk

https://github.com/IBM/unity-sdk-core

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.

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();
Discovery discovery = new Discovery("{version}", options);
discovery.setEndPoint("{url}");

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

Discovery discovery = new Discovery(
    "{version}",
    "{username}",
    "{password}");
discovery.setEndPoint("{url}");

or

Discovery discovery = new Discovery("{version}");
discovery.setUsernameAndPassword("{username}","{password}");
discovery.setEndPoint("{url}");

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

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

const discovery = new DiscoveryV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  url: '{url}'
});

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

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

const discovery = new DiscoveryV1({
  version: '{version}',
  username: '{username}',
  password: '{password}',
  url: '{url}'
});

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

from ibm_watson import DiscoveryV1

discovery = DiscoveryV1(
    version='{version}',
    iam_apikey='{apikey}',
    url='{url}'
)

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

from ibm_watson import DiscoveryV1

discovery = DiscoveryV1(
    version='{version}',
    username='{username}',
    password='{password}',
    url='{url}'
)

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

require "ibm_watson"

discovery = IBMWatson::DiscoveryV1.new(
  version: "{version}",
  iam_apikey: "{apikey}",
  url:"{url}"
)

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

require "ibm_watson"

discovery = IBMWatson::DiscoveryV1.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/discoveryv1"

discovery, discoveryErr := discoveryv1.NewDiscoveryV1(&discoveryv1.DiscoveryV1Options{
  Version: "{version}",
  IAMApiKey: "{apikey}",
  URL: "{url}",
})

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

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

discovery, discoveryErr := discoveryv1.NewDiscoveryV1(&discoveryv1.DiscoveryV1Options{
  Version: "{version}",
  Username: "{username}",
  Password: "{password}",
  URL: "{url}",
})

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

let discovery = Discovery(version: "{version}", apiKey: "{apikey}")

discovery.serviceURL = "{url}"

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

let discovery = Discovery(version: "{version}", username: "{username}", password: "{password}")

discovery.serviceURL = "{url}"

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

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

Discovery discovery = new Discovery("{version}", config);
discovery.SetEndpoint("{url}");

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

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

Discovery discovery = new Discovery("{version}", config);
discovery.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;
}

DiscoveryService discovery = new DiscoveryService("{version}", credentials);
discovery.Url = "{url}";

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

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

DiscoveryService discovery = new DiscoveryService("{version}", credentials);
discovery.Url = "{url}";

Service endpoint

The service endpoint is based on the location of the service instance. For example, when Discovery is hosted in Frankfurt, the base URL is https://gateway-fra.watsonplatform.net/discovery/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 Discovery.

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/discovery/api
  • Washington DC: https://gateway-wdc.watsonplatform.net/discovery/api
  • Frankfurt: https://gateway-fra.watsonplatform.net/discovery/api
  • Sydney: https://gateway-syd.watsonplatform.net/discovery/api
  • Tokyo: https://gateway-tok.watsonplatform.net/discovery/api
  • London: https://gateway-lon.watsonplatform.net/discovery/api

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

Dallas API endpoint example

curl -u "apikey:{apikey}" -X {request_method} "https://gateway.watsonplatform.net/discovery/api"

Your service instance might not use this URL

Default URL

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

Example for the Washington DC location

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

Default URL

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

Example for the Washington DC location

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

const discovery = new DiscoveryV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  url: 'https://gateway-wdc.watsonplatform.net/discovery/api'
});

Default URL

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

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

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

or

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

Default URL

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

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

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

or

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

Default URL

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

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

discovery, discoveryErr := discoveryv1.NewDiscoveryV1(&discoveryv1.DiscoveryV1Options{
  Version: "{version}",
  IAMApiKey: "{apikey}",
  URL: "https://gateway-wdc.watsonplatform.net/discovery/api",
})

or

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

Default URL

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

Example for the Washington DC location

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

Default URL

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

Example for the Washington DC location

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

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

Default URL

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

Example for the Washington DC location

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

DiscoveryService discovery = new DiscoveryService("{version}", credentials);
discovery.Url = "https://gateway-wdc.watsonplatform.net/discovery/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();
Discovery discovery = new Discovery("{version}", options);
discovery.setEndPoint("{url}");

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

Example that disables SSL verification

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

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

Example that disables SSL verification

from ibm_watson import DiscoveryV1

discovery = DiscoveryV1(
    version='{version}',
    iam_apikey='{apikey}',
    url='{url}'
)
discovery.disable_SSL_verification()

Example that disables SSL verification

require "ibm_watson"

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

Example that disables SSL verification

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

discovery, discoveryErr := discoveryv1.NewDiscoveryV1(&discoveryv1.DiscoveryV1Options{
  Version: "{version}",
  IAMApiKey: "{apikey}",
  URL: "{url}",
})
discovery.DisableSSLVerification()

Example that disables SSL verification


let discovery = Discovery(version: "{version}", apiKey: "{apikey}")
discovery.disableSSLVerification()

Example that disables SSL verification

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

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

Example that disables SSL verification

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

DiscoveryService discovery = new DiscoveryService("{version}", credentials);
discovery.Url = "{url}";

discovery.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 Discovery, 2019-04-30. In some cases, differences in earlier versions are noted in the descriptions of parameters and response models.

Error handling

The Discovery 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.

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 Discovery 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 Discovery 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 Discovery 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 Discovery 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 Discovery 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 Discovery 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 Discovery 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

discovery.method(params)
  .catch(err => {
    console.log('error:', err);
  });

Example error handling

from ibm_watson import ApiException
try:
    # Invoke a Discovery 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 Discovery 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/discoveryv1"

// Instantiate a service
discovery, discoveryErr := discoveryv1.NewDiscoveryV1(&discoveryv1.DiscoveryV1Options{})

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

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

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

Example error handling

discovery.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 discovery method
}
catch(ServiceResponseException e)
{
    Console.WriteLine("Error: " + e.Message);
}
catch (Exception e)
{
    Console.WriteLine("Error: " + e.Message);
}

Example error handling

// Invoke a method
discovery.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 = discovery.methodName(parameters)
  .addHeader("Custom-Header", "{header_value}")
  .execute();

Example header parameter in a request

const parameters = {
  {parameters}
};

discovery.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 = discovery.methodName(
    parameters,
    headers = {
        'Custom-Header': '{header_value}'
    })

Example header parameter in a request

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

Example header parameter in a request

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

Example header parameter in a request

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

Example header parameter in a request

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

Discovery discovery = new Discovery("{version}", iamConfig);
discovery.SetEndpoint("{url}");
discovery.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;
}

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

Response details

The Discovery 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 = discovery.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;

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

discovery.set_detailed_response(True)
response = discovery.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 = discovery.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, _ := discoveryv1.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

discovery.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 = discovery.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()
{
    discovery.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 Discovery 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 the X-Watson-Learning-Opt-Out header parameter to true.

You must set the header on each request that you do not want IBM to access for general service improvements.

You can set the header by using the setDefaultHeaders method of the service object.

You can set the header by using the headers parameter when you create the service object.

You can set the header by using the set_default_headers method of the service object.

You can set the header by using the add_default_headers method of the service object.

You can set the header by using the SetDefaultHeaders method of the service object.

You can set the header by adding it to the defaultHeaders property of the service object.

You can set the header by using the WithHeader() method of the service object.

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

discovery.setDefaultHeaders(headers);

Example request

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

const discovery = new DiscoveryV1({
  version: '{version}',
  iam_apikey: '{apikey}',
  url: '{url}',
  headers: {
    'X-Watson-Learning-Opt-Out': 'true'
  }
});

Example request

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

Example request

discovery.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")
discoveryv1.Service.SetDefaultHeaders(headers)

Example request

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

Example request

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

Discovery discovery = new Discovery("{version}", config);
discovery.SetEndpoint("{url}");
discovery.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;
}

DiscoveryService discovery = new DiscoveryService("{version}", credentials);
discovery.Url = "{url}";
discovery.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 = discovery.method(parameters).execute();

Example asynchronous request

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

Example synchronous request

response = discovery.method_name(parameters)

or

response = discovery.await.method_name(parameters)

Example asynchronous request

response = discovery.async.method_name(parameters)

Related information

Methods

Create an environment

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

POST /v1/environments
(discovery *DiscoveryV1) CreateEnvironment(createEnvironmentOptions *CreateEnvironmentOptions) (*core.DetailedResponse, error)
ServiceCall<Environment> createEnvironment(CreateEnvironmentOptions createEnvironmentOptions)
createEnvironment(params, [callback()])
create_environment(self, name, description=None, size=None, **kwargs)
create_environment(name:, description: nil, size: nil)
func createEnvironment(
    name: String,
    description: String? = nil,
    size: String? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<Environment>?, WatsonError?) -> Void)
CreateEnvironment(string name, string description = null, string size = null)
CreateEnvironment(Callback<ModelEnvironment> callback, string name, string description = null, string size = null)
Request

Instantiate the CreateEnvironmentOptions struct and set the fields to provide parameter values for the CreateEnvironment method.

Use the CreateEnvironmentOptions.Builder to create a CreateEnvironmentOptions object that contains the parameter values for the createEnvironment method.

Query Parameters

  • version
    date

    A date (YYYY-MM-DD) that identifies the specific version of the API to use when processing the request.

Request Body

CreateEnvironmentRequest

An object that defines an environment name and optional description. The fields in this object are not approved for personal information and cannot be deleted based on customer ID.

Example:

CreateEnvironmentOptions

The CreateEnvironment options.

CreateEnvironmentOptions

The createEnvironment options.

parameters

  • name
    string

    Name that identifies the environment.

    Constraints: 0 ≤ length ≤ 255

  • description
    string

    Description of the environment.

    Default:

  • size
    string

    Size of the environment. In the Lite plan the default and only accepted value is LT, in all other plans the default is S.

    Allowable values: [LT,XS,S,MS,M,ML,L,XL,XXL,XXXL]

parameters

  • name
    str

    Name that identifies the environment.

    Constraints: 0 ≤ length ≤ 255

  • description
    str

    Description of the environment.

    Default:

  • size
    str

    Size of the environment. In the Lite plan the default and only accepted value is LT, in all other plans the default is S.

    Allowable values: [LT,XS,S,MS,M,ML,L,XL,XXL,XXXL]

parameters

  • name
    String

    Name that identifies the environment.

    Constraints: 0 ≤ length ≤ 255

  • description
    String

    Description of the environment.

    Default:

  • size
    String

    Size of the environment. In the Lite plan the default and only accepted value is LT, in all other plans the default is S.

    Allowable values: [LT,XS,S,MS,M,ML,L,XL,XXL,XXXL]

parameters

  • name
    String

    Name that identifies the environment.

    Constraints: 0 ≤ length ≤ 255

  • description
    String

    Description of the environment.

    Default:

  • size
    String

    Size of the environment. In the Lite plan the default and only accepted value is LT, in all other plans the default is S.

    Allowable values: [LT,XS,S,MS,M,ML,L,XL,XXL,XXXL]

parameters

  • name
    string

    Name that identifies the environment.

    Constraints: 0 ≤ length ≤ 255

  • description
    string

    Description of the environment.

    Default:

  • size
    string

    Size of the environment. In the Lite plan the default and only accepted value is LT, in all other plans the default is S.

    Allowable values: [LT,XS,S,MS,M,ML,L,XL,XXL,XXXL]

parameters

  • name
    string

    Name that identifies the environment.

    Constraints: 0 ≤ length ≤ 255

  • description
    string

    Description of the environment.

    Default:

  • size
    string

    Size of the environment. In the Lite plan the default and only accepted value is LT, in all other plans the default is S.

    Allowable values: [LT,XS,S,MS,M,ML,L,XL,XXL,XXXL]

Response

Response Body

Environment

Details about an environment.

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

ModelEnvironment

Details about an environment.

Example:

Status Code

  • 201

    Environment successfully added.

  • 400

    Bad request.

Example responses

List environments

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

List existing environments for the service instance.

GET /v1/environments
(discovery *DiscoveryV1) ListEnvironments(listEnvironmentsOptions *ListEnvironmentsOptions) (*core.DetailedResponse, error)
ServiceCall<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsOptions listEnvironmentsOptions)
listEnvironments(params, [callback()])
list_environments(self, name=None, **kwargs)
list_environments(name: nil)
func listEnvironments(
    name: String? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<ListEnvironmentsResponse>?, WatsonError?) -> Void)
ListEnvironments(string name = null)
ListEnvironments(Callback<ListEnvironmentsResponse> callback, string name = null)
Request

Instantiate the ListEnvironmentsOptions struct and set the fields to provide parameter values for the ListEnvironments method.

Use the ListEnvironmentsOptions.Builder to create a ListEnvironmentsOptions object that contains the parameter values for the listEnvironments method.

Query Parameters

  • version
    date

    A date (YYYY-MM-DD) that identifies the specific version of the API to use when processing the request.

  • name
    string

    Show only the environment with the given name.

ListEnvironmentsOptions

The ListEnvironments options.

ListEnvironmentsOptions

The listEnvironments options.

parameters

  • name
    string

    Show only the environment with the given name.

parameters

  • name
    str

    Show only the environment with the given name.

parameters

  • name
    String

    Show only the environment with the given name.

parameters

  • name
    String

    Show only the environment with the given name.

parameters

  • name
    string

    Show only the environment with the given name.

parameters

  • name
    string

    Show only the environment with the given name.

Response

Response Body

ListEnvironmentsResponse

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

ListEnvironmentsResponse

Example:

Status Code

  • 200

    Successful response.

  • 400

    Bad request.

Example responses

Get environment info

GET /v1/environments/{environment_id}
(discovery *DiscoveryV1) GetEnvironment(getEnvironmentOptions *GetEnvironmentOptions) (*core.DetailedResponse, error)
ServiceCall<Environment> getEnvironment(GetEnvironmentOptions getEnvironmentOptions)
getEnvironment(params, [callback()])
get_environment(self, environment_id, **kwargs)
get_environment(environment_id:)
func getEnvironment(
    environmentID: String,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<Environment>?, WatsonError?) -> Void)
GetEnvironment(string environmentId)
GetEnvironment(Callback<ModelEnvironment> callback, string environmentId)
Request

Instantiate the GetEnvironmentOptions struct and set the fields to provide parameter values for the GetEnvironment method.

Use the GetEnvironmentOptions.Builder to create a GetEnvironmentOptions object that contains the parameter values for the getEnvironment method.

Path Parameters

  • environment_id
    string

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression ^[a-zA-Z0-9_-]*$

Query Parameters

  • version
    date

    A date (YYYY-MM-DD) that identifies the specific version of the API to use when processing the request.

GetEnvironmentOptions

The GetEnvironment options.

GetEnvironmentOptions

The getEnvironment options.

parameters

  • environment_id
    string

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/

parameters

  • environment_id
    str

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/

parameters

  • environment_id
    String

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/

parameters

  • environmentID
    String

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/

parameters

  • environmentId
    string

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/

parameters

  • environmentId
    string

    The ID of the environment.

    Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/

Response

Response Body

Environment

Details about an environment.

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example:

Environment

Details about an environment.

Example: