com.ibm.watson.developer_cloud.compare_comply.v1

Class CompareComply

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.compare_comply.v1.CompareComply

public class CompareComply
extends WatsonService

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

See Also:

Compare Comply

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
CompareComply(java.lang.String versionDate) Instantiates a new `CompareComply`.
CompareComply(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `CompareComply` with IAM.

Method Summary

Methods

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

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompareComply

public CompareComply(java.lang.String versionDate)

Instantiates a new `CompareComply`.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

CompareComply

public CompareComply(java.lang.String versionDate,
             IamOptions iamOptions)

Instantiates a new `CompareComply` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

iamOptions - the options for authenticating through IAM

Method Detail

convertToHtml

public ServiceCall<HTMLReturn> convertToHtml(ConvertToHtmlOptions convertToHtmlOptions)

Convert file to HTML. Uploads an input file. The response includes an HTML version of the document.

Parameters:

convertToHtmlOptions - the ConvertToHtmlOptions containing the options for the call

Returns:

a ServiceCall with a response type of HTMLReturn

classifyElements

public ServiceCall<ClassifyReturn> classifyElements(ClassifyElementsOptions classifyElementsOptions)

Classify the elements of a document. Uploads a file. The response includes an analysis of the document's structural and semantic elements.

Parameters:

classifyElementsOptions - the ClassifyElementsOptions containing the options for the call

Returns:

a ServiceCall with a response type of ClassifyReturn

extractTables

public ServiceCall<TableReturn> extractTables(ExtractTablesOptions extractTablesOptions)

Extract a document's tables. Uploads a file. The response includes an analysis of the document's tables.

Parameters:

extractTablesOptions - the ExtractTablesOptions containing the options for the call

Returns:

a ServiceCall with a response type of TableReturn

compareDocuments

public ServiceCall<CompareReturn> compareDocuments(CompareDocumentsOptions compareDocumentsOptions)

Compare two documents. Uploads two input files. The response includes JSON comparing the two documents. Uploaded files must be in the same file format.

Parameters:

compareDocumentsOptions - the CompareDocumentsOptions containing the options for the call

Returns:

a ServiceCall with a response type of CompareReturn

addFeedback

public 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 response type of FeedbackReturn

deleteFeedback

public ServiceCall<java.lang.Void> deleteFeedback(DeleteFeedbackOptions deleteFeedbackOptions)

Deletes a specified feedback entry.

Parameters:

deleteFeedbackOptions - the DeleteFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getFeedback

public ServiceCall<GetFeedback> getFeedback(GetFeedbackOptions getFeedbackOptions)

List a specified feedback entry.

Parameters:

getFeedbackOptions - the GetFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a response type of GetFeedback

listFeedback

public ServiceCall<FeedbackList> listFeedback(ListFeedbackOptions listFeedbackOptions)

List the feedback in documents.

Parameters:

listFeedbackOptions - the ListFeedbackOptions containing the options for the call

Returns:

a ServiceCall with a response type of FeedbackList

listFeedback

public ServiceCall<FeedbackList> listFeedback()

List the feedback in documents.

Returns:

a ServiceCall with a response type of FeedbackList

createBatch

public 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://console.bluemix.net/docs/services/cloud-object-storage/about-cos.html#about-ibm-cloud-object-storage). The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using batch processing](https://console.bluemix.net/docs/services/compare-comply/batching.html#before-you-batch).

Parameters:

createBatchOptions - the CreateBatchOptions containing the options for the call

Returns:

a ServiceCall with a response type of BatchStatus

getBatch

public ServiceCall<BatchStatus> getBatch(GetBatchOptions getBatchOptions)

Gets information about a specific batch-processing request. Gets information about a batch-processing request with a specified ID.

Parameters:

getBatchOptions - the GetBatchOptions containing the options for the call

Returns:

a ServiceCall with a response type of BatchStatus

listBatches

public ServiceCall<Batches> listBatches(ListBatchesOptions listBatchesOptions)

Gets the list of submitted batch-processing jobs. Gets the list of batch-processing jobs submitted by users.

Parameters:

listBatchesOptions - the ListBatchesOptions containing the options for the call

Returns:

a ServiceCall with a response type of Batches

listBatches

public ServiceCall<Batches> listBatches()

Gets the list of submitted batch-processing jobs. Gets the list of batch-processing jobs submitted by users.

Returns:

a ServiceCall with a response type of Batches

updateBatch

public ServiceCall<BatchStatus> updateBatch(UpdateBatchOptions updateBatchOptions)

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

Parameters:

updateBatchOptions - the UpdateBatchOptions containing the options for the call

Returns:

a ServiceCall with a response type of BatchStatus