com.amazonaws.services.transcribe.model

Class LanguageModel

java.lang.Object

com.amazonaws.services.transcribe.model.LanguageModel

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LanguageModel
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LanguageModel()

Method Summary

Modifier and Type	Method and Description
LanguageModel	clone()
boolean	equals(Object obj)
String	getBaseModelName() The Amazon Transcribe standard language model, or base model, used to create your custom language model.
Date	getCreateTime() The date and time the specified custom language model was created.
String	getFailureReason() If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed.
InputDataConfig	getInputDataConfig() 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.
String	getLanguageCode() The language code used to create your custom language model.
Date	getLastModifiedTime() The date and time the specified custom language model was last modified.
String	getModelName() A unique name, chosen by you, for your custom language model.
String	getModelStatus() The status of the specified custom language model.
Boolean	getUpgradeAvailability() Shows if a more current base model is available for use with the specified custom language model.
int	hashCode()
Boolean	isUpgradeAvailability() Shows if a more current base model is available for use with the specified custom language model.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBaseModelName(String baseModelName) The Amazon Transcribe standard language model, or base model, used to create your custom language model.
void	setCreateTime(Date createTime) The date and time the specified custom language model was created.
void	setFailureReason(String failureReason) If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed.
void	setInputDataConfig(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.
void	setLanguageCode(String languageCode) The language code used to create your custom language model.
void	setLastModifiedTime(Date lastModifiedTime) The date and time the specified custom language model was last modified.
void	setModelName(String modelName) A unique name, chosen by you, for your custom language model.
void	setModelStatus(String modelStatus) The status of the specified custom language model.
void	setUpgradeAvailability(Boolean upgradeAvailability) Shows if a more current base model is available for use with the specified custom language model.
String	toString() Returns a string representation of this object.
LanguageModel	withBaseModelName(BaseModelName baseModelName) The Amazon Transcribe standard language model, or base model, used to create your custom language model.
LanguageModel	withBaseModelName(String baseModelName) The Amazon Transcribe standard language model, or base model, used to create your custom language model.
LanguageModel	withCreateTime(Date createTime) The date and time the specified custom language model was created.
LanguageModel	withFailureReason(String failureReason) If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed.
LanguageModel	withInputDataConfig(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.
LanguageModel	withLanguageCode(CLMLanguageCode languageCode) The language code used to create your custom language model.
LanguageModel	withLanguageCode(String languageCode) The language code used to create your custom language model.
LanguageModel	withLastModifiedTime(Date lastModifiedTime) The date and time the specified custom language model was last modified.
LanguageModel	withModelName(String modelName) A unique name, chosen by you, for your custom language model.
LanguageModel	withModelStatus(ModelStatus modelStatus) The status of the specified custom language model.
LanguageModel	withModelStatus(String modelStatus) The status of the specified custom language model.
LanguageModel	withUpgradeAvailability(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LanguageModel

public LanguageModel()

Method Detail

setModelName

public void setModelName(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.

Parameters:

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.

getModelName

public String getModelName()

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.

withModelName

public LanguageModel withModelName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setCreateTime

public void setCreateTime(Date 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.

Parameters:

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.

getCreateTime

public Date getCreateTime()

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.

withCreateTime

public LanguageModel withCreateTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setLastModifiedTime

public void setLastModifiedTime(Date 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.

Parameters:

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.

getLastModifiedTime

public Date getLastModifiedTime()

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.

withLastModifiedTime

public LanguageModel withLastModifiedTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setLanguageCode

public void setLanguageCode(String 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.

Parameters:

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.

See Also:

CLMLanguageCode

getLanguageCode

public String getLanguageCode()

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.

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

withLanguageCode

public LanguageModel withLanguageCode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CLMLanguageCode

withLanguageCode

public LanguageModel withLanguageCode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CLMLanguageCode

setBaseModelName

public void setBaseModelName(String baseModelName)

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

Parameters:

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

See Also:

BaseModelName

getBaseModelName

public String getBaseModelName()

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

Returns:

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

See Also:

BaseModelName

withBaseModelName

public LanguageModel withBaseModelName(String baseModelName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BaseModelName

withBaseModelName

public LanguageModel withBaseModelName(BaseModelName baseModelName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BaseModelName

setModelStatus

public void setModelStatus(String modelStatus)

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

Parameters:

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

See Also:

ModelStatus

getModelStatus

public String getModelStatus()

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

Returns:

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

See Also:

ModelStatus

withModelStatus

public LanguageModel withModelStatus(String modelStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelStatus

withModelStatus

public LanguageModel withModelStatus(ModelStatus modelStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelStatus

setUpgradeAvailability

public void setUpgradeAvailability(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.

Parameters:

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.

getUpgradeAvailability

public Boolean getUpgradeAvailability()

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.

withUpgradeAvailability

public LanguageModel withUpgradeAvailability(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isUpgradeAvailability

public Boolean isUpgradeAvailability()

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.

setFailureReason

public void setFailureReason(String failureReason)

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

Parameters:

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

getFailureReason

public String getFailureReason()

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.

withFailureReason

public LanguageModel withFailureReason(String failureReason)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setInputDataConfig

public void setInputDataConfig(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.

Parameters:

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.

getInputDataConfig

public InputDataConfig getInputDataConfig()

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.

withInputDataConfig

public LanguageModel withInputDataConfig(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LanguageModel clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.