Package com.ibm.watson.compare_comply.v1.model

Class CompareReturn

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.compare_comply.v1.model.CompareReturn

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CompareReturn
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The comparison of the two submitted documents.

Constructor Summary

Constructors

Constructor	Description
CompareReturn()

Method Summary

Modifier and Type	Method	Description
List<AlignedElement>	getAlignedElements()	Gets the alignedElements.
List<Document>	getDocuments()	Gets the documents.
String	getModelId()	Gets the modelId.
String	getModelVersion()	Gets the modelVersion.
List<UnalignedElement>	getUnalignedElements()	Gets the unalignedElements.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CompareReturn

public CompareReturn()

Method Details

getModelId

public String getModelId()

Gets the modelId.

The analysis model used to compare the input documents. For the **Compare two documents** method, the only valid value is `contracts`.

Returns:

the modelId

getModelVersion

public String getModelVersion()

Gets the modelVersion.

The version of the analysis model identified by the value of the `model_id` key.

Returns:

the modelVersion

getDocuments

public List<Document> getDocuments()

Gets the documents.

Information about the documents being compared.

Returns:

the documents

getAlignedElements

public List<AlignedElement> getAlignedElements()

Gets the alignedElements.

A list of pairs of elements that semantically align between the compared documents.

Returns:

the alignedElements

getUnalignedElements

public List<UnalignedElement> getUnalignedElements()

Gets the unalignedElements.

A list of elements that do not semantically align between the compared documents.

Returns:

the unalignedElements