com.ibm.watson.discovery.v2.model

Class DocumentClassifier

java.lang.Object

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

com.ibm.watson.discovery.v2.model.DocumentClassifier

All Implemented Interfaces:

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

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

Information about a document classifier.

Method Summary

Modifier and Type	Method and Description
String	getAnswerField() Gets the answerField.
String	getClassifierId() Gets the classifierId.
Date	getCreated() Gets the created.
String	getDescription() Gets the description.
List<DocumentClassifierEnrichment>	getEnrichments() Gets the enrichments.
ClassifierFederatedModel	getFederatedClassification() Gets the federatedClassification.
String	getLanguage() Gets the language.
String	getName() Gets the name.
List<String>	getRecognizedFields() Gets the recognizedFields.
String	getTestDataFile() Gets the testDataFile.
String	getTrainingDataFile() Gets the trainingDataFile.

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

getClassifierId

public String getClassifierId()

Gets the classifierId.

The Universally Unique Identifier (UUID) of the document classifier.

Returns:

the classifierId

getName

public String getName()

Gets the name.

A human-readable name of the document classifier.

Returns:

the name

getDescription

public String getDescription()

Gets the description.

A description of the document classifier.

Returns:

the description

getCreated

public Date getCreated()

Gets the created.

The date that the document classifier was created.

Returns:

the created

getLanguage

public String getLanguage()

Gets the language.

The language of the training data that is associated with the document classifier. Language is specified by using the ISO 639-1 language code, such as `en` for English or `ja` for Japanese.

Returns:

the language

getEnrichments

public List<DocumentClassifierEnrichment> getEnrichments()

Gets the enrichments.

An array of enrichments to apply to the data that is used to train and test the document classifier. The output from the enrichments is used as features by the classifier to classify the document content both during training and at run time.

Returns:

the enrichments

getRecognizedFields

public List<String> getRecognizedFields()

Gets the recognizedFields.

An array of fields that are used to train the document classifier. The same set of fields must exist in the training data, the test data, and the documents where the resulting document classifier enrichment is applied at run time.

Returns:

the recognizedFields

getAnswerField

public String getAnswerField()

Gets the answerField.

The name of the field from the training and test data that contains the classification labels.

Returns:

the answerField

getTrainingDataFile

public String getTrainingDataFile()

Gets the trainingDataFile.

Name of the CSV file with training data that is used to train the document classifier.

Returns:

the trainingDataFile

getTestDataFile

public String getTestDataFile()

Gets the testDataFile.

Name of the CSV file with data that is used to test the document classifier. If no test data is provided, a subset of the training data is used for testing purposes.

Returns:

the testDataFile

getFederatedClassification

public ClassifierFederatedModel getFederatedClassification()

Gets the federatedClassification.

An object with details for creating federated document classifier models.

Returns:

the federatedClassification