com.ibm.watson.developer_cloud.speech_to_text.v1.model

Class ListWordsOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

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

All Implemented Interfaces:

ObjectModel

public class ListWordsOptions
extends 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.

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.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

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. You must make the request with service credentials created 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. * `corpora` shows only OOV that were extracted from corpora.

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 cURL, URL encode the `+` symbol as `%2B`.

Returns:

the sort