Package software.amazon.awssdk.services.transcribe.model

Class LanguageModel

java.lang.Object
software.amazon.awssdk.services.transcribe.model.LanguageModel
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LanguageModel.Builder,LanguageModel>
@Generated("software.amazon.awssdk:codegen") public final class LanguageModel extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LanguageModel.Builder,LanguageModel>

Provides information about a custom language model, including:

  • The base model name

  • When the model was created

  • The location of the files used to train the model

  • When the model was last modified

  • The name you chose for the model

  • The model's language

  • The model's processing state

  • Any available upgrades for the base model

See Also:

  • Method Details

    • modelName

      public final String modelName()

      A unique name, chosen by you, for your custom language model.

      This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

      Returns:
      A unique name, chosen by you, for your custom language model.

      This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    • createTime

      public final Instant createTime()

      The date and time the specified custom language model was created.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified custom language model was created.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time the specified custom language model was last modified.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified custom language model was last modified.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

    • languageCode

      public final CLMLanguageCode languageCode()

      The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      If the service returns an enum value that is not available in the current SDK version, languageCode will return CLMLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      If the service returns an enum value that is not available in the current SDK version, languageCode will return CLMLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      See Also:

    • baseModelName

      public final BaseModelName baseModelName()

      The Amazon Transcribe standard language model, or base model, used to create your custom language model.

      If the service returns an enum value that is not available in the current SDK version, baseModelName will return BaseModelName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from baseModelNameAsString().

      Returns:
      The Amazon Transcribe standard language model, or base model, used to create your custom language model.
      See Also:

    • baseModelNameAsString

      public final String baseModelNameAsString()

      The Amazon Transcribe standard language model, or base model, used to create your custom language model.

      If the service returns an enum value that is not available in the current SDK version, baseModelName will return BaseModelName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from baseModelNameAsString().

      Returns:
      The Amazon Transcribe standard language model, or base model, used to create your custom language model.
      See Also:

    • modelStatus

      public final ModelStatus modelStatus()

      The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

      If the service returns an enum value that is not available in the current SDK version, modelStatus will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelStatusAsString().

      Returns:
      The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.
      See Also:

    • modelStatusAsString

      public final String modelStatusAsString()

      The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

      If the service returns an enum value that is not available in the current SDK version, modelStatus will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelStatusAsString().

      Returns:
      The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.
      See Also:

    • upgradeAvailability

      public final Boolean upgradeAvailability()

      Shows if a more current base model is available for use with the specified custom language model.

      If false, your custom language model is using the most up-to-date base model.

      If true, there is a newer base model available than the one your language model is using.

      Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.

      Returns:
      Shows if a more current base model is available for use with the specified custom language model.

      If false, your custom language model is using the most up-to-date base model.

      If true, there is a newer base model available than the one your language model is using.

      Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.

    • failureReason

      public final String failureReason()

      If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

      Returns:
      If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

    • inputDataConfig

      public final InputDataConfig inputDataConfig()

      The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.

      Returns:
      The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.

    • toBuilder

      public LanguageModel.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LanguageModel.Builder,LanguageModel>
      Returns:
      a builder for type T

    • builder

      public static LanguageModel.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LanguageModel.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.