com.ibm.watson.discovery.v1.model

Class SduStatus

java.lang.Object

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

com.ibm.watson.discovery.v1.model.SduStatus

All Implemented Interfaces:

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

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

Object containing smart document understanding information for this collection.

Field Summary

Fields

Modifier and Type	Field and Description
protected SduStatusCustomFields	customFields
protected java.lang.Boolean	enabled
protected java.lang.Long	totalAnnotatedPages
protected java.lang.Long	totalDocuments
protected java.lang.Long	totalPages

Constructor Summary

Constructors

Constructor and Description
SduStatus()

Method Summary

Methods

Modifier and Type	Method and Description
SduStatusCustomFields	getCustomFields() Gets the customFields.
java.lang.Long	getTotalAnnotatedPages() Gets the totalAnnotatedPages.
java.lang.Long	getTotalDocuments() Gets the totalDocuments.
java.lang.Long	getTotalPages() Gets the totalPages.
java.lang.Boolean	isEnabled() Gets the enabled.

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

enabled

protected java.lang.Boolean enabled

totalAnnotatedPages

@SerializedName(value="total_annotated_pages")
protected java.lang.Long totalAnnotatedPages

totalPages

@SerializedName(value="total_pages")
protected java.lang.Long totalPages

totalDocuments

@SerializedName(value="total_documents")
protected java.lang.Long totalDocuments

customFields

@SerializedName(value="custom_fields")
protected SduStatusCustomFields customFields

Constructor Detail

SduStatus

public SduStatus()

Method Detail

isEnabled

public java.lang.Boolean isEnabled()

Gets the enabled.

When `true`, smart document understanding conversion is enabled for this collection. All collections created with a version date after `2019-04-30` have smart document understanding enabled. If `false`, documents added to the collection are converted using the **conversion** settings specified in the configuration associated with the collection.

Returns:

the enabled

getTotalAnnotatedPages

public java.lang.Long getTotalAnnotatedPages()

Gets the totalAnnotatedPages.

The total number of pages annotated using smart document understanding in this collection.

Returns:

the totalAnnotatedPages

getTotalPages

public java.lang.Long getTotalPages()

Gets the totalPages.

The current number of pages that can be used for training smart document understanding. The `total_pages` number is calculated as the total number of pages identified from the documents listed in the **total_documents** field.

Returns:

the totalPages

getTotalDocuments

public java.lang.Long getTotalDocuments()

Gets the totalDocuments.

The total number of documents in this collection that can be used to train smart document understanding. For **lite** plan collections, the maximum is the first 20 uploaded documents (not including HTML or JSON documents). For other plans, the maximum is the first 40 uploaded documents (not including HTML or JSON documents). When the maximum is reached, additional documents uploaded to the collection are not considered for training smart document understanding.

Returns:

the totalDocuments

getCustomFields

public SduStatusCustomFields getCustomFields()

Gets the customFields.

Information about custom smart document understanding fields that exist in this collection.

Returns:

the customFields