Introduction

IBM Watson™ Compare and Comply analyzes governing documents to provide details about critical aspects of the documents.

Java SDK version 7.0.0 only requires additional configuration to set the target. For details, see https://github.com/watson-developer-cloud/java-sdk#installation.

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

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

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

Maven

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

Gradle

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

GitHub

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

Installation

npm install ibm-watson

GitHub

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

Installation

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

GitHub

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

Installation

gem install ibm_watson

GitHub

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

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

GitHub

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

Cocoapods

pod 'IBMWatsonCompareComplyV1', '~> 2.0.3'

Carthage

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

Swift Package Manager

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

GitHub

Authentication

You authenticate by providing the API key for your service instance. A Compare and Comply for IBM Cloud Private cluster has a single instance of the service and a single API key.

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

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

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

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

CompareComply compareComply = new CompareComply("{version}");
compareComply.setUsernameAndPassword("apikey","{apikey}");
compareComply.setEndPoint("https://{icp_cluster_host}{:port}/compare-and-comply/api");

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

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

const compareComply = new CompareComplyV1({
  version: '{version}',
  username: 'apikey',
  password: '{apikey}',
  url: 'https://{icp_cluster_host}{:port}/compare-and-comply/api',
});

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

from ibm_watson import CompareComplyV1

compare_comply = CompareComplyV1(
    version='{version}',
    username='apikey',
    password='{apikey}',
    url='https://{icp_cluster_host}{:port}/compare-and-comply/api'
)

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

require "ibm_watson"

compare_comply = IBMWatson::CompareComplyV1.new(
  version: "{version}",
  username: "apikey",
  password: "{apikey}",
  url:"https://{icp_cluster_host}{:port}/compare-and-comply/api"
)

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

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

compareComply, compareComplyErr := comparecomplyv1.NewCompareComplyV1(&comparecomplyv1.CompareComplyV1Options{
  Version:  "{version}",
  Username: "apikey",
  Password: "{apikey}",
  URL:      "https://{icp_cluster_host}{:port}/compare-and-comply/api",
})

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

let compareComply = CompareComply(version: "{version}", apikey: "{apikey}")
compareComply.serviceURL = "https://{icp_cluster_host}{:port}/compare-and-comply/api"

Service endpoint

The service endpoint for Compare and Comply for IBM Cloud Private is always the following base URL:

https://{icp_cluster_host}{:port}/compare-and-comply/api

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

Use that URL in your requests to Compare and Comply for IBM Cloud Private.

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

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

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

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

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

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

Example

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

Example

CompareComply compareComply = new CompareComply("{version}");
compareComply.setUsernameAndPassword("apikey","{apikey}");
compareComply.setEndPoint("https://{icp_cluster_host}{:port}/compare-and-comply/api");

Example

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

const compareComply = new CompareComplyV1({
  version: '{version}',
  username: 'apikey',
  password: '{apikey}',
  url: 'https://{icp_cluster_host}{:port}/compare-and-comply/api',
});

Examples in the constructor and after instantiation

from ibm_watson import CompareComplyV1

compare_comply = CompareComplyV1(
    version='{version}',
    username='apikey',
    password='{apikey}',
    url='https://{icp_cluster_host}{:port}/compare-and-comply/api'
)

or

compare_comply.set_url('https://{icp_cluster_host}{:port}/compare-and-comply/api')

Examples in the constructor and after instantiation

require "ibm_watson"

compare_comply = IBMWatson::CompareComplyV1.new(
  version: "{version}",
  username: "apikey",
  password: "{apikey}",
  url:"https://{icp_cluster_host}{:port}/compare-and-comply/api"
)

or

compare_comply.url = "https://{icp_cluster_host}{:port}/compare-and-comply/api"

Examples in the constructor and after instantiation

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

compareComply, compareComplyErr := comparecomplyv1.NewCompareComplyV1(&comparecomplyv1.CompareComplyV1Options{
  Version:  "{version}",
  Username: "apikey",
  Password: "{apikey}",
  URL:      "https://{icp_cluster_host}{:port}/compare-and-comply/api",
})

or

compareComply.SetURL("https://{icp_cluster_host}{:port}/compare-and-comply/api")

Example

let compareComply = CompareComply(version: "{version}", apikey: "{apikey}")
compareComply.serviceURL = "https://{icp_cluster_host}{:port}/compare-and-comply/api"

Disabling SSL verification

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

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

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

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

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

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

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

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

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

You cannot disable SSL verification with the Swift SDK.

Example that disables SSL verification

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

Example that disables SSL verification

CompareComply compareComply = new CompareComply("{version}");
compareComply.setUsernameAndPassword("apikey","{apikey}");
compareComply.setEndPoint("https://{icp_cluster_host}{:port}/compare-and-comply/api");

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

Example that disables SSL verification

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

const compareComply = new CompareComplyV1({
  version: '{version}',
  username: 'apikey',
  password: '{apikey}',
  url: 'https://{icp_cluster_host}{:port}/compare-and-comply/api',
  disable_ssl_verification: true,
});

Example that disables SSL verification

from ibm_watson import CompareComplyV1

compare_comply = CompareComplyV1(
    version='{version}',
    username='apikey',
    password='{apikey}',
    url='https://{icp_cluster_host}{:port}/compare-and-comply/api'
)
compare_comply.disable_SSL_verification()

Example that disables SSL verification

require "ibm_watson"

compare_comply = IBMWatson::CompareComplyV1.new(
  version: "{version}",
  username: "apikey",
  password: "{apikey}",
  url:"https://{icp_cluster_host}{:port}/compare-and-comply/api"
)
compare_comply.configure_http_client(disable_ssl: true)

Example that disables SSL verification

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

compareComply, compareComplyErr := comparecomplyv1.NewCompareComplyV1(&comparecomplyv1.CompareComplyV1Options{
  Version:  "{version}",
  Username: "apikey",
  Password: "{apikey}",
  URL:      "https://{icp_cluster_host}{:port}/compare-and-comply/api",
})
compareComply.DisableSSLVerification()

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 Compare and Comply for IBM Cloud Private, 2018-10-15. In some cases, differences in earlier versions are noted in the descriptions of parameters and response models.

Error handling

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

ErrorResponse

Name Description
code
integer
The HTTP response code.
error
string
General description of an error.

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

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

When the Java SDK receives an error response from the Compare and Comply for IBM Cloud Private service, it generates an exception from the com.ibm.watson.developer_cloud.service.exception package. All service exceptions contain the following fields.

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

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

Error

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

The Python SDK generates an exception for any unsuccessful method invocation. When the Python SDK receives an error response from the Compare and Comply for IBM Cloud Private service, it generates an ApiException that contains the following fields.

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

When the Ruby SDK receives an error response from the Compare and Comply for IBM Cloud Private service, it generates an ApiException that contains the following fields.

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

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

Error

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

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.

Example error handling

try {
  // Invoke a Compare and Comply for IBM Cloud Private 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

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

Example error handling

from ibm_watson import ApiException
try:
    # Invoke a Compare and Comply for IBM Cloud Private 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 Compare and Comply for IBM Cloud Private 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/comparecomplyv1"

// Instantiate a service
compareComply, compareComplyErr := comparecomplyv1.NewCompareComplyV1(&compareComplyv1.CompareComplyV1Options{})

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

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

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

Example error handling

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

Data handling

Additional headers

Some Watson services accept special parameters in headers that are passed with the request.

You can pass request header parameters in all requests or in a single request to the service.

To pass a request header, use the --header (-H) option with a curl request.

To pass header parameters with every request, use the setDefaultHeaders method of the service object.

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

To pass header parameters with every request, specify the headers parameter when you create the service object.

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

To pass header parameters with every request, specify the set_default_headers method of the service object.

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

To pass header parameters with every request, specify the add_default_headers method of the service object.

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

To pass header parameters with every request, specify the SetDefaultHeaders method of the service object.

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

To pass header parameters with every request, add them to the defaultHeaders property of the service object.

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

Example header parameter in a request

curl -u "apikey:{apikey}" -X {request_method} --header "Request-Header: {header_value}" "https://{icp_cluster_host}{:port}/compare-and-comply/api/{method}"

Example header parameter in a request

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

Example header parameter in a request

const parameters = {
  {parameters}
};

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

Example header parameter in a request

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

Example header parameter in a request

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

Example header parameter in a request

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

Response details

Compare and Comply for IBM Cloud Private might return information to the application in response headers.

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

Example request to access response headers

curl -u "apikey:{apikey}" -X {request_method} --include "https://{icp_cluster_host}{:port}/compare-and-comply/api/{method}"

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

Example request to access response headers

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

To access information in the response headers, add the return_response parameter set to true and specify the headers attribute on the response object that is returned by the method.

Example request to access response headers

const parameters = {
  {parameters}
};

parameters.return_response = true;

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

compare_comply.set_detailed_response(True)
response = compare_comply.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 = compare_comply.methodName(parameters)
# Access response from methodName
print response.result
# Access information in response headers
print response.headers
# Access HTTP response status
print response.status

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

DetailedResponse

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

Example request to access response headers

import "github.com/IBM/go-sdk-core/core"
response, _ := comparecomplyv1.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 returned in each method's completionHandler.

Example request to access response headers

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

Data labels

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

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

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

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

Labeling data is used only by methods that accept customer data. For more information about Compare and Comply for IBM Cloud Private and labeling data, see Information security.

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

Synchronous and asynchronous requests

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

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

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

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

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

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

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

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

Example synchronous request

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

Example asynchronous request

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

Example synchronous request

response = compare_comply.method_name(parameters)

or

response = compare_comply.await.method_name(parameters)

Example asynchronous request

response = compare_comply.async.method_name(parameters)

Methods

Convert document to HTML

Converts a document to HTML.

Converts a document to HTML.

Converts a document to HTML.

Converts a document to HTML.

Converts a document to HTML.

Converts a document to HTML.

Converts a document to HTML.

POST /v1/html_conversion
ServiceCall<HTMLReturn> convertToHtml(ConvertToHtmlOptions convertToHtmlOptions)
convertToHtml(params, callback())
convert_to_html(self, file, filename=None, file_content_type=None, model_id=None, **kwargs)
convert_to_html(file:, filename: nil, file_content_type: nil, model_id: nil)
func convertToHTML(
    file: Data,
    filename: String,
    fileContentType: String? = nil,
    modelID: String? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<HTMLReturn>?, WatsonError?) -> Void)
(compareAndComply *CompareAndComplyV1) ConvertToHTML(convertToHTMLOptions *ConvertToHTMLOptions) (*core.DetailedResponse, error)
Request

Use the ConvertToHtmlOptions.Builder to create a ConvertToHtmlOptions object that contains the parameter values for the convertToHtml method.

Instantiate the ConvertToHTMLOptions struct and set the fields to provide parameter values for the ConvertToHTML method.

Query Parameters

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

    Constraints: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

Form Parameters

  • The document to convert.

The convertToHtml options.

parameters

  • The document to convert.

  • The filename for file.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff,text/plain]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

parameters

  • The document to convert.

  • The filename for file.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff,text/plain]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

parameters

  • The document to convert.

  • The filename for file.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff,text/plain]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

parameters

  • The document to convert.

  • The filename for file.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff,text/plain]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

The ConvertToHTML options.

Response

The HTML converted from an input document.

The HTML converted from an input document.

Example:

The HTML converted from an input document.

Example:

The HTML converted from an input document.

Example:

The HTML converted from an input document.

Example:

The HTML converted from an input document.

Example:

The HTML converted from an input document.

Example:

Status Code

  • Success

  • Unauthorized

  • Forbidden

  • Not found

  • Unsupported media type

Example responses

Classify the elements of a document

Analyzes the structural and semantic elements of a document.

Analyzes the structural and semantic elements of a document.

Analyzes the structural and semantic elements of a document.

Analyzes the structural and semantic elements of a document.

Analyzes the structural and semantic elements of a document.

Analyzes the structural and semantic elements of a document.

Analyzes the structural and semantic elements of a document.

POST /v1/element_classification
ServiceCall<ClassifyReturn> classifyElements(ClassifyElementsOptions classifyElementsOptions)
classifyElements(params, callback())
classify_elements(self, file, file_content_type=None, model_id=None, **kwargs)
classify_elements(file:, file_content_type: nil, model_id: nil)
func classifyElements(
    file: Data,
    fileContentType: String? = nil,
    modelID: String? = nil,
    headers: [String: String]? = nil,
    completionHandler: @escaping (WatsonResponse<ClassifyReturn>?, WatsonError?) -> Void)
(compareAndComply *CompareAndComplyV1) ClassifyElements(classifyElementsOptions *ClassifyElementsOptions) (*core.DetailedResponse, error)
Request

Use the ClassifyElementsOptions.Builder to create a ClassifyElementsOptions object that contains the parameter values for the classifyElements method.

Instantiate the ClassifyElementsOptions struct and set the fields to provide parameter values for the ClassifyElements method.

Query Parameters

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

    Constraints: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

Form Parameters

  • The document to classify.

The classifyElements options.

parameters

  • The document to classify.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

parameters

  • The document to classify.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

parameters

  • The document to classify.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

parameters

  • The document to classify.

  • The content type of file.

    Allowable values: [application/pdf,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,image/bmp,image/gif,image/jpeg,image/png,image/tiff]

  • The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

    Allowable values: [contracts,tables]

The ClassifyElements options.

Response

The analysis of objects returned by the Element Classification method.

The analysis of objects returned by the Element Classification method.

Example:

The analysis of objects returned by the Element Classification method.

Example:

The analysis of objects returned by the Element Classification method.

Example: