Discovery v2 - IBM Cloud API Docs

Introduction

Last updated: 2021-03-16

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.

This documentation describes Java SDK major version 9. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes Node SDK major version 6. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes Python SDK major version 5. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes Ruby SDK major version 2. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes .NET Standard SDK major version 5. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes Go SDK major version 2. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes Swift SDK major version 4. For more information about how to update your code from the previous version, see the migration guide.

This documentation describes Unity SDK major version 5. For more information about how to update your code from the previous version, see the migration guide.

This API reference applies to Premium Discovery instances created after 16 July 2020. For more information about features in Discovery Premium instances created before that date, see the v1 API

This API reference applies to Premium Discovery instances created after 16 July 2020. For more information about features in Discovery Premium instances created before that date, see the v1 API.

This API reference applies to Premium Discovery instances created after 16 July 2020. For more information about features in Discovery Premium instances created after that date, see the v1 API.

This API reference applies to Premium Discovery instances created after 16 July 2020. For more information about features in Discovery Premium instances created before that date, see the v1 API.

This API reference applies to Premium Discovery instances created after 16 July 2020. For more information about features in Discovery Premium instances created after that date, see the v1 API.

This API reference applies to Premium Discovery instances created after 16 July 2020. For more information about features in Discovery Premium instances created before that date, see the v1 API.

The IBM Watson Unity SDK has the following requirements.

The SDK requires Unity version 2018.2 or later to support Transport Layer Security (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 doesn't support the WebGL projects. Change your build settings to any platform except WebGL.

For more 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>9.0.2</version>
</dependency>

Gradle

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

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@^6.0.3

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>=5.1.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@v2.0.2

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 'IBMWatsonDiscoveryV2', '~> 4.1.0'

Carthage

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

Swift Package Manager

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

.NET CLI

dotnet add package IBM.Watson.Discovery.v2 --version 5.1.0

PackageReference

<PackageReference Include="IBM.Watson.Discovery.v2" Version="5.1.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 services use IBM Cloud Identity and Access Management (IAM) to authenticate. With IBM Cloud Pak for Data, you pass a bearer token.

IBM Cloud

For IBM Cloud instances, you authenticate to the API by using IBM Cloud Identity and Access Management (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. For more information, see Authenticating to Watson services.

For testing and development, you can pass an API key directly.
For production use, unless you use the Watson SDKs, use an IAM token.

If you pass in an API key, use apikey for the username and the value of the API key as the password. For example, if the API key is f5sAznhrKQyvBFFaZbtF60m5tzLbqWhyALQawBg5TjRI in the service credentials, include the credentials in your call like this:

curl -u "apikey:f5sAznhrKQyvBFFaZbtF60m5tzLbqWhyALQawBg5TjRI"

For IBM Cloud instances, the SDK provides initialization methods for each form of authentication.

Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
Use the access token to manage the lifecycle yourself. You must periodically refresh the token.

For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.For more information, see IAM authentication with the SDK.

IBM Cloud. Replace {apikey} and {url} with your service credentials.

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

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

IamAuthenticator authenticator = new IamAuthenticator("{apikey}");
Discovery discovery = new Discovery("{version}", authenticator);
discovery.setServiceUrl("{url}");

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

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { IamAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new IamAuthenticator({
    apikey: '{apikey}',
  }),
  serviceUrl: '{url}',
});

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

from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('{apikey}')
discovery = DiscoveryV2(
    version='{version}',
    authenticator=authenticator
)

discovery.set_service_url('{url}')

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

require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::IamAuthenticator.new(
  apikey: "{apikey}"
)
discovery = DiscoveryV2.new(
  version: "{version}",
  authenticator: authenticator
)
discovery.service_url = "{url}"

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

import (
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.IamAuthenticator{
    ApiKey: "{apikey}",
  }

  options := &discoveryv2.DiscoveryV2Options{
    Version: "{version}",
    Authenticator: authenticator,
  }

  discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

  if discoveryErr != nil {
    panic(discoveryErr)
  }

  discovery.SetServiceURL("{url}")
}

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

let authenticator = WatsonIAMAuthenticator(apiKey: "{apikey}")
let discovery = Discovery(version: "{version}", authenticator: authenticator)
discovery.serviceURL = "{url}"

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

IamAuthenticator authenticator = new IamAuthenticator(
    apikey: "{apikey}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

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

var authenticator = new IamAuthenticator(
    apikey: "{apikey}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

Cloud Pak for Data

For Cloud Pak for Data, you pass a bearer token in an Authorization header to authenticate to the API. The token is associated with a username.

For testing and development, you can use the bearer token that's displayed in the Cloud Pak for Data web client. To find this token, view the details for the provisioned service instance. The details also include the service endpoint URL. Don't use this token in production because it does not expire.
For production use, create a user in the Cloud Pak for Data web client to use for authentication. Generate a token from that user's credentials with the POST preauth/validateAuth method.

For Cloud Pak for Data instances, pass either username and password credentials or a bearer token that you generate to authenticate to the API. Username and password credentials use basic authentication. However, the SDK manages the lifecycle of the token. Tokens are temporary security credentials. If you pass a token, you maintain the token lifecycle.

For production use, create a user in the Cloud Pak for Data web client to use for authentication, and decide which authentication mechanism to use.

To have the SDK manage the lifecycle of the token, use the username and password for that new user in your calls.
To manage the lifecycle of the token yourself, generate a token from that user's credentials. Call the POST preauth/validateAuth method to generate the token, and then pass the token in an Authorization header in your calls. You can see an example of the method on the Curl tab.

Don't use the bearer token that's displayed in the web client for the instance except during testing and development because that token does not expire.

To find your value for {cpd_cluster_host}, {:port}, and {instance_id}, view the service credentials by viewing the details for the provisioned service instance in the Cloud Pak for Data web client.

Cloud Pak for Data. Generating a bearer token. The response includes an accessToken property.

Replace {cpd_cluster_host} and {port} with the details for the service instance. Replace {username} and {password} with your Cloud Pak for Data credentials.

curl -k -u "{username}:{password}" "https://{cpd_cluster_host}{:port}/v1/preauth/validateAuth"

Authenticating to the API. Replace {accessToken} with your details.

curl -H "Authorization: Bearer {accessToken}" "{url}/v2/{method}"

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("{version}", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new CloudPakForDataAuthenticator({
    username: '{username}',
    password: '{password}',
    url: 'https://{cpd_cluster_host}{:port}',
  }),
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
    '{username}',
    '{password}',
    'https://{cpd_cluster_host}{:port}'
)

discovery = DiscoveryV2(
    version='{version}',
    authenticator=authenticator
)

discovery.set_service_url('https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api')

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)
discovery = DiscoveryV2.new(
  version: "{version}",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

import (
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL: "https://{cpd_cluster_host}{:port}",
    Username: "{username}",
    Password: "{password}",
  }

  options := &discoveryv2.DiscoveryV2Options{
    Version: "{version}",
    Authenticator: authenticator,
  }

  discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

  if discoveryErr != nil {
    panic(discoveryErr)
  }

  discovery.SetServiceURL("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api")
}

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

let authenticator = WatsonCloudPakForDataAuthenticator(username: "{username}", password: "{password}", url: "https://{cpd_cluster_host}{:port}")
let discovery = Discovery(version: "{version}", authenticator: authenticator)
discovery.serviceURL = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

Cloud Pak for Data. SDK managing the token.

Replace {username} and {password} with your Cloud Pak for Data credentials. Replace {version} with the service version date. For {cpd_cluster_host}, {port}, {release}, and {instance_id}, see Endpoint URLs.

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

Access between services

Your application might use more than one Watson service. You can grant access between services and you can grant access to more than one service for your applications.

For IBM Cloud services, the method to grant access between Watson services varies depending on the type of API key. For more information, see IAM access.

To grant access between IBM Cloud services, create an authorization between the services. For more information, see Granting access between services.
To grant access to your services by applications without using user credentials, create a service ID, add an API key, and assign access policies. For more information, see Creating and working with service IDs.

Make sure that you use an endpoint URL that includes the service instance ID (for example, https://api.us-south.discovery.watson.cloud.ibm.com/instances/6bbda3b3-d572-45e1-8c54-22d6ed9e52c2). You can find the instance ID in two places:

By clicking the service instance row in the Resource list. The instance ID is the GUID in the details pane.
By clicking the name of the service instance in the list and looking at the credentials URL.

If you don't see the instance ID in the URL, you can add new credentials from the Service credentials page.

Because the Cloud Pak for Data bearer token is associated with a username, you can use the token for all CPD Watson services that are associated with the username.

Endpoint URLs

Identify the base URL for your service instance.

IBM Cloud URLs

The base URLs come from the service instance. To find the URL, view the service credentials by clicking the name of the service in the Resource list. Use the value of the URL. Add the method to form the complete API endpoint for your request.

The following example URL represents a Discovery instance that is hosted in Washington DC:

https://api.us-east.discovery.watson.cloud.ibm.com/instances/6bbda3b3-d572-45e1-8c54-22d6ed9e52c2

The following URLs represent the base URLs for Discovery. When you call the API, use the URL that corresponds to the location of your service instance.

Dallas: https://api.us-south.discovery.watson.cloud.ibm.com
Washington DC: https://api.us-east.discovery.watson.cloud.ibm.com
Frankfurt: https://api.eu-de.discovery.watson.cloud.ibm.com
Sydney: https://api.au-syd.discovery.watson.cloud.ibm.com
Tokyo: https://api.jp-tok.discovery.watson.cloud.ibm.com
London: https://api.eu-gb.discovery.watson.cloud.ibm.com
Seoul: https://api.kr-seo.discovery.watson.cloud.ibm.com

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

Set the correct service URL by specifying the serviceUrl parameter when you create the service instance.

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

Set the correct service URL by specifying the service_url property of the service instance.

Set the correct service URL by calling the SetServiceURL() 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 SetServiceUrl() method of the service instance.

Dallas API endpoint example for services managed on IBM Cloud

curl -X {request_method} -u "apikey:{apikey}" "https://api.us-south.discovery.watson.cloud.ibm.com/instances/{instance_id}"

Your service instance might not use this URL

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

IamAuthenticator authenticator = new IamAuthenticator("{apikey}");
Discovery discovery = new Discovery("{version}", authenticator);
discovery.setServiceUrl("https://api.us-east.discovery.watson.cloud.ibm.com");

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { IamAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new IamAuthenticator({
    apikey: '{apikey}',
  }),
  serviceUrl: 'https://api.us-east.discovery.watson.cloud.ibm.com',
});

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('{apikey}')
discovery = DiscoveryV2(
    version='{version}',
    authenticator=authenticator
)

discovery.set_service_url('https://api.us-east.discovery.watson.cloud.ibm.com')

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::IamAuthenticator.new(
  apikey: "{apikey}"
)
discovery = DiscoveryV2.new(
  version: "{version}",
  authenticator: authenticator
)
discovery.service_url = "https://api.us-east.discovery.watson.cloud.ibm.com"

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

if discoveryErr != nil {
  panic(discoveryErr)
}

discovery.SetServiceURL("https://api.us-east.discovery.watson.cloud.ibm.com")

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

let authenticator = WatsonIAMAuthenticator(apiKey: "{apikey}")
let discovery = Discovery(version: "{version}", authenticator: authenticator)
discovery.serviceURL = "https://api.us-east.discovery.watson.cloud.ibm.com"

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

IamAuthenticator authenticator = new IamAuthenticator(
    apikey: "{apikey}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://api.us-east.discovery.watson.cloud.ibm.com");

Default URL

https://api.us-south.discovery.watson.cloud.ibm.com

Example for the Washington DC location

var authenticator = new IamAuthenticator(
    apikey: "{apikey}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://api.us-east.discovery.watson.cloud.ibm.com");

Cloud Pak for Data URLs

For services installed on Cloud Pak for Data, the base URLs come from the cluster and add-on service instance. The URL follows this pattern:

https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api

{cpd_cluster_host} represents the name or IP address of your deployed cluster. For Cloud Pak for Data System, use a hostname that resolves to an IP address in the cluster.
{port} represents the port number on which the service listens.
{release} represents the release name that was specified when the Helm chart was installed.
{instance_id} represents the identifier of the service instance.

To find the base URL, view the details for the service instance from the Cloud Pak for Data web client.

Use that URL in your requests to Discovery v2.

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

Set the correct service URL by specifying the serviceUrl parameter when you create the service instance.

Set the correct service URL by specifying 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 specifying 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 specifying 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.

Endpoint example for Cloud Pak for Data

curl -X {request_method} -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api/v2/{method}"

Endpoint example for Cloud Pak for Data

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("{version}", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

Endpoint example for Cloud Pak for Data

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new CloudPakForDataAuthenticator({
    username: '{username}',
    password: '{password}',
    url: 'https://{cpd_cluster_host}{:port}',
  }),
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

Endpoint example for Cloud Pak for Data

from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
    '{username}',
    '{password}',
    'https://{cpd_cluster_host}{:port}'
)

discovery = DiscoveryV2(
    version='{version}',
    authenticator=authenticator
)

discovery.set_service_url('https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api')

Endpoint example for Cloud Pak for Data

require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CLoudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)
discovery = DiscoveryV2.new(
  version: "{version}",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

Endpoint example for Cloud Pak for Data

discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

if discoveryErr != nil {
  panic(discoveryErr)
}

discovery.SetServiceURL("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api")

Endpoint example for Cloud Pak for Data

let authenticator = CloudPakForDataAuthenticator(username: "{username}", password: "{password}", url: "https://{cpd_cluster_host}{:port}")
let discovery = Discovery(version: "{version}", authenticator: authenticator)
discovery.serviceURL = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

Endpoint example for Cloud Pak for Data

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

Endpoint example for Cloud Pak for Data

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/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 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 disableSslVerification parameter to true when you create the service instance.

To disable SSL verification, specify True on the set_disable_ssl_verification method for the service instance.

To disable SSL verification, set the disable_ssl_verification parameter to true in the configure_http_client() method for the service instance.

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, 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 disableSslVerification parameter to true when you create the service instance.

To disable SSL verification, specify True on the set_disable_ssl_verification method for the service instance.

To disable SSL verification, set the disable_ssl_verification parameter to true in the configure_http_client() method for the service instance.

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.

Example to disable SSL verification with a service managed on IBM Cloud. Replace {apikey} and {url} with your service credentials.

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

Example to disable SSL verification with a service managed on IBM Cloud

IamAuthenticator authenticator = new IamAuthenticator("{apikey}");
Discovery discovery = new Discovery("{version}", authenticator);
discovery.setServiceUrl("{url}");

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

Example to disable SSL verification with a service managed on IBM Cloud

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { IamAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new IamAuthenticator({
    apikey: '{apikey}',
  }),
  serviceUrl: '{url}',
  disableSslVerification: true,
});

Example to disable SSL verification with a service managed on IBM Cloud

from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('{apikey}')
discovery = DiscoveryV2(
    version='{version}',
    authenticator=authenticator
)

discovery.set_service_url('{url}')

discovery.set_disable_ssl_verification(True)

Example to disable SSL verification with a service managed on IBM Cloud

require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::IamAuthenticator.new(
  apikey: "{apikey}"
)
discovery = DiscoveryV2.new(
  version: "{version}",
  authenticator: authenticator
)
discovery.service_url = "{url}"

discovery.configure_http_client(disable_ssl_verification: true)

Example to disable SSL verification with a service managed on IBM Cloud

discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

if discoveryErr != nil {
  panic(discoveryErr)
}

discovery.SetServiceURL("{url}")

discovery.DisableSSLVerification()

Example to disable SSL verification with a service managed on IBM Cloud

let authenticator = WatsonIAMAuthenticator(apiKey: "{apikey}")
let discovery = Discovery(version: "{version}", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.disableSSLVerification()

Example to disable SSL verification with a service managed on IBM Cloud

IamAuthenticator authenticator = new IamAuthenticator(
    apikey: "{apikey}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

discovery.DisableSslVerification(true);

Example to disable SSL verification with a service managed on IBM Cloud

var authenticator = new IamAuthenticator(
    apikey: "{apikey}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

discovery.DisableSslVerification = true;

Example to disable SSL verification with an installed service

curl -k -X {request_method} -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api/v2/{method}"

Example to disable SSL verification with an installed service

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("{version}", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api";

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

Example to disable SSL verification with an installed service

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new CloudPakForDataAuthenticator({
    username: '{username}',
    password: '{password}',
    url: 'https://{cpd_cluster_host}{:port}',
  }),
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
  disableSslVerification: true,
});

Example to disable SSL verification with an installed service

from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
    '{username}',
    '{password}'
)

discovery = DiscoveryV2(
    version='{version}',
    authenticator=authenticator
)

discovery.set_service_url('https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api')

discovery.set_disable_ssl_verification(True)

Example to disable SSL verification with an installed service

require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CLoudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)
discovery = DiscoveryV2.new(
  version: "{version}",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

discovery.configure_http_client(disable_ssl_verification: true)

Example to disable SSL verification with an installed service

discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

if discoveryErr != nil {
  panic(discoveryErr)
}

discovery.SetServiceURL("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api")

discovery.DisableSSLVerification()

Example to disable SSL verification with an installed service

let authenticator = WatsonCloudPakForDataAuthenticator(username: "{username}", password: "{password}", url: "https://{cpd_cluster_host}{:port}")
let discovery = Discovery(version: "{version}", authenticator: authenticator)
discovery.serviceURL = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

discovery.disableSSLVerification()

Example to disable SSL verification with an installed service

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

discovery.DisableSslVerification(true);

Example to disable SSL verification with an installed service

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

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-11-22. In some cases, differences in earlier versions are noted in the descriptions of parameters and response models.

Error handling

Discovery 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 invalid 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 with 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 with 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 with 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 with 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 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 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 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/discoveryv2"

// Instantiate a service
discovery, discoveryErr := discoveryv2.NewDiscoveryV2(options)

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

// Call a method
result, 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 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. See Data collection for an example use of this 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 -X {request_method} -H "Request-Header: {header_value}" "{url}/v2/{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

result, response, responseErr := discovery.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 for a service managed on IBM Cloud

IamAuthenticator authenticator = new IamAuthenticator(
    apikey: "{apikey}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

discovery.WithHeader("Custom-Header", "header_value");

Example header parameter in a request for an installed service

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

discovery.WithHeader("Custom-Header", "header_value");

Example header parameter in a request for a service managed on IBM Cloud

var authenticator = new IamAuthenticator(
    apikey: "{apikey}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

discovery.WithHeader("Custom-Header", "header_value");

Example header parameter in a request for an installed service

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

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 extra debugging information, include the --verbose (-v) option with the request.

Example request to access response headers

curl -X {request_method} {authentication_method} --include "{url}/v2/{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();

All response data is available in the Response<T> object that is returned by each 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

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"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)
result, response, responseErr := discovery.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 collection (IBM Cloud)

By default, Discovery service instances managed on IBM Cloud that are not part of Premium plans 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. Logging is disabled for services that are part of Premium plans.

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 with a service managed on IBM Cloud

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

Example request with a service managed on IBM Cloud

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

discovery.setDefaultHeaders(headers);

Example request with a service managed on IBM Cloud

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { IamAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  version: '{version}',
  authenticator: new IamAuthenticator({
    apikey: '{apikey}',
  }),
  serviceUrl: '{url}',
  headers: {
    'X-Watson-Learning-Opt-Out': 'true'
  }
});

Example request with a service managed on IBM Cloud

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

Example request with a service managed on IBM Cloud

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

Example request with a service managed on IBM Cloud

import "net/http"

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

Example request with a service managed on IBM Cloud

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

Example request with a service managed on IBM Cloud

IamAuthenticator authenticator = new IamAuthenticator(
    apikey: "{apikey}"
    );

DiscoveryService discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{url}");

discovery.WithHeader("X-Watson-Learning-Opt-Out", "true");

Example request with a service managed on IBM Cloud

var authenticator = new IamAuthenticator(
    apikey: "{apikey}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("{version}", authenticator);
discovery.SetServiceUrl("{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)

Lists existing collections for the specified project.

GET /v2/projects/{project_id}/collections

(discovery *DiscoveryV2) ListCollections(listCollectionsOptions *ListCollectionsOptions) (result *ListCollectionsResponse, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) ListCollectionsWithContext(ctx context.Context, listCollectionsOptions *ListCollectionsOptions) (result *ListCollectionsResponse, response *core.DetailedResponse, err error)

ServiceCall<ListCollectionsResponse> listCollections(ListCollectionsOptions listCollectionsOptions)

listCollections(params)

list_collections(self,
        project_id: str,
        **kwargs
    ) -> DetailedResponse

list_collections(project_id:)

func listCollections(
    projectID: String,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<ListCollectionsResponse>?, WatsonError?) -> Void)

ListCollections(string projectId)

ListCollections(Callback<ListCollectionsResponse> callback, string projectId)

Request

Instantiate the ListCollectionsOptions struct and set the fields to provide parameter values for the ListCollections method.

Use the ListCollectionsOptions.Builder to create a ListCollectionsOptions object that contains the parameter values for the listCollections method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameter

WithContext method only

ListCollectionsOptions

The ListCollections options.

ListCollectionsOptions

The listCollections options.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

Example request

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/collections?version=2019-11-29"

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");

var result = service.ListCollections(
    projectId: "{project_id}"
    );

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
  }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  result, _, responseErr := service.ListCollections(&discoveryv2.ListCollectionsOptions{
    ProjectID: core.StringPtr("{project_id}"),
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

ListCollectionsOptions options = new ListCollectionsOptions.Builder()
  .projectId("{project_id}")
  .build();

ListCollectionsResponse response = discovery.listCollections(options).execute().getResult();

System.out.println(response);

Example request

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
};

discovery.listCollections(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

response = discovery.list_collections(
  project_id='{project_id}'
).get_result()

print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

service_response = discovery.list_collections(
  project_id: "{project_id}"
)
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.listCollections(projectID: "{project_id}") {
  response, error in
  
  guard let collections = response?.result else {
    print(error?.localizedDescription ?? "unexpected error")
    return
  }

  print(collections)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

ListCollectionsResponse listCollectionsResponse = null;
service.ListCollections(
    callback: (DetailedResponse<ListCollectionsResponse> response, IBMError error) =>
    {
        Log.Debug("DiscoveryServiceV2", "ListCollections result: {0}", response.Response);
        listCollectionsResponse = response.Result;
    },
    projectId: "{project_id}"
);

while (listCollectionsResponse == null)
    yield return null;

Response

Response Body

ListCollectionsResponse

Response object containing an array of collection details.

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

ListCollectionsResponse

Response object containing an array of collection details.

Example:

View

Status Code

200
Successful response.
400
Bad request.

Example responses

Status 200

{
  "collections": [
    {
      "collection_id": "f1360220-ea2d-4271-9d62-89a910b13c37",
      "name": "example"
    }
  ]
}

Success example

{
  "collections": [
    {
      "collection_id": "f1360220-ea2d-4271-9d62-89a910b13c37",
      "name": "example"
    }
  ]
}

Create a new collection in the specified project.

POST /v2/projects/{project_id}/collections

(discovery *DiscoveryV2) CreateCollection(createCollectionOptions *CreateCollectionOptions) (result *CollectionDetails, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) CreateCollectionWithContext(ctx context.Context, createCollectionOptions *CreateCollectionOptions) (result *CollectionDetails, response *core.DetailedResponse, err error)

ServiceCall<CollectionDetails> createCollection(CreateCollectionOptions createCollectionOptions)

createCollection(params)

create_collection(self,
        project_id: str,
        name: str,
        *,
        description: str = None,
        language: str = None,
        enrichments: List['CollectionEnrichment'] = None,
        **kwargs
    ) -> DetailedResponse

create_collection(project_id:, name:, description: nil, language: nil, enrichments: nil)

func createCollection(
    projectID: String,
    name: String,
    description: String? = nil,
    language: String? = nil,
    enrichments: [CollectionEnrichment]? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<CollectionDetails>?, WatsonError?) -> Void)

CreateCollection(string projectId, string name, string description = null, string language = null, List<CollectionEnrichment> enrichments = null)

CreateCollection(Callback<CollectionDetails> callback, string projectId, string name, string description = null, string language = null, List<CollectionEnrichment> enrichments = null)

Request

Instantiate the CreateCollectionOptions struct and set the fields to provide parameter values for the CreateCollection method.

Use the CreateCollectionOptions.Builder to create a CreateCollectionOptions object that contains the parameter values for the createCollection method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

Request Body

CollectionDetails

An object that represents the collection to be created.

parameter

WithContext method only

CreateCollectionOptions

The CreateCollection options.

CreateCollectionOptions

The createCollection options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
string
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
string
A description of the collection.
language
string
The language of the collection.

Default: en
enrichments
An array of enrichments that are applied to this collection.

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
str
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
str
A description of the collection.
language
str
The language of the collection.

Default: en
enrichments
An array of enrichments that are applied to this collection.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
String
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
String
A description of the collection.
language
String
The language of the collection.

Default: en
enrichments
An array of enrichments that are applied to this collection.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
String
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
String
A description of the collection.
language
String
The language of the collection.

Default: en
enrichments
An array of enrichments that are applied to this collection.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
string
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
string
A description of the collection.
language
string
The language of the collection.

Default: en
enrichments
An array of enrichments that are applied to this collection.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
string
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
string
A description of the collection.
language
string
The language of the collection.

Default: en
enrichments
An array of enrichments that are applied to this collection.

Response

Response Body

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

Status Code

200
The collection has been successfully created
400
Bad request.
404
Project not found.

No Sample Response

This method does not specify any sample responses.

Get details about the specified collection.

GET /v2/projects/{project_id}/collections/{collection_id}

(discovery *DiscoveryV2) GetCollection(getCollectionOptions *GetCollectionOptions) (result *CollectionDetails, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) GetCollectionWithContext(ctx context.Context, getCollectionOptions *GetCollectionOptions) (result *CollectionDetails, response *core.DetailedResponse, err error)

ServiceCall<CollectionDetails> getCollection(GetCollectionOptions getCollectionOptions)

getCollection(params)

get_collection(self,
        project_id: str,
        collection_id: str,
        **kwargs
    ) -> DetailedResponse

get_collection(project_id:, collection_id:)

func getCollection(
    projectID: String,
    collectionID: String,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<CollectionDetails>?, WatsonError?) -> Void)

GetCollection(string projectId, string collectionId)

GetCollection(Callback<CollectionDetails> callback, string projectId, string collectionId)

Request

Instantiate the GetCollectionOptions struct and set the fields to provide parameter values for the GetCollection method.

Use the GetCollectionOptions.Builder to create a GetCollectionOptions object that contains the parameter values for the getCollection method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression ^[a-zA-Z0-9_-]*$
collection_id
string
The ID of the collection.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameter

WithContext method only

GetCollectionOptions

The GetCollection options.

GetCollectionOptions

The getCollection options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

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

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
str
The ID of the collection.

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

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
String
The ID of the collection.

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

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionID
String
The ID of the collection.

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

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

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

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

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

Response

Response Body

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

Status Code

200
Returns the specified collection details.
404
Collection or project not found.

No Sample Response

This method does not specify any sample responses.

Updates the specified collection's name, description, and enrichments.

POST /v2/projects/{project_id}/collections/{collection_id}

(discovery *DiscoveryV2) UpdateCollection(updateCollectionOptions *UpdateCollectionOptions) (result *CollectionDetails, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) UpdateCollectionWithContext(ctx context.Context, updateCollectionOptions *UpdateCollectionOptions) (result *CollectionDetails, response *core.DetailedResponse, err error)

ServiceCall<CollectionDetails> updateCollection(UpdateCollectionOptions updateCollectionOptions)

updateCollection(params)

update_collection(self,
        project_id: str,
        collection_id: str,
        *,
        name: str = None,
        description: str = None,
        enrichments: List['CollectionEnrichment'] = None,
        **kwargs
    ) -> DetailedResponse

update_collection(project_id:, collection_id:, name: nil, description: nil, enrichments: nil)

func updateCollection(
    projectID: String,
    collectionID: String,
    name: String? = nil,
    description: String? = nil,
    enrichments: [CollectionEnrichment]? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<CollectionDetails>?, WatsonError?) -> Void)

UpdateCollection(string projectId, string collectionId, string name = null, string description = null, List<CollectionEnrichment> enrichments = null)

UpdateCollection(Callback<CollectionDetails> callback, string projectId, string collectionId, string name = null, string description = null, List<CollectionEnrichment> enrichments = null)

Request

Instantiate the UpdateCollectionOptions struct and set the fields to provide parameter values for the UpdateCollection method.

Use the UpdateCollectionOptions.Builder to create a UpdateCollectionOptions object that contains the parameter values for the updateCollection method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression ^[a-zA-Z0-9_-]*$
collection_id
string
The ID of the collection.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

Request Body

UpdateCollection

An object that represents the collection to be created.

parameter

WithContext method only

UpdateCollectionOptions

The UpdateCollection options.

UpdateCollectionOptions

The updateCollection options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
string
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
string
A description of the collection.
enrichments
An array of enrichments that are applied to this collection.

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
str
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
str
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
str
A description of the collection.
enrichments
An array of enrichments that are applied to this collection.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
String
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
String
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
String
A description of the collection.
enrichments
An array of enrichments that are applied to this collection.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionID
String
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
String
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
String
A description of the collection.
enrichments
An array of enrichments that are applied to this collection.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
string
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
string
A description of the collection.
enrichments
An array of enrichments that are applied to this collection.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
name
string
The name of the collection.

Constraints: 0 ≤ length ≤ 255
description
string
A description of the collection.
enrichments
An array of enrichments that are applied to this collection.

Response

Response Body

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

CollectionDetails

A collection for storing documents.

Status Code

200
Returns the updated collection details.
400
Bad request.
404
Collection or project not found.

No Sample Response

This method does not specify any sample responses.

Deletes the specified collection from the project. All documents stored in the specified collection and not shared is also deleted.

DELETE /v2/projects/{project_id}/collections/{collection_id}

(discovery *DiscoveryV2) DeleteCollection(deleteCollectionOptions *DeleteCollectionOptions) (response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) DeleteCollectionWithContext(ctx context.Context, deleteCollectionOptions *DeleteCollectionOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteCollection(DeleteCollectionOptions deleteCollectionOptions)

deleteCollection(params)

delete_collection(self,
        project_id: str,
        collection_id: str,
        **kwargs
    ) -> DetailedResponse

delete_collection(project_id:, collection_id:)

func deleteCollection(
    projectID: String,
    collectionID: String,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<Void>?, WatsonError?) -> Void)

DeleteCollection(string projectId, string collectionId)

DeleteCollection(Callback<object> callback, string projectId, string collectionId)

Request

Instantiate the DeleteCollectionOptions struct and set the fields to provide parameter values for the DeleteCollection method.

Use the DeleteCollectionOptions.Builder to create a DeleteCollectionOptions object that contains the parameter values for the deleteCollection method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression ^[a-zA-Z0-9_-]*$
collection_id
string
The ID of the collection.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameter

WithContext method only

DeleteCollectionOptions

The DeleteCollection options.

DeleteCollectionOptions

The deleteCollection options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

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

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
str
The ID of the collection.

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

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
String
The ID of the collection.

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

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionID
String
The ID of the collection.

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

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

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

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

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

Response

Response type: object

Status Code

204
The collection has successfully been deleted.
404
Collection or project not found.

No Sample Response

This method does not specify any sample responses.

By using this method, you can construct queries. For details, see the Discovery documentation. The default query parameters are defined by the settings for this project, see the Discovery documentation for an overview of the standard default settings, and see the Projects API documentation for details about how to set custom default query settings.

POST /v2/projects/{project_id}/query

(discovery *DiscoveryV2) Query(queryOptions *QueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) QueryWithContext(ctx context.Context, queryOptions *QueryOptions) (result *QueryResponse, response *core.DetailedResponse, err error)

ServiceCall<QueryResponse> query(QueryOptions queryOptions)

query(params)

query(self,
        project_id: str,
        *,
        collection_ids: List[str] = None,
        filter: str = None,
        query: str = None,
        natural_language_query: str = None,
        aggregation: str = None,
        count: int = None,
        return_: List[str] = None,
        offset: int = None,
        sort: str = None,
        highlight: bool = None,
        spelling_suggestions: bool = None,
        table_results: 'QueryLargeTableResults' = None,
        suggested_refinements: 'QueryLargeSuggestedRefinements' = None,
        passages: 'QueryLargePassages' = None,
        **kwargs
    ) -> DetailedResponse

query(project_id:, collection_ids: nil, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, spelling_suggestions: nil, table_results: nil, suggested_refinements: nil, passages: nil)

func query(
    projectID: String,
    collectionIDs: [String]? = nil,
    filter: String? = nil,
    query: String? = nil,
    naturalLanguageQuery: String? = nil,
    aggregation: String? = nil,
    count: Int? = nil,
    `return`: [String]? = nil,
    offset: Int? = nil,
    sort: String? = nil,
    highlight: Bool? = nil,
    spellingSuggestions: Bool? = nil,
    tableResults: QueryLargeTableResults? = nil,
    suggestedRefinements: QueryLargeSuggestedRefinements? = nil,
    passages: QueryLargePassages? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<QueryResponse>?, WatsonError?) -> Void)

Query(string projectId, List<string> collectionIds = null, string filter = null, string query = null, string naturalLanguageQuery = null, string aggregation = null, long? count = null, List<string> _return = null, long? offset = null, string sort = null, bool? highlight = null, bool? spellingSuggestions = null, QueryLargeTableResults tableResults = null, QueryLargeSuggestedRefinements suggestedRefinements = null, QueryLargePassages passages = null)

Query(Callback<QueryResponse> callback, string projectId, List<string> collectionIds = null, string filter = null, string query = null, string naturalLanguageQuery = null, string aggregation = null, long? count = null, List<string> _return = null, long? offset = null, string sort = null, bool? highlight = null, bool? spellingSuggestions = null, QueryLargeTableResults tableResults = null, QueryLargeSuggestedRefinements suggestedRefinements = null, QueryLargePassages passages = null)

Request

Instantiate the QueryOptions struct and set the fields to provide parameter values for the Query method.

Use the QueryOptions.Builder to create a QueryOptions object that contains the parameter values for the query method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

Request Body

QueryLarge

An object that represents the query to be submitted.

parameter

WithContext method only

QueryOptions

The Query options.

QueryOptions

The query options.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collectionIds
string[]
A comma-separated list of collection IDs to be queried against.
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
naturalLanguageQuery
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
aggregation
string
An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
count
number
Number of results to return.
_return
string[]
A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.
offset
number
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.
sort
string
A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the bias parameter.
highlight
boolean
When true, a highlight field is returned for each result which contains the fields which match the query with  tags around the matching query terms.
spellingSuggestions
boolean
When true and the natural_language_query parameter is used, the natural_language_query parameter is spell checked. The most likely correction is returned in the suggested_query field of the response (if one exists).
QueryLargeTableResults
Configuration for table retrieval.
QueryLargeSuggestedRefinements
Configuration for suggested refinements.
QueryLargePassages
Configuration for passage retrieval.

parameters

project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collection_ids
List[str]
A comma-separated list of collection IDs to be queried against.
filter
str
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
str
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
natural_language_query
str
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
aggregation
str
An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
count
int
Number of results to return.
return_
List[str]
A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.
offset
int
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.
sort
str
A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the bias parameter.
highlight
bool
When true, a highlight field is returned for each result which contains the fields which match the query with  tags around the matching query terms.
spelling_suggestions
bool
When true and the natural_language_query parameter is used, the natural_language_query parameter is spell checked. The most likely correction is returned in the suggested_query field of the response (if one exists).
QueryLargeTableResults
Configuration for table retrieval.
QueryLargeSuggestedRefinements
Configuration for suggested refinements.
QueryLargePassages
Configuration for passage retrieval.

parameters

project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collection_ids
Array[String]
A comma-separated list of collection IDs to be queried against.
filter
String
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
String
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
natural_language_query
String
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
aggregation
String
An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
count
Fixnum
Number of results to return.
_return
Array[String]
A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.
offset
Fixnum
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.
sort
String
A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the bias parameter.
highlight
Boolean
When true, a highlight field is returned for each result which contains the fields which match the query with  tags around the matching query terms.
spelling_suggestions
Boolean
When true and the natural_language_query parameter is used, the natural_language_query parameter is spell checked. The most likely correction is returned in the suggested_query field of the response (if one exists).
QueryLargeTableResults
Configuration for table retrieval.
QueryLargeSuggestedRefinements
Configuration for suggested refinements.
QueryLargePassages
Configuration for passage retrieval.

parameters

projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collectionIDs
[String]
A comma-separated list of collection IDs to be queried against.
filter
String
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
String
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
naturalLanguageQuery
String
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
aggregation
String
An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
count
Int
Number of results to return.
`return`
[String]
A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.
offset
Int
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.
sort
String
A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the bias parameter.
highlight
Bool
When true, a highlight field is returned for each result which contains the fields which match the query with  tags around the matching query terms.
spellingSuggestions
Bool
When true and the natural_language_query parameter is used, the natural_language_query parameter is spell checked. The most likely correction is returned in the suggested_query field of the response (if one exists).
QueryLargeTableResults
Configuration for table retrieval.
QueryLargeSuggestedRefinements
Configuration for suggested refinements.
QueryLargePassages
Configuration for passage retrieval.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collectionIds
List<string>
A comma-separated list of collection IDs to be queried against.
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
naturalLanguageQuery
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
aggregation
string
An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
count
long?
Number of results to return.
_return
List<string>
A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.
offset
long?
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.
sort
string
A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the bias parameter.
highlight
bool?
When true, a highlight field is returned for each result which contains the fields which match the query with  tags around the matching query terms.
spellingSuggestions
bool?
When true and the natural_language_query parameter is used, the natural_language_query parameter is spell checked. The most likely correction is returned in the suggested_query field of the response (if one exists).
QueryLargeTableResults
Configuration for table retrieval.
QueryLargeSuggestedRefinements
Configuration for suggested refinements.
QueryLargePassages
Configuration for passage retrieval.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collectionIds
List<string>
A comma-separated list of collection IDs to be queried against.
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.
naturalLanguageQuery
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
aggregation
string
An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
count
long?
Number of results to return.
_return
List<string>
A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.
offset
long?
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.
sort
string
A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the bias parameter.
highlight
bool?
When true, a highlight field is returned for each result which contains the fields which match the query with  tags around the matching query terms.
spellingSuggestions
bool?
When true and the natural_language_query parameter is used, the natural_language_query parameter is spell checked. The most likely correction is returned in the suggested_query field of the response (if one exists).
QueryLargeTableResults
Configuration for table retrieval.
QueryLargeSuggestedRefinements
Configuration for suggested refinements.
QueryLargePassages
Configuration for passage retrieval.

Example request

curl -X POST -H "Authorization: Bearer {token}" -H "Content-Type: application/json" -d "{   \"collection_ids\": [      \"{collection_id_1}\",     \"{collection_id_2}\"   ],   \"query\": \"text:IBM\" }" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/query?version=2019-11-29"

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");

var result = service.Query(
    projectId: "{project_id}",
    query: "{field}:{value}"
    );

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
  }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  result, _, responseErr := service.Query(&discoveryv2.QueryOptions{
    ProjectID: core.StringPtr("{project_id}"),
    Query:     core.StringPtr("{field}:{value}"),
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

QueryOptions options = new QueryOptions.Builder()
  .projectId("{project_id}")
  .query("{field}:{value}")
  .build();

QueryResponse response = discovery.query(options).execute().getResult();

System.out.println(response);

Example request

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
  query: '{field}:{value}',
};

discovery.query(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

response = discovery.query(
  project_id='{project_id}',
  query='{field:value}'
).get_result()

print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

service_response = discovery.query(
  project_id: "{project_id}",
  qhery: "{field}:{value}"
)
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.query(projectID: "{project_id}") {
  response, error in
  
  guard let results = response?.result else {
    print(error?.localizedDescription ?? "unexpected error")
    return
  }

  print(results)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

QueryResponse queryResponse = null;
service.Query(
    callback: (DetailedResponse<QueryResponse> response, IBMError error) =>
    {
        Log.Debug("DiscoveryServiceV2", "Query result: {0}", response.Response);
        queryResponse = response.Result;
    },
    projectId: "{project_id}",
    query: "{field}:{value}"
);

while (queryResponse == null)
    yield return null;

Response

Response Body

QueryResponse

A response containing the documents and aggregations for the query.

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

QueryResponse

A response containing the documents and aggregations for the query.

Example:

View

Status Code

200
Query executed successfully.
400
Project has no collections.
404
Bad request.

Example responses

Status 200

{
  "matching_results": 24,
  "retrieval_details": {
    "document_retrieval_strategy": "untrained"
  },
  "results": [
    {
      "id": "watson-generated ID"
    }
  ],
  "aggregations": [
    {
      "type": "term",
      "field": "field",
      "count": 1,
      "results": [
        {
          "key": "active",
          "matching_results": 34
        }
      ]
    }
  ]
}

Success example

{
  "matching_results": 24,
  "retrieval_details": {
    "document_retrieval_strategy": "untrained"
  },
  "results": [
    {
      "id": "watson-generated ID"
    }
  ],
  "aggregations": [
    {
      "type": "term",
      "field": "field",
      "count": 1,
      "results": [
        {
          "key": "active",
          "matching_results": 34
        }
      ]
    }
  ]
}

Returns completion query suggestions for the specified prefix.

GET /v2/projects/{project_id}/autocompletion

(discovery *DiscoveryV2) GetAutocompletion(getAutocompletionOptions *GetAutocompletionOptions) (result *Completions, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) GetAutocompletionWithContext(ctx context.Context, getAutocompletionOptions *GetAutocompletionOptions) (result *Completions, response *core.DetailedResponse, err error)

ServiceCall<Completions> getAutocompletion(GetAutocompletionOptions getAutocompletionOptions)

getAutocompletion(params)

get_autocompletion(self,
        project_id: str,
        prefix: str,
        *,
        collection_ids: List[str] = None,
        field: str = None,
        count: int = None,
        **kwargs
    ) -> DetailedResponse

get_autocompletion(project_id:, prefix:, collection_ids: nil, field: nil, count: nil)

func getAutocompletion(
    projectID: String,
    `prefix`: String,
    collectionIDs: [String]? = nil,
    field: String? = nil,
    count: Int? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<Completions>?, WatsonError?) -> Void)

GetAutocompletion(string projectId, string prefix, List<string> collectionIds = null, string field = null, long? count = null)

GetAutocompletion(Callback<Completions> callback, string projectId, string prefix, List<string> collectionIds = null, string field = null, long? count = null)

Request

Instantiate the GetAutocompletionOptions struct and set the fields to provide parameter values for the GetAutocompletion method.

Use the GetAutocompletionOptions.Builder to create a GetAutocompletionOptions object that contains the parameter values for the getAutocompletion method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
prefix
string
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are
collection_ids
string[]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
string
The field in the result documents that autocompletion suggestions are identified from.
count
integer
The number of autocompletion suggestions to return.

Default: 5

parameter

WithContext method only

GetAutocompletionOptions

The GetAutocompletion options.

GetAutocompletionOptions

The getAutocompletion options.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
prefix
string
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are.
collectionIds
string[]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
string
The field in the result documents that autocompletion suggestions are identified from.
count
number
The number of autocompletion suggestions to return.

parameters

project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
prefix
str
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are.
collection_ids
List[str]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
str
The field in the result documents that autocompletion suggestions are identified from.
count
int
The number of autocompletion suggestions to return.

parameters

project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
prefix
String
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are.
collection_ids
Array[String]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
String
The field in the result documents that autocompletion suggestions are identified from.
count
Fixnum
The number of autocompletion suggestions to return.

parameters

projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
`prefix`
String
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are.
collectionIDs
[String]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
String
The field in the result documents that autocompletion suggestions are identified from.
count
Int
The number of autocompletion suggestions to return.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
prefix
string
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are.
collectionIds
List<string>
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
string
The field in the result documents that autocompletion suggestions are identified from.
count
long?
The number of autocompletion suggestions to return.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
prefix
string
The prefix to use for autocompletion. For example, the prefix Ho could autocomplete to Hot, Housing, or How do I upgrade. Possible completions are.
collectionIds
List<string>
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.
field
string
The field in the result documents that autocompletion suggestions are identified from.
count
long?
The number of autocompletion suggestions to return.

Example request

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/autocompletions?collection_ids={collection_id_1},{collection_id_2}&prefix=ab&version=2019-11-29"

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");

var result = service.GetAutocompletion(
    projectId: "{project_id}",
    prefix: "Ho",
    count: 5
    );

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
   }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  result, _, responseErr := service.GetAutocompletion(&discoveryv2.GetAutocompletionOptions{
    ProjectID: core.StringPtr("{project_id}"),
    Prefix:    core.StringPtr("Ho"),
    Count:     core.Int64Ptr(5),
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

GetAutocompletionOptions options = new GetAutocompletionOptions.Builder()
  .projectId("{project_id}")
  .prefix("Ho")
  .count(5L)
  .build();

Completions response = discovery.getAutocompletion(options).execute().getResult();

System.out.println(response);

Example request

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
  prefix: 'Ho',
  count: 5,
};

discovery.getAutocompletion(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

response = discovery.get_autocompletion(
  project_id='{project_id}',
  prefix='Ho',
  count=5
).get_result()

print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

service_response = discovery.get_autocompletion(
  project_id: "{project_id}",
  prefix: "Ho",
  count: 5
)
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.getAutocompletion(projectID: "{project_id}", collectionIDs: [collectionID], prefix: "Ho") {
  response, error in
  
  guard let suggestions = response?.result else {
    print(error?.localizedDescription ?? "unexpected error")
    return
  }

  print(suggestions)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

Completions completionsResponse = null;
service.GetAutocompletion(
    callback: (DetailedResponse<Completions> response, IBMError error) =>
    {
        Log.Debug("DiscoveryServiceV2", "GetAutocompletion result: {0}", response.Response);
        completionsResponse = response.Result;
    },
    projectId: "{project_id}",
    prefix: "Ho",
    count: 5
);

while (completionsResponse == null)
    yield return null;

Response

Response Body

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Completions

An object containing an array of autocompletion suggestions.

Status Code

200
Object containing array of possible completions.
400
The specified field does not exist.

No Sample Response

This method does not specify any sample responses.

Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when ingesting documents and performing relevance training.

GET /v2/projects/{project_id}/notices

(discovery *DiscoveryV2) QueryNotices(queryNoticesOptions *QueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) QueryNoticesWithContext(ctx context.Context, queryNoticesOptions *QueryNoticesOptions) (result *QueryNoticesResponse, response *core.DetailedResponse, err error)

ServiceCall<QueryNoticesResponse> queryNotices(QueryNoticesOptions queryNoticesOptions)

queryNotices(params)

query_notices(self,
        project_id: str,
        *,
        filter: str = None,
        query: str = None,
        natural_language_query: str = None,
        count: int = None,
        offset: int = None,
        **kwargs
    ) -> DetailedResponse

query_notices(project_id:, filter: nil, query: nil, natural_language_query: nil, count: nil, offset: nil)

func queryNotices(
    projectID: String,
    filter: String? = nil,
    query: String? = nil,
    naturalLanguageQuery: String? = nil,
    count: Int? = nil,
    offset: Int? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<QueryNoticesResponse>?, WatsonError?) -> Void)

QueryNotices(string projectId, string filter = null, string query = null, string naturalLanguageQuery = null, long? count = null, long? offset = null)

QueryNotices(Callback<QueryNoticesResponse> callback, string projectId, string filter = null, string query = null, string naturalLanguageQuery = null, long? count = null, long? offset = null)

Request

Instantiate the QueryNoticesOptions struct and set the fields to provide parameter values for the QueryNotices method.

Use the QueryNoticesOptions.Builder to create a QueryNoticesOptions object that contains the parameter values for the queryNotices method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
natural_language_query
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
integer
Number of results to return. The maximum for the count and offset values together in any one query is 10000

Default: 10
offset
integer
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000

parameter

WithContext method only

QueryNoticesOptions

The QueryNotices options.

QueryNoticesOptions

The queryNotices options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
naturalLanguageQuery
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
number
Number of results to return. The maximum for the count and offset values together in any one query is 10000.
offset
number
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
filter
str
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
str
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
natural_language_query
str
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
int
Number of results to return. The maximum for the count and offset values together in any one query is 10000.
offset
int
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
filter
String
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
String
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
natural_language_query
String
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
Fixnum
Number of results to return. The maximum for the count and offset values together in any one query is 10000.
offset
Fixnum
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
filter
String
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
String
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
naturalLanguageQuery
String
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
Int
Number of results to return. The maximum for the count and offset values together in any one query is 10000.
offset
Int
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
naturalLanguageQuery
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
long?
Number of results to return. The maximum for the count and offset values together in any one query is 10000.
offset
long?
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
filter
string
A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.
query
string
A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
naturalLanguageQuery
string
A natural language query that returns relevant documents by utilizing training data and natural language understanding.
count
long?
Number of results to return. The maximum for the count and offset values together in any one query is 10000.
offset
long?
The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

Example request

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/notices?natural_language_query=error&version=2019-11-29"

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");

var result = service.QueryNotices(
    projectId: "{project_id}",
    query: "{field}:{value}"
    );

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
  }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  result, _, responseErr := service.QueryNotices(&discoveryv2.QueryNoticesOptions{
    ProjectID: core.StringPtr("{project_id}"),
    Query:     core.StringPtr("{field}:{value}"),
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

QueryNoticesOptions options = new QueryNoticesOptions.Builder()
  .projectId("{project_id}")
  .query("{field}:{value}")
  .build();

QueryNoticesResponse response = discovery.queryNotices(options).execute().getResult();

System.out.println(response);

Example request

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
  query: '{field}:{value}',
};

discovery.queryNotices(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

response = discovery.query_notices(
  project_id='{project_id}',
  query='{field}:{value}'
).get_result()
print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

service_response = discovery.query_notices(
  project_id: "{project_id}",
)
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.queryNotices(projectID: "{project_id}", query: "{field}:{value}") {
  response, error in
  
  guard let notices = response?.result else {
    print(error?.localizedDescription ?? "unexpected error")
    return
  }

  print(notices)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

QueryNoticesResponse queryNoticesResponse = null;
service.QueryNotices(
    callback: (DetailedResponse<QueryNoticesResponse> response, IBMError error) =>
    {
        Log.Debug("DiscoveryServiceV2", "QueryNotices result: {0}", response.Response);
        queryNoticesResponse = response.Result;
    },
    projectId: "{project_id}",
    query: "{field}:{value}"
);

while (queryNoticesResponse == null)
    yield return null;

Response

Response Body

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

QueryNoticesResponse

Object containing notice query results.

Status Code

200
Query for notices executed successfully.
400
Bad request.

No Sample Response

This method does not specify any sample responses.

Gets a list of the unique fields (and their types) stored in the the specified collections.

GET /v2/projects/{project_id}/fields

(discovery *DiscoveryV2) ListFields(listFieldsOptions *ListFieldsOptions) (result *ListFieldsResponse, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) ListFieldsWithContext(ctx context.Context, listFieldsOptions *ListFieldsOptions) (result *ListFieldsResponse, response *core.DetailedResponse, err error)

ServiceCall<ListFieldsResponse> listFields(ListFieldsOptions listFieldsOptions)

listFields(params)

list_fields(self,
        project_id: str,
        *,
        collection_ids: List[str] = None,
        **kwargs
    ) -> DetailedResponse

list_fields(project_id:, collection_ids: nil)

func listFields(
    projectID: String,
    collectionIDs: [String]? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<ListFieldsResponse>?, WatsonError?) -> Void)

ListFields(string projectId, List<string> collectionIds = null)

ListFields(Callback<ListFieldsResponse> callback, string projectId, List<string> collectionIds = null)

Request

Instantiate the ListFieldsOptions struct and set the fields to provide parameter values for the ListFields method.

Use the ListFieldsOptions.Builder to create a ListFieldsOptions object that contains the parameter values for the listFields method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
collection_ids
string[]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

parameter

WithContext method only

ListFieldsOptions

The ListFields options.

ListFieldsOptions

The listFields options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionIds
string[]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_ids
List[str]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_ids
Array[String]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionIDs
[String]
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionIds
List<string>
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionIds
List<string>
Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

Example request

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/fields?collection_ids={collection_id_1},{collection_id_2}&version=2019-11-29"

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");

var result = service.ListFields(
    projectId: "{project_id}",
    collectionIds: new List<string>() { "{collection_id}" }
    );

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
  }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  result, _, responseErr := service.ListFields(&discoveryv2.ListFieldsOptions{
    ProjectID:     core.StringPtr("{project_id}"),
    CollectionIds: []string{"{collection_id}"},
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

ListFieldsOptions options = new ListFieldsOptions.Builder()
  .projectId("{project_id}")
  .addCollectionIds("{collection_id}")
  .build();

ListFieldsResponse response = discovery.listFields(options).execute().getResult();

System.out.println(response);

Example request

const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
  collectionIds: ['{collectionId}'],
};

discovery.listFields(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

response = discovery.list_fields(
  project_id='{project_id}',
  collection_ids=['{collection_id}']
).get_result()
print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

service_response = discovery.list_fields(
  project_id: "{project_id}",
  collection_ids: ["{collection_id}"]
)
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.listFields(projectID: "{project_id}") {
  response, error in

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

  print(notices)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

ListFieldsResponse listFieldsResponse = null;
service.ListFields(
    callback: (DetailedResponse<ListFieldsResponse> response, IBMError error) =>
    {
        Log.Debug("DiscoveryServiceV2", "ListFields result: {0}", response.Response);
        listFieldsResponse = response.Result;
    },
    projectId: "{project_id}",
    collectionIds: new List<string>() { "{collection_id}" }
);

while (listFieldsResponse == null)
    yield return null;

Response

Response Body

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

ListFieldsResponse

The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

Fields which contain nested objects are assigned a type of "nested".
Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

Status Code

200
The list of fetched fields.

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations:
- Fields which contain nested JSON objects are assigned a type of "nested".
- Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).
- Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).
400
Bad request.

No Sample Response

This method does not specify any sample responses.

Returns default configuration settings for components.

GET /v2/projects/{project_id}/component_settings

(discovery *DiscoveryV2) GetComponentSettings(getComponentSettingsOptions *GetComponentSettingsOptions) (result *ComponentSettingsResponse, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) GetComponentSettingsWithContext(ctx context.Context, getComponentSettingsOptions *GetComponentSettingsOptions) (result *ComponentSettingsResponse, response *core.DetailedResponse, err error)

ServiceCall<ComponentSettingsResponse> getComponentSettings(GetComponentSettingsOptions getComponentSettingsOptions)

getComponentSettings(params)

get_component_settings(self,
        project_id: str,
        **kwargs
    ) -> DetailedResponse

get_component_settings(project_id:)

func getComponentSettings(
    projectID: String,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<ComponentSettingsResponse>?, WatsonError?) -> Void)

GetComponentSettings(string projectId)

GetComponentSettings(Callback<ComponentSettingsResponse> callback, string projectId)

Request

Instantiate the GetComponentSettingsOptions struct and set the fields to provide parameter values for the GetComponentSettings method.

Use the GetComponentSettingsOptions.Builder to create a GetComponentSettingsOptions object that contains the parameter values for the getComponentSettings method.

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameter

WithContext method only

GetComponentSettingsOptions

The GetComponentSettings options.

GetComponentSettingsOptions

The getComponentSettings options.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

parameters

projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

Example request

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/component_settings?version=2019-11-29"

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");

var result = service.GetComponentSettings(
    projectId: "{project_id}"
    );

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
  }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  result, _, responseErr := service.GetComponentSettings(&discoveryv2.GetComponentSettingsOptions{
    ProjectID: core.StringPtr("{project_id}"),
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

GetComponentSettingsOptions options = new GetComponentSettingsOptions.Builder()
  .projectId("{project_id}")
  .build();

ComponentSettingsResponse response = discovery.getComponentSettings(options).execute().getResult();

System.out.println(response);

Example request

const fs = require('fs');
const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
};

discovery.getComponentSettings(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

response = discovery.get_component_settings(
  project_id='{project_id}'
).get_result()

print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

service_response = discovery.get_component_settings(
  project_id: "{project_id}"
)
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

discovery.getComponentSettings(projectID: "{project_id}") {
  response, error in
  
  guard let settings = response?.result else {
    print(error?.localizedDescription ?? "unexpected error")
    return
  }

  print(results)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

ComponentSettingsResponse componentSettingsResponse = null;
service.GetComponentSettings(
    callback: (DetailedResponse<ComponentSettingsResponse> response, IBMError error) =>
    {
        Log.Debug("DiscoveryServiceV2", "GetComponentSettings result: {0}", response.Response);
        componentSettingsResponse = response.Result;
    },
    projectId: "{project_id}"
);

while (componentSettingsResponse == null)
    yield return null;

Response

Response Body

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

ComponentSettingsResponse

The default component settings for this project.

Status Code

200
Successful response.

No Sample Response

This method does not specify any sample responses.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the /v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the /v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Add a document to a collection with optional metadata.

Returns immediately after the system has accepted the document for processing.

The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.
The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.
The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -
Fields with empty name values after normalization are filtered out before indexing.
Fields containing the following characters after normalization are filtered out before indexing: # and ,

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: Documents can be added with a specific document_id by using the _/v2/projects/{project_id}/collections/{collection_id}/documents method.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

POST /v2/projects/{project_id}/collections/{collection_id}/documents

(discovery *DiscoveryV2) AddDocument(addDocumentOptions *AddDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)

(discovery *DiscoveryV2) AddDocumentWithContext(ctx context.Context, addDocumentOptions *AddDocumentOptions) (result *DocumentAccepted, response *core.DetailedResponse, err error)

ServiceCall<DocumentAccepted> addDocument(AddDocumentOptions addDocumentOptions)

addDocument(params)

add_document(self,
        project_id: str,
        collection_id: str,
        *,
        file: BinaryIO = None,
        filename: str = None,
        file_content_type: str = None,
        metadata: str = None,
        x_watson_discovery_force: bool = None,
        **kwargs
    ) -> DetailedResponse

add_document(project_id:, collection_id:, file: nil, filename: nil, file_content_type: nil, metadata: nil, x_watson_discovery_force: nil)

func addDocument(
    projectID: String,
    collectionID: String,
    file: Data? = nil,
    filename: String? = nil,
    fileContentType: String? = nil,
    metadata: String? = nil,
    xWatsonDiscoveryForce: Bool? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<DocumentAccepted>?, WatsonError?) -> Void)

AddDocument(string projectId, string collectionId, System.IO.MemoryStream file = null, string filename = null, string fileContentType = null, string metadata = null, bool? xWatsonDiscoveryForce = null)

AddDocument(Callback<DocumentAccepted> callback, string projectId, string collectionId, System.IO.MemoryStream file = null, string filename = null, string fileContentType = null, string metadata = null, bool? xWatsonDiscoveryForce = null)

Request

Instantiate the AddDocumentOptions struct and set the fields to provide parameter values for the AddDocument method.

Use the AddDocumentOptions.Builder to create a AddDocumentOptions object that contains the parameter values for the addDocument method.

Custom Headers

X-Watson-Discovery-Force
boolean
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

Path Parameters

project_id
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression ^[a-zA-Z0-9_-]*$
collection_id
string
The ID of the collection.

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

Query Parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.

Form Parameters

file
binary
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
metadata
string
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }

parameter

WithContext method only

AddDocumentOptions

The AddDocument options.

AddDocumentOptions

The addDocument options.

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
file
NodeJS.ReadableStream | Buffer
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
filename
string
The filename for file.
fileContentType
string
The content type of file.

Allowable values: [application/json,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/html,application/xhtml+xml]
metadata
string
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }.
xWatsonDiscoveryForce
boolean
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

parameters

self.version
str
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
str
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
str
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
file
BinaryIO
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
filename
str
The filename for file.
file_content_type
str
The content type of file.

Allowable values: [application/json,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/html,application/xhtml+xml]
metadata
str
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }.
x_watson_discovery_force
bool
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
project_id
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collection_id
String
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
file
File
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
filename
String
The filename for file.
file_content_type
String
The content type of file.

Allowable values: [application/json,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/html,application/xhtml+xml]
metadata
String
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }.
x_watson_discovery_force
Boolean
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

parameters

version
String
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectID
String
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionID
String
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
file
Data
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
filename
String
The filename for file.
fileContentType
String
The content type of file.

Allowable values: [application/json,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/html,application/xhtml+xml]
metadata
String
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }.
xWatsonDiscoveryForce
Bool
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
file
System.IO.MemoryStream
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
filename
string
The filename for file.
fileContentType
string
The content type of file.

Allowable values: [application/json,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/html,application/xhtml+xml]
metadata
string
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }.
xWatsonDiscoveryForce
bool?
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

parameters

version
string
Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2019-11-22.
projectId
string
The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
collectionId
string
The ID of the collection.

Constraints: 1 ≤ length ≤ 255, Value must match regular expression /^[a-zA-Z0-9_-]*$/
file
System.IO.MemoryStream
The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.
filename
string
The filename for file.
fileContentType
string
The content type of file.

Allowable values: [application/json,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/html,application/xhtml+xml]
metadata
string
The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }.
xWatsonDiscoveryForce
bool?
When true, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Default: false

Example request

curl -X POST -H "Authorization: Bearer {token}" -F "file=@{filename}"  -F metadata="{\"field_name\": \"content\"}" "https://{cpd_cluster_host}:{port}/discovery/{release}/instance/{instance_id}/api/v2/projects/{project_id}/collections/{collection_id}/documents?version=2019-11-29"

Download example document sample1.html

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
    );

DiscoveryService service = new DiscoveryService("2019-11-22", authenticator);
service.SetServiceUrl("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}");


DetailedResponse<DocumentAccepted> result = null;
using (FileStream fs = File.OpenRead("path/to/file.pdf"))
{
    using (MemoryStream ms = new MemoryStream())
    {
        fs.CopyTo(ms);

        result = service.AddDocument(
            projectId: "{project_id}",
            collectionId: "{collection_id}",
            file: ms,
            filename: "example-file",
            fileContentType: "application/pdf"
            );
    }
}

Console.WriteLine(result.Response);

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/go-sdk-core/core"
  "github.com/watson-developer-cloud/go-sdk/discoveryv2"
  "os"
)

func main() {
  authenticator := &core.CloudPakForDataAuthenticator{
    URL:                    "https://{cpd_cluster_host}{:port}",
    Username:               "{username}",
    Password:               "{password}",
    DisableSSLVerification: true,
  }
  options := &discoveryv2.DiscoveryV2Options{
    Version:       "2019-11-22",
    Authenticator: authenticator,
  }
  service, serviceErr := discoveryv2.NewDiscoveryV2(options)
  if serviceErr != nil {
    panic(serviceErr)
  }
  service.SetServiceURL("{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}")

  file, fileErr := os.Open("path/to/file.pdf")
  if fileErr != nil {
    panic(fileErr)
  }
  defer file.Close()

  result, _, responseErr := service.AddDocument(&discoveryv2.AddDocumentOptions{
    ProjectID:       core.StringPtr("{project_id}"),
    CollectionID:    core.StringPtr("{collection_id}"),
    File:            file,
    Filename:        core.StringPtr("example-file"),
    FileContentType: core.StringPtr("application/pdf"),
  })
  if responseErr != nil {
    panic(responseErr)
  }
  b, _ := json.MarshalIndent(result, "", "  ")
  fmt.Println(string(b))
}

Example request

CloudPakForDataAuthenticator authenticator = new CloudPakForDataAuthenticator("https://{cpd_cluster_host}{:port}", "{username}", "{password}");
Discovery discovery = new Discovery("2019-11-22", authenticator);
discovery.setServiceUrl("https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api");

File examplePdf = new File("path/to/file.pdf");

AddDocumentOptions options = new AddDocumentOptions.Builder()
  .projectId("{project_id}")
  .collectionId("{collection_id}")
  .file(examplePdf)
  .filename("example-file")
  .fileContentType("application/pdf")
  .build();

DocumentAccepted response = discovery.addDocument(options).execute().getResult();

System.out.println(response);

Example request

const fs = require('fs');
const DiscoveryV2 = require('ibm-watson/discovery/v2');
const { CloudPakForDataAuthenticator } = require('ibm-watson/auth');

const discovery = new DiscoveryV2({
  authenticator: new CloudPakForDataAuthenticator({
    url: 'https://{cpd_cluster_host}{:port}',
    username: '{username}',
    password: '{password}',
  }),
  version: '2019-11-22',
  serviceUrl: 'https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api',
});

const params = {
  projectId: '{projectId}',
  collectionId: '{collectionId}',
  file: fs.createReadStream('path/to/file.pdf'),
  filename: 'example-file',
  fileContentType: 'application/pdf',
};

discovery.addDocument(params)
  .then(response => {
    console.log(JSON.stringify(response.result, null, 2));
  })
  .catch(err => {
    console.log('error:', err);
  });

Example request

import json
import os
from ibm_watson import DiscoveryV2
from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator

authenticator = CloudPakForDataAuthenticator(
                              '{username}',
                              '{password}',
                              'https://{cpd_cluster_host}{:port}',
                               disable_ssl_verification=True)
discovery = DiscoveryV2(
  version='2019-11-22',
  authenticator=authenticator
)
discovery.set_service_url('{https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api}')

with open(os.path.join(os.getcwd(), '{path_element}', '{filename}'),'rb') as fileinfo:
  response = discovery.add_document(
    project_id='{project_id}',
    collection_id='{}',
    file=fileinfo,
    filename='example-file',
    fileinfo='application/pdf'
  ).get_result()
  print(json.dumps(response, indent=2))

Example request

require "json"
require "ibm_watson/authenticators"
require "ibm_watson/discovery_v2"
include IBMWatson

authenticator = Authenticators::CloudPakForDataAuthenticator.new(
  username: "{username}",
  password: "{password}",
  url: "https://{cpd_cluster_host}{:port}"
)

discovery = DiscoveryV2.new(
  version: "2019-11-22",
  authenticator: authenticator
)
discovery.service_url = "https://{cpd_cluster_host}{:port}/discovery/{release}/instances/{instance_id}/api"

File.open(Dir.getwd + "path/to/file.pdf") do |file_info|
  service_response = discovery.add_document(
    project_id: "{project_id}",
    collection_id: "{collection_id}",
    file: file_info,
    filename: "example-file",
    file_content_type: "application/pdf"
  )
end
puts JSON.pretty_generate(service_response.result)

Example request

let authenticator = WatsonCloudPakForDataAuthenticator(username: username, password: password, url: url)

let discovery = Discovery(version: "2019-11-29", authenticator: authenticator)
discovery.serviceURL = "{url}"

let url = Bundle.main.url(forResource: "KennedySpeech", withExtension: "html")
let testDocument = try! Data(contentsOf: url!)

discovery.addDocument(projectID: "{project_id}", collectionID: "{collection_id}", file: testDocument, filename: "test_file", fileContentType: "application/html") {
  response, error in
  
  guard let results = response?.result else {
    print(error?.localizedDescription ?? "unexpected error")
    return
  }
  
  documentID = results.documentID

  print(results)
}

Example request

var authenticator = new CloudPakForDataAuthenticator(
    url: "https://{cpd_cluster_host}{:port}",
    username: "{username}",
    password: "{password}"
);

while (!authenticator.CanAuthenticate())
    yield return null;

var discovery = new DiscoveryService("2019-11-22", authenticator);
discovery.SetServiceUrl("{url}");

DocumentAccepted addDocumentResponse = null;
using (FileStream fs = File.OpenRead(watsonBeatsJeopardyHtmlFilePath))
{
    using (MemoryStream ms = new MemoryStream())
    {
        fs.CopyTo(ms);
        service.AddDocument(
            callback: (DetailedResponse<DocumentAccepted> response, IBMError error) =>
            {
                Log.Debug("DiscoveryServiceV2", "AddDocument result: {0}", response.Response);
                addDocumentResponse = response.Result;
                documentId = addDocumentResponse.DocumentId;
            },
            projectId: "{project_id}",
            collectionId: "{collection_id}",
            file: ms,
            fileContentType: "application/pdf",
            filename: "example-file"
        );

        while (addDocumentResponse == null)
            yield return null;
    }
}

Response

Response Body

DocumentAccepted

Information returned after an uploaded document is accepted.

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

DocumentAccepted

Information returned after an uploaded document is accepted.

Example:

View

Status Code

202
The document has been accepted and will be processed.
400
Bad request if the request is incorrectly formatted. The error message contains details about what caused the request to be rejected.
403
Forbidden. Returned if you attempt to add a document to a collection in a read-only project.
404
Not found. Returned if you attempt to add a document to a project that doesn't exist or if the collection specified isn't part of the specified project..
413
Too large. Returned if you attempt to add a document or document metadata that exceeds the maximum possible.
415
Unsupported. Returned if the media type of the uploaded document is not supported by Discovery..

Example responses

Status 202

{
  "document_id": "f1360220-ea2d-4271-9d62-89a910b13c37",
  "status": "processing"
}

Success example

{
  "document_id": "f1360220-ea2d-4271-9d62-89a910b13c37",
  "status": "processing"
}

Replace an existing document or add a document with a specified document_id. Starts ingesting a document with optional metadata.

If the document is uploaded to a collection that has it's data shared with another collection, the X-Watson-Discovery-Force header must be set to true.

Note: When uploading a new document with this method it automatically replaces any document stored with the same document_id if it exists.

Note: This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Note: If an uploaded document is segmented, all segments will be overwritten, even if the updated version of the document has fewer segments.