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

  • Method Details

    • 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 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 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#custom-language-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 most languages, the dialect matches the language of the base model by default. For example, `en-US` is used for the US English language models. All dialect values are case-insensitive.

      The parameter is meaningful only for Spanish language models, for which you can always safely omit the parameter to have the service create the correct mapping. For Spanish, 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)

      If you specify the `dialect` parameter for a non-Spanish language model, its value must match the language of the base model. If you specify the `dialect` for a Spanish language model, its value must match one of the defined mappings (`es-ES`, `es-LA`, or `es-MX`).

      Returns:
      the dialect

    • description

      public 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