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.

Method Summary

Modifier and Type	Method and Description
SduStatusCustomFields	getCustomFields() Gets the customFields.
Long	getTotalAnnotatedPages() Gets the totalAnnotatedPages.
Long	getTotalDocuments() Gets the totalDocuments.
Long	getTotalPages() Gets the totalPages.
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

getClass, notify, notifyAll, wait, wait, wait

Method Detail

isEnabled

public 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 Long getTotalAnnotatedPages()

Gets the totalAnnotatedPages.

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

Returns:

the totalAnnotatedPages

getTotalPages

public 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 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