public class Word
extends com.ibm.cloud.sdk.core.service.model.GenericModel
| Modifier and Type | Method and Description |
|---|---|
Long |
getCount()
Gets the count.
|
String |
getDisplayAs()
Gets the displayAs.
|
List<WordError> |
getError()
Gets the error.
|
List<String> |
getMappingOnly()
Gets the mappingOnly.
|
List<String> |
getSoundsLike()
Gets the soundsLike.
|
List<String> |
getSource()
Gets the source.
|
String |
getWord()
Gets the word.
|
public String getWord()
A word from the custom model's words resource. The spelling of the word is used to train the model.
public List<String> getMappingOnly()
(Optional) Parameter for custom words. You can use the 'mapping_only' key in custom words as a form of post processing. A boolean value that indicates whether the added word should be used to fine-tune the mode for selected next-gen models. This field appears in the response body only when it's 'For a custom model that is based on a previous-generation model', the mapping_only field is populated with the value set by the user, but would not be used.
public List<String> getSoundsLike()
An array of as many as five pronunciations for the word. * _For a custom model that is based on a previous-generation model_, in addition to sounds-like pronunciations that were added by a user, the array can include a sounds-like pronunciation that is automatically generated by the service if none is provided when the word is added to the custom model. * _For a custom model that is based on a next-generation model_, the array can include only sounds-like pronunciations that were added by a user.
public String getDisplayAs()
The spelling of the word that the service uses to display the word in a transcript. * _For a custom model that is based on a previous-generation model_, the field can contain an empty string if no display-as value is provided for a word that exists in the service's base vocabulary. In this case, the word is displayed as it is spelled. * _For a custom model that is based on a next-generation model_, the service uses the spelling of the word as the value of the display-as field when the word is added to the model.
public Long getCount()
_For a custom model that is based on a previous-generation model_, a sum of the number of times the word is found across all corpora and grammars. 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 or grammars, the count begins at `1`; if the word is added from a corpus or grammar first and later modified, the count reflects only the number of times it is found in corpora and grammars.
_For a custom model that is based on a next-generation model_, the `count` field for any word is always `1`.
public List<String> getSource()
An array of sources that describes how the word was added to the custom model's words resource. * _For a custom model that is based on previous-generation model,_ the field includes the name of each corpus and grammar from which the service extracted the word. For OOV that are added by multiple corpora or grammars, the names of all corpora and grammars are listed. If you modified or added the word directly, the field includes the string `user`. * _For a custom model that is based on a next-generation model,_ this field shows only `user` for custom words that were added directly to the custom model. Words from corpora and grammars are not added to the words resource for custom models that are based on next-generation models.
Copyright © 2024 IBM Cloud. All rights reserved.