com.ibm.watson.developer_cloud.speech_to_text.v1.model

Class Corpus

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.speech_to_text.v1.model.Corpus

All Implemented Interfaces:

ObjectModel

public class Corpus
extends GenericModel

Corpus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Corpus.Status The status of the corpus: * `analyzed` indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus.

Constructor Summary

Constructors

Constructor and Description
Corpus()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getError() Gets the error.
java.lang.String	getName() Gets the name.
java.lang.Long	getOutOfVocabularyWords() Gets the outOfVocabularyWords.
java.lang.String	getStatus() Gets the status.
java.lang.Long	getTotalWords() Gets the totalWords.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Corpus

public Corpus()

Method Detail

getName

public java.lang.String getName()

Gets the name. The name of the corpus.

Returns:

the name

getTotalWords

public java.lang.Long getTotalWords()

Gets the totalWords. The total number of words in the corpus. The value is `0` while the corpus is being processed.

Returns:

the totalWords

getOutOfVocabularyWords

public java.lang.Long getOutOfVocabularyWords()

Gets the outOfVocabularyWords. The number of OOV words in the corpus. The value is `0` while the corpus is being processed.

Returns:

the outOfVocabularyWords

getStatus

public java.lang.String getStatus()

Gets the status. The status of the corpus: * `analyzed` indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * `being_processed` indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * `undetermined` indicates that the service encountered an error while processing the corpus.

Returns:

the status

getError

public java.lang.String getError()

Gets the error. If the status of the corpus is `undetermined`, the following message: `Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'`.

Returns:

the error