com.ibm.watson.speech_to_text.v1.model

Class CreateLanguageModelOptions

java.lang.Object

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

com.ibm.watson.speech_to_text.v1.model.CreateLanguageModelOptions

All Implemented Interfaces:

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

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

The createLanguageModel options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLanguageModelOptions.BaseModelName The name of the base language model that is to be customized by the new custom language model.
static class	CreateLanguageModelOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	baseModelName() Gets the baseModelName.
String	description() Gets the description.
String	dialect() Gets the dialect.
String	name() Gets the name.
CreateLanguageModelOptions.Builder	newBuilder() New builder.

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 Detail

newBuilder

public CreateLanguageModelOptions.Builder newBuilder()

New builder.

Returns:

a CreateLanguageModelOptions builder

name

public String name()

Gets the name.

A user-defined name for the new custom language model. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as `Medical custom model` or `Legal custom model`. Use a name that is unique among all custom language models that you own.

Include a maximum of 256 characters in the name. Do not use backslashes, slashes, colons, equal signs, ampersands, or question marks in the name.

Returns:

the name

baseModelName

public String baseModelName()

Gets the baseModelName.

The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes.

To determine whether a base model supports language model customization, use the [Get a model](#getmodel) method and check that the attribute `custom_language_model` is set to `true`. You can also refer to [Language support for customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support).

Returns:

the baseModelName

dialect

public String dialect()

Gets the dialect.

The dialect of the specified language that is to be used with the custom language model. _For all languages, it is always safe to omit this field._ The service automatically uses the language identifier from the name of the base model. For example, the service automatically uses `en-US` for all US English models.

If you specify the `dialect` for a new custom model, follow these guidelines. _For non-Spanish previous-generation models and for next-generation models,_ you must specify a value that matches the five-character language identifier from the name of the base model. _For Spanish previous-generation models,_ you must specify one of the following values: * `es-ES` for Castilian Spanish (`es-ES` models) * `es-LA` for Latin American Spanish (`es-AR`, `es-CL`, `es-CO`, and `es-PE` models) * `es-US` for Mexican (North American) Spanish (`es-MX` models)

All values that you pass for the `dialect` field are case-insensitive.

Returns:

the dialect

description

public String description()

Gets the description.

A recommended description of the new custom language model. Use a localized description that matches the language of the custom model. Include a maximum of 128 characters in the description.

Returns:

the description