software.amazon.awssdk.services.transcribe.model

Interface LanguageModel.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LanguageModel.Builder,LanguageModel>, SdkBuilder<LanguageModel.Builder,LanguageModel>, SdkPojo

Enclosing class:

LanguageModel

public static interface LanguageModel.Builder
extends SdkPojo, CopyableBuilder<LanguageModel.Builder,LanguageModel>

Method Summary

Modifier and Type	Method and Description
LanguageModel.Builder	baseModelName(BaseModelName baseModelName) The Amazon Transcribe standard language model, or base model, used to create your custom language model.
LanguageModel.Builder	baseModelName(String baseModelName) The Amazon Transcribe standard language model, or base model, used to create your custom language model.
LanguageModel.Builder	createTime(Instant createTime) The date and time the specified custom language model was created.
LanguageModel.Builder	failureReason(String failureReason) If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed.
default LanguageModel.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> 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.Builder	inputDataConfig(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.Builder	languageCode(CLMLanguageCode languageCode) The language code used to create your custom language model.
LanguageModel.Builder	languageCode(String languageCode) The language code used to create your custom language model.
LanguageModel.Builder	lastModifiedTime(Instant lastModifiedTime) The date and time the specified custom language model was last modified.
LanguageModel.Builder	modelName(String modelName) A unique name, chosen by you, for your custom language model.
LanguageModel.Builder	modelStatus(ModelStatus modelStatus) The status of the specified custom language model.
LanguageModel.Builder	modelStatus(String modelStatus) The status of the specified custom language model.
LanguageModel.Builder	upgradeAvailability(Boolean upgradeAvailability) Shows if a more current base model is available for use with the specified custom language model.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

modelName

LanguageModel.Builder modelName(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.

createTime

LanguageModel.Builder createTime(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.

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.

lastModifiedTime

LanguageModel.Builder lastModifiedTime(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.

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.

languageCode

LanguageModel.Builder languageCode(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, CLMLanguageCode

languageCode

LanguageModel.Builder languageCode(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, CLMLanguageCode

baseModelName

LanguageModel.Builder baseModelName(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, BaseModelName

baseModelName

LanguageModel.Builder baseModelName(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, BaseModelName

modelStatus

LanguageModel.Builder modelStatus(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, ModelStatus

modelStatus

LanguageModel.Builder modelStatus(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, ModelStatus

upgradeAvailability

LanguageModel.Builder upgradeAvailability(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.

failureReason

LanguageModel.Builder failureReason(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.

inputDataConfig

LanguageModel.Builder inputDataConfig(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.

inputDataConfig

default LanguageModel.Builder inputDataConfig(Consumer<InputDataConfig.Builder> 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.

This is a convenience method that creates an instance of the InputDataConfig.Builder avoiding the need to create one manually via InputDataConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(InputDataConfig).

Parameters:

inputDataConfig - a consumer that will call methods on InputDataConfig.Builder

Returns:

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

See Also:

inputDataConfig(InputDataConfig)