com.ibm.watson.speech_to_text.v1.model

Class Word

java.lang.Object

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

com.ibm.watson.speech_to_text.v1.model.Word

All Implemented Interfaces:

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

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

Information about a word from a custom language model.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	count
protected java.lang.String	displayAs
protected java.util.List<WordError>	error
protected java.util.List<java.lang.String>	soundsLike
protected java.util.List<java.lang.String>	source
protected java.lang.String	word

Constructor Summary

Constructors

Constructor and Description
Word()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getCount() Gets the count.
java.lang.String	getDisplayAs() Gets the displayAs.
java.util.List<WordError>	getError() Gets the error.
java.util.List<java.lang.String>	getSoundsLike() Gets the soundsLike.
java.util.List<java.lang.String>	getSource() Gets the source.
java.lang.String	getWord() Gets the word.

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

word

protected java.lang.String word

soundsLike

@SerializedName(value="sounds_like")
protected java.util.List<java.lang.String> soundsLike

displayAs

@SerializedName(value="display_as")
protected java.lang.String displayAs

count

protected java.lang.Long count

source

protected java.util.List<java.lang.String> source

error

protected java.util.List<WordError> error

Constructor Detail

Word

public Word()

Method Detail

getWord

public java.lang.String getWord()

Gets the word.

A word from the custom model's words resource. The spelling of the word is used to train the model.

Returns:

the word

getSoundsLike

public java.util.List<java.lang.String> getSoundsLike()

Gets the soundsLike.

An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically generated by the service if none is provided for the word; the service adds this pronunciation when it finishes processing the word.

Returns:

the soundsLike

getDisplayAs

public java.lang.String getDisplayAs()

Gets the displayAs.

The spelling of the word that the service uses to display the word in a transcript. The field contains an empty string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

Returns:

the displayAs

getCount

public java.lang.Long getCount()

Gets the count.

A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in one corpus and seven times in another, its count is `12`. If you add a custom word to a model before it is added by any corpora, the count begins at `1`; if the word is added from a corpus first and later modified, the count reflects only the number of times it is found in corpora.

Returns:

the count

getSource

public java.util.List<java.lang.String> getSource()

Gets the source.

An array of sources that describes how the word was added to the custom model's words resource. For OOV words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora are listed. If the word was modified or added by the user directly, the field includes the string `user`.

Returns:

the source

getError

public java.util.List<WordError> getError()

Gets the error.

If the service discovered one or more problems that you need to correct for the word's definition, an array that describes each of the errors.

Returns:

the error