software.amazon.awssdk.services.transcribe.model

Class CreateLanguageModelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribe.model.TranscribeRequest

software.amazon.awssdk.services.transcribe.model.CreateLanguageModelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLanguageModelRequest.Builder,CreateLanguageModelRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLanguageModelRequest
extends TranscribeRequest
implements ToCopyableBuilder<CreateLanguageModelRequest.Builder,CreateLanguageModelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLanguageModelRequest.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 CreateLanguageModelRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
InputDataConfig	inputDataConfig() Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 locations of your training ( S3Uri) and tuning (TuningDataS3Uri) data.
CLMLanguageCode	languageCode() The language of your custom language model; note that the language code you select must match the language of your training and tuning data.
String	languageCodeAsString() The language of your custom language model; note that the language code you select must match the language of your training and tuning data.
String	modelName() The name of your new custom language model.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLanguageModelRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Optionally add tags, each in the form of a key:value pair, to your new language model.
CreateLanguageModelRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

languageCode

public final CLMLanguageCode languageCode()

The language of your custom language model; note that the language code you select must match the language of your training and tuning data.

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 of your custom language model; note that the language code you select must match the language of your training and tuning data.

See Also:

CLMLanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language of your custom language model; note that the language code you select must match the language of your training and tuning data.

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 of your custom language model; note that the language code you select must match the language of your training and tuning data.

See Also:

CLMLanguageCode

baseModelName

public final BaseModelName baseModelName()

The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

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. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

See Also:

BaseModelName

baseModelNameAsString

public final String baseModelNameAsString()

The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

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. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

See Also:

BaseModelName

modelName

public final String modelName()

The name of your new custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a language model with the same name as a previous language model, you get a ConflictException error.

Returns:

The name of your new custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a language model with the same name as a previous language model, you get a ConflictException error.

inputDataConfig

public final InputDataConfig inputDataConfig()

Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 locations of your training ( S3Uri) and tuning (TuningDataS3Uri) data.

Returns:

Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 locations of your training ( S3Uri) and tuning (TuningDataS3Uri) data.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Optionally add tags, each in the form of a key:value pair, to your new language model. See also: .

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Optionally add tags, each in the form of a key:value pair, to your new language model. See also: .

toBuilder

public CreateLanguageModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLanguageModelRequest.Builder,CreateLanguageModelRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static CreateLanguageModelRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo