com.ibm.watson.discovery.v2.model

Class CollectionDetailsSmartDocumentUnderstanding

java.lang.Object

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

com.ibm.watson.discovery.v2.model.CollectionDetailsSmartDocumentUnderstanding

All Implemented Interfaces:

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

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

An object that describes the Smart Document Understanding model for a collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionDetailsSmartDocumentUnderstanding.Builder Builder.
static interface	CollectionDetailsSmartDocumentUnderstanding.Model Specifies the type of Smart Document Understanding (SDU) model that is enabled for the collection.

Method Summary

Modifier and Type	Method and Description
Boolean	enabled() Gets the enabled.
String	model() Gets the model.
CollectionDetailsSmartDocumentUnderstanding.Builder	newBuilder() New builder.

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

newBuilder

public CollectionDetailsSmartDocumentUnderstanding.Builder newBuilder()

New builder.

Returns:

a CollectionDetailsSmartDocumentUnderstanding builder

enabled

public Boolean enabled()

Gets the enabled.

When `true`, smart document understanding conversion is enabled for the collection.

Returns:

the enabled

model

public String model()

Gets the model.

Specifies the type of Smart Document Understanding (SDU) model that is enabled for the collection. The following types of models are supported:

* `custom`: A user-trained model is applied.

* `pre_trained`: A pretrained model is applied. This type of model is applied automatically to *Document Retrieval for Contracts* projects.

* `text_extraction`: An SDU model that extracts text and metadata from the content. This model is enabled in collections by default regardless of the types of documents in the collection (as long as the service plan supports SDU models).

You can apply user-trained or pretrained models to collections from the *Identify fields* page of the product user interface. For more information, see [the product documentation](/docs/discovery-data?topic=discovery-data-configuring-fields).

Returns:

the model