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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<AlignedElement>	alignedElements
protected java.util.List<Document>	documents
protected java.lang.String	modelId
protected java.lang.String	modelVersion
protected java.util.List<UnalignedElement>	unalignedElements

Constructor Summary

Constructors

Constructor and Description
CompareReturn()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<AlignedElement>	getAlignedElements() Gets the alignedElements.
java.util.List<Document>	getDocuments() Gets the documents.
java.lang.String	getModelId() Gets the modelId.
java.lang.String	getModelVersion() Gets the modelVersion.
java.util.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

modelId

@SerializedName(value="model_id")
protected java.lang.String modelId

modelVersion

@SerializedName(value="model_version")
protected java.lang.String modelVersion

documents

protected java.util.List<Document> documents

alignedElements

@SerializedName(value="aligned_elements")
protected java.util.List<AlignedElement> alignedElements

unalignedElements

@SerializedName(value="unaligned_elements")
protected java.util.List<UnalignedElement> unalignedElements

Constructor Detail

CompareReturn

public CompareReturn()

Method Detail

getModelId

public java.lang.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 java.lang.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 java.util.List<Document> getDocuments()

Gets the documents.

Information about the documents being compared.

Returns:

the documents

getAlignedElements

public java.util.List<AlignedElement> getAlignedElements()

Gets the alignedElements.

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

Returns:

the alignedElements

getUnalignedElements

public java.util.List<UnalignedElement> getUnalignedElements()

Gets the unalignedElements.

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

Returns:

the unalignedElements