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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseModelName
protected java.lang.String	description
protected java.lang.String	dialect
protected java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	baseModelName() Gets the baseModelName.
java.lang.String	description() Gets the description.
java.lang.String	dialect() Gets the dialect.
java.lang.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

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

Field Detail

name

protected java.lang.String name

baseModelName

protected java.lang.String baseModelName

dialect

protected java.lang.String dialect

description

protected java.lang.String description

Constructor Detail

CreateLanguageModelOptions

protected CreateLanguageModelOptions(CreateLanguageModelOptions.Builder builder)

Method Detail

newBuilder

public CreateLanguageModelOptions.Builder newBuilder()

New builder.

Returns:

a CreateLanguageModelOptions builder

name

public java.lang.String name()

Gets the name.

A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. 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`.

Returns:

the name

baseModelName

public java.lang.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** 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-customization#languageSupport).

Returns:

the baseModelName

dialect

public java.lang.String dialect()

Gets the dialect.

The dialect of the specified language that is to be used with the custom language model. For most languages, the dialect matches the language of the base model by default. For example, `en-US` is used for either of the US English language models.

For a Spanish language, the service creates a custom language model that is suited for speech in one of the following dialects: * `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)

The parameter is meaningful only for Spanish models, for which you can always safely omit the parameter to have the service create the correct mapping.

If you specify the `dialect` parameter for non-Spanish language models, its value must match the language of the base model. If you specify the `dialect` for Spanish language models, its value must match one of the defined mappings as indicated (`es-ES`, `es-LA`, or `es-MX`). All dialect values are case-insensitive.

Returns:

the dialect

description

public java.lang.String description()

Gets the description.

A description of the new custom language model. Use a localized description that matches the language of the custom model.

Returns:

the description