com.ibm.watson.speech_to_text.v1.model

Class Corpus

java.lang.Object

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

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

All Implemented Interfaces:

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

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

Information about a corpus from a custom language model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Corpus.Status The status of the corpus: * `analyzed`: The service successfully analyzed the corpus.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	error
protected java.lang.String	name
protected java.lang.Long	outOfVocabularyWords
protected java.lang.String	status
protected java.lang.Long	totalWords

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

name

protected java.lang.String name

totalWords

@SerializedName(value="total_words")
protected java.lang.Long totalWords

outOfVocabularyWords

@SerializedName(value="out_of_vocabulary_words")
protected java.lang.Long outOfVocabularyWords

status

protected java.lang.String status

error

protected java.lang.String error

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`: The service successfully analyzed the corpus. The custom model can be trained with data from the corpus. * `being_processed`: The service is still analyzing the corpus. The service cannot accept requests to add new resources or to train the custom model. * `undetermined`: The service encountered an error while processing the corpus. The `error` field describes the failure.

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