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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	customizationId
protected java.lang.String	sort
protected java.lang.String	wordType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListWordsOptions(ListWordsOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	customizationId() Gets the customizationId.
ListWordsOptions.Builder	newBuilder() New builder.
java.lang.String	sort() Gets the sort.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

customizationId

protected java.lang.String customizationId

wordType

protected java.lang.String wordType

sort

protected java.lang.String sort

Constructor Detail

ListWordsOptions

protected ListWordsOptions(ListWordsOptions.Builder builder)

Method Detail

newBuilder

public ListWordsOptions.Builder newBuilder()

New builder.

Returns:

a ListWordsOptions builder

customizationId

public java.lang.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 java.lang.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.

Returns:

the wordType

sort

public java.lang.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