Package com.oracle.bmc.aidocument.model

Class AnalyzeDocumentResult

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.aidocument.model.AnalyzeDocumentResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221109")
public final class AnalyzeDocumentResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The document analysis results.
Note: Objects should always be created or deserialized using the AnalyzeDocumentResult.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AnalyzeDocumentResult.Builder, which maintain a set of all explicitly set fields called AnalyzeDocumentResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalyzeDocumentResult.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

AnalyzeDocumentResult(DocumentMetadata documentMetadata, List<Page> pages, List<DetectedDocumentType> detectedDocumentTypes, List<DetectedLanguage> detectedLanguages, String documentClassificationModelVersion, String languageClassificationModelVersion, String textExtractionModelVersion, String keyValueExtractionModelVersion, String tableExtractionModelVersion, String signatureExtractionModelVersion, String barCodeExtractionModelVersion, List<ProcessingError> errors, byte[] searchablePdf)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static AnalyzeDocumentResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBarCodeExtractionModelVersion()	The document bar code extraction model version.
List<DetectedDocumentType>	getDetectedDocumentTypes()	An array of detected document types.
List<DetectedLanguage>	getDetectedLanguages()	An array of detected languages.
String	getDocumentClassificationModelVersion()	The document classification model version.
DocumentMetadata	getDocumentMetadata()
List<ProcessingError>	getErrors()	The errors encountered during document analysis.
String	getKeyValueExtractionModelVersion()	The document keyValue extraction model version.
String	getLanguageClassificationModelVersion()	The document language classification model version.
List<Page>	getPages()	The array of a Page.
byte[]	getSearchablePdf()	The searchable PDF file that was generated.
String	getSignatureExtractionModelVersion()	The document signature extraction model version.
String	getTableExtractionModelVersion()	The document table extraction model version.
String	getTextExtractionModelVersion()	The document text extraction model version.
int	hashCode()
AnalyzeDocumentResult.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzeDocumentResult

@Deprecated
@ConstructorProperties({"documentMetadata","pages","detectedDocumentTypes","detectedLanguages","documentClassificationModelVersion","languageClassificationModelVersion","textExtractionModelVersion","keyValueExtractionModelVersion","tableExtractionModelVersion","signatureExtractionModelVersion","barCodeExtractionModelVersion","errors","searchablePdf"})
public AnalyzeDocumentResult(DocumentMetadata documentMetadata,
                             List<Page> pages,
                             List<DetectedDocumentType> detectedDocumentTypes,
                             List<DetectedLanguage> detectedLanguages,
                             String documentClassificationModelVersion,
                             String languageClassificationModelVersion,
                             String textExtractionModelVersion,
                             String keyValueExtractionModelVersion,
                             String tableExtractionModelVersion,
                             String signatureExtractionModelVersion,
                             String barCodeExtractionModelVersion,
                             List<ProcessingError> errors,
                             byte[] searchablePdf)

Deprecated.

Method Detail

builder

public static AnalyzeDocumentResult.Builder builder()

Create a new builder.

toBuilder

public AnalyzeDocumentResult.Builder toBuilder()

getDocumentMetadata

public DocumentMetadata getDocumentMetadata()

getPages

public List<Page> getPages()

The array of a Page.

Returns:

the value

getDetectedDocumentTypes

public List<DetectedDocumentType> getDetectedDocumentTypes()

An array of detected document types.

Returns:

the value

getDetectedLanguages

public List<DetectedLanguage> getDetectedLanguages()

An array of detected languages.

Returns:

the value

getDocumentClassificationModelVersion

public String getDocumentClassificationModelVersion()

The document classification model version.

Returns:

the value

getLanguageClassificationModelVersion

public String getLanguageClassificationModelVersion()

The document language classification model version.

Returns:

the value

getTextExtractionModelVersion

public String getTextExtractionModelVersion()

The document text extraction model version.

Returns:

the value

getKeyValueExtractionModelVersion

public String getKeyValueExtractionModelVersion()

The document keyValue extraction model version.

Returns:

the value

getTableExtractionModelVersion

public String getTableExtractionModelVersion()

The document table extraction model version.

Returns:

the value

getSignatureExtractionModelVersion

public String getSignatureExtractionModelVersion()

The document signature extraction model version.

Returns:

the value

getBarCodeExtractionModelVersion

public String getBarCodeExtractionModelVersion()

The document bar code extraction model version.

Returns:

the value

getErrors

public List<ProcessingError> getErrors()

The errors encountered during document analysis.

Returns:

the value

getSearchablePdf

public byte[] getSearchablePdf()

The searchable PDF file that was generated.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel