com.ibm.watson.speech_to_text.v1.model

Class Grammar

java.lang.Object

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

com.ibm.watson.speech_to_text.v1.model.Grammar

All Implemented Interfaces:

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

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

Information about a grammar from a custom language model.

Nested Class Summary

Nested Classes

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

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

Constructor Summary

Constructors

Constructor and Description
Grammar()

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.

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

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

Grammar

public Grammar()

Method Detail

getName

public java.lang.String getName()

Gets the name.

The name of the grammar.

Returns:

the name

getOutOfVocabularyWords

public java.lang.Long getOutOfVocabularyWords()

Gets the outOfVocabularyWords.

The number of OOV words in the grammar. The value is `0` while the grammar is being processed.

Returns:

the outOfVocabularyWords

getStatus

public java.lang.String getStatus()

Gets the status.

The status of the grammar: * `analyzed`: The service successfully analyzed the grammar. The custom model can be trained with data from the grammar. * `being_processed`: The service is still analyzing the grammar. The service cannot accept requests to add new resources or to train the custom model. * `undetermined`: The service encountered an error while processing the grammar. The `error` field describes the failure.

Returns:

the status

getError

public java.lang.String getError()

Gets the error.

If the status of the grammar is `undetermined`, the following message: `Analysis of grammar '{grammar_name}' failed. Please try fixing the error or adding the grammar again by setting the 'allow_overwrite' flag to 'true'.`.

Returns:

the error