com.ibm.watson.compare_comply.v1

Class CompareComply

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.compare_comply.v1.CompareComply

public class CompareComply
extends com.ibm.cloud.sdk.core.service.BaseService

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

See Also:

Compare Comply

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVICE_NAME
static java.lang.String	DEFAULT_SERVICE_URL

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
CompareComply(java.lang.String version) Constructs an instance of the `CompareComply` client.
CompareComply(java.lang.String version, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `CompareComply` client.
CompareComply(java.lang.String version, java.lang.String serviceName) Constructs an instance of the `CompareComply` client.
CompareComply(java.lang.String version, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `CompareComply` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackReturn>	addFeedback(AddFeedbackOptions addFeedbackOptions) Add feedback.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassifyReturn>	classifyElements(ClassifyElementsOptions classifyElementsOptions) Classify the elements of a document.
com.ibm.cloud.sdk.core.http.ServiceCall<CompareReturn>	compareDocuments(CompareDocumentsOptions compareDocumentsOptions) Compare two documents.
com.ibm.cloud.sdk.core.http.ServiceCall<HTMLReturn>	convertToHtml(ConvertToHtmlOptions convertToHtmlOptions) Convert document to HTML.
com.ibm.cloud.sdk.core.http.ServiceCall<BatchStatus>	createBatch(CreateBatchOptions createBatchOptions) Submit a batch-processing request.
com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackDeleted>	deleteFeedback(DeleteFeedbackOptions deleteFeedbackOptions) Delete a specified feedback entry.
com.ibm.cloud.sdk.core.http.ServiceCall<TableReturn>	extractTables(ExtractTablesOptions extractTablesOptions) Extract a document's tables.
com.ibm.cloud.sdk.core.http.ServiceCall<BatchStatus>	getBatch(GetBatchOptions getBatchOptions) Get information about a specific batch-processing job.
com.ibm.cloud.sdk.core.http.ServiceCall<GetFeedback>	getFeedback(GetFeedbackOptions getFeedbackOptions) Get a specified feedback entry.
java.lang.String	getVersion() Gets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<Batches>	listBatches() List submitted batch-processing jobs.
com.ibm.cloud.sdk.core.http.ServiceCall<Batches>	listBatches(ListBatchesOptions listBatchesOptions) List submitted batch-processing jobs.
com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackList>	listFeedback() List the feedback in a document.
com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackList>	listFeedback(ListFeedbackOptions listFeedbackOptions) List the feedback in a document.
void	setVersion(java.lang.String version) Sets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<BatchStatus>	updateBatch(UpdateBatchOptions updateBatchOptions) Update a pending or active batch-processing job.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureHttpClient, configureService, createServiceCall, enableGzipCompression, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final java.lang.String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final java.lang.String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

CompareComply

public CompareComply(java.lang.String version)

Constructs an instance of the `CompareComply` client. The default service name is used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2018-10-15`.

CompareComply

public CompareComply(java.lang.String version,
                     com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `CompareComply` client. The default service name and specified authenticator are used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2018-10-15`.

authenticator - the Authenticator instance to be configured for this client

CompareComply

public CompareComply(java.lang.String version,
                     java.lang.String serviceName)

Constructs an instance of the `CompareComply` client. The specified service name is used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2018-10-15`.

serviceName - the service name to be used when configuring the client instance

CompareComply

public CompareComply(java.lang.String version,
                     java.lang.String serviceName,
                     com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `CompareComply` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2018-10-15`.

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

getVersion

public java.lang.String getVersion()

Gets the version.

Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2018-10-15`.

Returns:

the version

setVersion

public void setVersion(java.lang.String version)

Sets the version.

Parameters:

version - the new version

convertToHtml

public com.ibm.cloud.sdk.core.http.ServiceCall<HTMLReturn> convertToHtml(ConvertToHtmlOptions convertToHtmlOptions)

Convert document to HTML.

Converts a document to HTML.

Parameters:

convertToHtmlOptions - the ConvertToHtmlOptions containing the options for the call

Returns:

a ServiceCall with a result of type HTMLReturn

classifyElements

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassifyReturn> classifyElements(ClassifyElementsOptions classifyElementsOptions)

Classify the elements of a document.

Analyzes the structural and semantic elements of a document.

Parameters:

classifyElementsOptions - the ClassifyElementsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ClassifyReturn

extractTables

public com.ibm.cloud.sdk.core.http.ServiceCall<TableReturn> extractTables(ExtractTablesOptions extractTablesOptions)

Extract a document's tables.

Analyzes the tables in a document.

Parameters:

extractTablesOptions - the ExtractTablesOptions containing the options for the call

Returns:

a ServiceCall with a result of type TableReturn

compareDocuments

public com.ibm.cloud.sdk.core.http.ServiceCall<CompareReturn> compareDocuments(CompareDocumentsOptions compareDocumentsOptions)

Compare two documents.

Compares two input documents. Documents must be in the same format.

Parameters:

compareDocumentsOptions - the CompareDocumentsOptions containing the options for the call

Returns:

a ServiceCall with a result of type CompareReturn

addFeedback

public com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackReturn> addFeedback(AddFeedbackOptions addFeedbackOptions)

Add feedback.

Adds feedback in the form of _labels_ from a subject-matter expert (SME) to a governing document. **Important:** Feedback is not immediately incorporated into the training model, nor is it guaranteed to be incorporated at a later date. Instead, submitted feedback is used to suggest future updates to the training model.

Parameters:

addFeedbackOptions - the AddFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a result of type FeedbackReturn

listFeedback

public com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackList> listFeedback(ListFeedbackOptions listFeedbackOptions)

List the feedback in a document.

Lists the feedback in a document.

Parameters:

listFeedbackOptions - the ListFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a result of type FeedbackList

listFeedback

public com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackList> listFeedback()

List the feedback in a document.

Lists the feedback in a document.

Returns:

a ServiceCall with a result of type FeedbackList

getFeedback

public com.ibm.cloud.sdk.core.http.ServiceCall<GetFeedback> getFeedback(GetFeedbackOptions getFeedbackOptions)

Get a specified feedback entry.

Gets a feedback entry with a specified `feedback_id`.

Parameters:

getFeedbackOptions - the GetFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetFeedback

deleteFeedback

public com.ibm.cloud.sdk.core.http.ServiceCall<FeedbackDeleted> deleteFeedback(DeleteFeedbackOptions deleteFeedbackOptions)

Delete a specified feedback entry.

Deletes a feedback entry with a specified `feedback_id`.

Parameters:

deleteFeedbackOptions - the DeleteFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a result of type FeedbackDeleted

createBatch

public com.ibm.cloud.sdk.core.http.ServiceCall<BatchStatus> createBatch(CreateBatchOptions createBatchOptions)

Submit a batch-processing request.

Run Compare and Comply methods over a collection of input documents.

**Important:** Batch processing requires the use of the [IBM Cloud Object Storage service](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage). The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using batch processing](https://cloud.ibm.com/docs/compare-comply?topic=compare-comply-batching#before-you-batch).

Parameters:

createBatchOptions - the CreateBatchOptions containing the options for the call

Returns:

a ServiceCall with a result of type BatchStatus

listBatches

public com.ibm.cloud.sdk.core.http.ServiceCall<Batches> listBatches(ListBatchesOptions listBatchesOptions)

List submitted batch-processing jobs.

Lists batch-processing jobs submitted by users.

Parameters:

listBatchesOptions - the ListBatchesOptions containing the options for the call

Returns:

a ServiceCall with a result of type Batches

listBatches

public com.ibm.cloud.sdk.core.http.ServiceCall<Batches> listBatches()

List submitted batch-processing jobs.

Lists batch-processing jobs submitted by users.

Returns:

a ServiceCall with a result of type Batches

getBatch

public com.ibm.cloud.sdk.core.http.ServiceCall<BatchStatus> getBatch(GetBatchOptions getBatchOptions)

Get information about a specific batch-processing job.

Gets information about a batch-processing job with a specified ID.

Parameters:

getBatchOptions - the GetBatchOptions containing the options for the call

Returns:

a ServiceCall with a result of type BatchStatus

updateBatch

public com.ibm.cloud.sdk.core.http.ServiceCall<BatchStatus> updateBatch(UpdateBatchOptions updateBatchOptions)

Update a pending or active batch-processing job.

Updates a pending or active batch-processing job. You can rescan the input bucket to check for new documents or cancel a job.

Parameters:

updateBatchOptions - the UpdateBatchOptions containing the options for the call

Returns:

a ServiceCall with a result of type BatchStatus