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(value="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, its language, its processing state, and if there is an upgrade available for the base model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LanguageModel.Builder

Method Summary

Modifier and Type	Method and Description
BaseModelName	baseModelName() The Amazon Transcribe standard language model, or base model, used to create your custom language model.
String	baseModelNameAsString() The Amazon Transcribe standard language model, or base model, used to create your custom language model.
static LanguageModel.Builder	builder()
Instant	createTime() The date and time the specified custom language model was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
CLMLanguageCode	languageCode() The language code used to create your custom language model.
String	languageCodeAsString() The language code used to create your custom language model.
Instant	lastModifiedTime() The date and time the specified custom language model was last modified.
String	modelName() A unique name, chosen by you, for your custom language model.
ModelStatus	modelStatus() The status of the specified custom language model.
String	modelStatusAsString() The status of the specified custom language model.
List<SdkField<?>>	sdkFields()
static Class<? extends LanguageModel.Builder>	serializableBuilderClass()
LanguageModel.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	upgradeAvailability() Shows if a more current base model is available for use with the specified custom language model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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 U.S. 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 U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.

See Also:

CLMLanguageCode

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 U.S. 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 U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.

See Also:

CLMLanguageCode

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:

BaseModelName

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:

BaseModelName

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:

ModelStatus

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:

ModelStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<LanguageModel.Builder,LanguageModel>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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