Package com.ibm.watson.speech_to_text.v1.model

Class ListWordsOptions

java.lang.Object

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

com.ibm.watson.speech_to_text.v1.model.ListWordsOptions

All Implemented Interfaces:

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

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

The listWords options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListWordsOptions.Builder	Builder.
static interface	ListWordsOptions.Sort	Indicates the order in which the words are to be listed, `alphabetical` or by `count`.
static interface	ListWordsOptions.WordType	The type of words to be listed from the custom language model's words resource: * `all` (the default) shows all words.

Method Summary

Modifier and Type	Method	Description
String	customizationId()	Gets the customizationId.
ListWordsOptions.Builder	newBuilder()	New builder.
String	sort()	Gets the sort.
String	wordType()	Gets the wordType.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public ListWordsOptions.Builder newBuilder()

New builder.

Returns:

a ListWordsOptions builder

customizationId

public String customizationId()

Gets the customizationId.

The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model.

Returns:

the customizationId

wordType

public String wordType()

Gets the wordType.

The type of words to be listed from the custom language model's words resource: * `all` (the default) shows all words. * `user` shows only custom words that were added or modified by the user directly. * `corpora` shows only OOV that were extracted from corpora. * `grammars` shows only OOV words that are recognized by grammars.

_For a custom model that is based on a next-generation model_, only `all` and `user` apply. Both options return the same results. Words from other sources are not added to custom models that are based on next-generation models.

Returns:

the wordType

sort

public String sort()

Gets the sort.

Indicates the order in which the words are to be listed, `alphabetical` or by `count`. You can prepend an optional `+` or `-` to an argument to indicate whether the results are to be sorted in ascending or descending order. By default, words are sorted in ascending alphabetical order. For alphabetical ordering, the lexicographical precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, values with the same count are ordered alphabetically. With the `curl` command, URL-encode the `+` symbol as `%2B`.

Returns:

the sort