@Generated(value="software.amazon.awssdk:codegen") public final class StartTranscriptionJobRequest extends TranscribeRequest implements ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
StartTranscriptionJobRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static StartTranscriptionJobRequest.Builder |
builder() |
ContentRedaction |
contentRedaction()
Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasKmsEncryptionContext()
For responses, this returns true if the service returned a value for the KMSEncryptionContext property.
|
boolean |
hasLanguageIdSettings()
For responses, this returns true if the service returned a value for the LanguageIdSettings property.
|
boolean |
hasLanguageOptions()
For responses, this returns true if the service returned a value for the LanguageOptions property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Boolean |
identifyLanguage()
Enables automatic language identification in your transcription job request.
|
Boolean |
identifyMultipleLanguages()
Enables automatic multi-language identification in your transcription job request.
|
JobExecutionSettings |
jobExecutionSettings()
Makes it possible to control how your transcription job is processed.
|
Map<String,String> |
kmsEncryptionContext()
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer
of security for your data.
|
LanguageCode |
languageCode()
The language code that represents the language spoken in the input media file.
|
String |
languageCodeAsString()
The language code that represents the language spoken in the input media file.
|
Map<LanguageCode,LanguageIdSettings> |
languageIdSettings()
If using automatic language identification in your request and you want to apply a custom language model, a
custom vocabulary, or a custom vocabulary filter, include
LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). |
Map<String,LanguageIdSettings> |
languageIdSettingsAsStrings()
If using automatic language identification in your request and you want to apply a custom language model, a
custom vocabulary, or a custom vocabulary filter, include
LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). |
List<LanguageCode> |
languageOptions()
You can specify two or more language codes that represent the languages you think may be present in your media.
|
List<String> |
languageOptionsAsStrings()
You can specify two or more language codes that represent the languages you think may be present in your media.
|
Media |
media()
Describes the Amazon S3 location of the media file you want to use in your request.
|
MediaFormat |
mediaFormat()
Specify the format of your input media file.
|
String |
mediaFormatAsString()
Specify the format of your input media file.
|
Integer |
mediaSampleRateHertz()
The sample rate, in hertz, of the audio track in your input media file.
|
ModelSettings |
modelSettings()
Specify the custom language model you want to include with your transcription job.
|
String |
outputBucketName()
The name of the Amazon S3 bucket where you want your transcription output stored.
|
String |
outputEncryptionKMSKeyId()
The KMS key you want to use to encrypt your transcription output.
|
String |
outputKey()
Use in combination with
OutputBucketName to specify the output location of your transcript and,
optionally, a unique name for your output file. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends StartTranscriptionJobRequest.Builder> |
serializableBuilderClass() |
Settings |
settings()
Specify additional optional settings in your request, including channel identification, alternative
transcriptions, speaker partitioning.
|
Subtitles |
subtitles()
Produces subtitle files for your input media.
|
List<Tag> |
tags()
Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you
start this new job.
|
StartTranscriptionJobRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
transcriptionJobName()
A unique name, chosen by you, for your transcription job.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String transcriptionJobName()
A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default
name of your transcription output file. If you want to specify a different name for your transcription output,
use the OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If
you try to create a new job with the same name as an existing job, you get a ConflictException
error.
OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
account. If you try to create a new job with the same name as an existing job, you get a
ConflictException error.
public final LanguageCode languageCode()
The language code that represents the language spoken in the input media file.
If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or
IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
If the service returns an enum value that is not available in the current SDK version, languageCode will
return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
languageCodeAsString().
If you're unsure of the language spoken in your media file, consider using IdentifyLanguage
or IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters,
your transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a
sample rate of 16,000 Hz or higher.
LanguageCodepublic final String languageCodeAsString()
The language code that represents the language spoken in the input media file.
If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or
IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
If the service returns an enum value that is not available in the current SDK version, languageCode will
return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
languageCodeAsString().
If you're unsure of the language spoken in your media file, consider using IdentifyLanguage
or IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters,
your transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a
sample rate of 16,000 Hz or higher.
LanguageCodepublic final Integer mediaSampleRateHertz()
The sample rate, in hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample
rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you
specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and
let Amazon Transcribe determine the sample rate.
If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you specify the
sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the
value that you specify and the value detected, your job fails. In most cases, you can omit
MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
public final MediaFormat mediaFormat()
Specify the format of your input media file.
If the service returns an enum value that is not available in the current SDK version, mediaFormat will
return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
mediaFormatAsString().
MediaFormatpublic final String mediaFormatAsString()
Specify the format of your input media file.
If the service returns an enum value that is not available in the current SDK version, mediaFormat will
return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
mediaFormatAsString().
MediaFormatpublic final Media media()
Describes the Amazon S3 location of the media file you want to use in your request.
public final String outputBucketName()
The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the
S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
parameter; OutputBucketName only accepts the name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3
bucket and you are provided with a URI to access your transcript.
S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
parameter; OutputBucketName only accepts the name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored
in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon
S3 bucket and you are provided with a URI to access your transcript.
public final String outputKey()
Use in combination with OutputBucketName to specify the output location of your transcript and,
optionally, a unique name for your output file. The default name for your transcription output is the same as the
name you specified for your transcription job (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json
.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path
is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as
the OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription
output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
OutputBucketName to specify the output location of your transcript
and, optionally, a unique name for your output file. The default name for your transcription output is
the same as the name you specified for your transcription job (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as
the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription
output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and
'test-files/my-transcript.json' as the OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as
the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your
transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
public final String outputEncryptionKMSKeyId()
The KMS key you want to use to encrypt your transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the
OutputLocation parameter.
Note that the role making the request must have permission to use the specified KMS key.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the
OutputLocation parameter.
Note that the role making the request must have permission to use the specified KMS key.
public final boolean hasKmsEncryptionContext()
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.public final Map<String,String> kmsEncryptionContext()
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
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 hasKmsEncryptionContext() method.
public final Settings settings()
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do
not want to use automatic language identification, use Settings with the
VocabularyName or VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and want to include a custom language model,
a custom vocabulary, or a custom vocabulary filter, use instead the
parameter with the LanguageModelName, VocabularyName or
VocabularyFilterName sub-parameters.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but
do not want to use automatic language identification, use Settings with the
VocabularyName or VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and want to include a custom language
model, a custom vocabulary, or a custom vocabulary filter, use instead the
parameter with the LanguageModelName, VocabularyName or
VocabularyFilterName sub-parameters.
public final ModelSettings modelSettings()
Specify the custom language model you want to include with your transcription job. If you include
ModelSettings in your request, you must include the LanguageModelName sub-parameter.
For more information, see Custom language models.
ModelSettings in your request, you must include the LanguageModelName
sub-parameter.
For more information, see Custom language models.
public final JobExecutionSettings jobExecutionSettings()
Makes it possible to control how your transcription job is processed. Currently, the only
JobExecutionSettings modification you can choose is enabling job queueing using the
AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also include the sub-parameters:
AllowDeferredExecution and DataAccessRoleArn.
JobExecutionSettings modification you can choose is enabling job queueing using the
AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also include the
sub-parameters: AllowDeferredExecution and DataAccessRoleArn.
public final ContentRedaction contentRedaction()
Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If
you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes,
RedactionOutput, and RedactionType.
ContentRedaction, you must also include the sub-parameters:
PiiEntityTypes, RedactionOutput, and RedactionType.public final Boolean identifyLanguage()
Enables automatic language identification in your transcription job request. Use this parameter if your media
file contains only one language. If your media contains multiple languages, use
IdentifyMultipleLanguages instead.
If you include IdentifyLanguage, you can optionally include a list of language codes, using
LanguageOptions, that you think may be present in your media file. Including
LanguageOptions restricts IdentifyLanguage to only the language options that you
specify, which can improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your
automatic language identification request, include LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). If you include LanguageIdSettings, also include
LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
IdentifyMultipleLanguages instead.
If you include IdentifyLanguage, you can optionally include a list of language codes, using
LanguageOptions, that you think may be present in your media file. Including
LanguageOptions restricts IdentifyLanguage to only the language options that
you specify, which can improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your
automatic language identification request, include LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). If you include LanguageIdSettings, also include
LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters,
your transcription job fails.
public final Boolean identifyMultipleLanguages()
Enables automatic multi-language identification in your transcription job request. Use this parameter if your
media file contains more than one language. If your media contains only one language, use
IdentifyLanguage instead.
If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using
LanguageOptions, that you think may be present in your media file. Including
LanguageOptions restricts IdentifyLanguage to only the language options that you
specify, which can improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification
request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName
and VocabularyFilterName). If you include LanguageIdSettings, also include
LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
IdentifyLanguage instead.
If you include IdentifyMultipleLanguages, you can optionally include a list of language
codes, using LanguageOptions, that you think may be present in your media file. Including
LanguageOptions restricts IdentifyLanguage to only the language options that
you specify, which can improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language
identification request, include LanguageIdSettings with the relevant sub-parameters (
VocabularyName and VocabularyFilterName). If you include
LanguageIdSettings, also include LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters,
your transcription job fails.
public final List<LanguageCode> languageOptions()
You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
If you include LanguageOptions in your request, you must also include IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
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 hasLanguageOptions() method.
If you include LanguageOptions in your request, you must also include
IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a
sample rate of 16,000 Hz or higher.
public final boolean hasLanguageOptions()
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.public final List<String> languageOptionsAsStrings()
You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
If you include LanguageOptions in your request, you must also include IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
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 hasLanguageOptions() method.
If you include LanguageOptions in your request, you must also include
IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a
sample rate of 16,000 Hz or higher.
public final Subtitles subtitles()
Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats.
public final boolean hasTags()
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.public final List<Tag> tags()
Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
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.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
public final Map<LanguageCode,LanguageIdSettings> languageIdSettings()
If using automatic language identification in your request and you want to apply a custom language model, a
custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). Note that multi-language identification (
IdentifyMultipleLanguages) doesn't support custom language models.
LanguageIdSettings supports two to five language codes. Each language code you include can have an
associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you
specify must match the languages of the associated custom language models, custom vocabularies, and custom
vocabulary filters.
It's recommended that you include LanguageOptions when using LanguageIdSettings to
ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is
in en-US but Amazon Transcribe determines that the language spoken in your media is
en-AU, your custom vocabulary is not applied to your transcription. If you include
LanguageOptions and include en-US as the only English language dialect, your custom
vocabulary is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic language
identification, use instead the parameter with the LanguageModelName sub-parameter. If you
want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not
want to use automatic language identification, use instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
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 hasLanguageIdSettings() method.
LanguageIdSettings with the
relevant sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). Note that multi-language identification (
IdentifyMultipleLanguages) doesn't support custom language models.
LanguageIdSettings supports two to five language codes. Each language code you include can
have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language
codes that you specify must match the languages of the associated custom language models, custom
vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions when using LanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom
vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in
your media is en-AU, your custom vocabulary is not applied to your transcription. If
you include LanguageOptions and include en-US as the only English language
dialect, your custom vocabulary is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic
language identification, use instead the parameter with the LanguageModelName
sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with
your request but do not want to use automatic language identification, use instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
public final boolean hasLanguageIdSettings()
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.public final Map<String,LanguageIdSettings> languageIdSettingsAsStrings()
If using automatic language identification in your request and you want to apply a custom language model, a
custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). Note that multi-language identification (
IdentifyMultipleLanguages) doesn't support custom language models.
LanguageIdSettings supports two to five language codes. Each language code you include can have an
associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you
specify must match the languages of the associated custom language models, custom vocabularies, and custom
vocabulary filters.
It's recommended that you include LanguageOptions when using LanguageIdSettings to
ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is
in en-US but Amazon Transcribe determines that the language spoken in your media is
en-AU, your custom vocabulary is not applied to your transcription. If you include
LanguageOptions and include en-US as the only English language dialect, your custom
vocabulary is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic language
identification, use instead the parameter with the LanguageModelName sub-parameter. If you
want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not
want to use automatic language identification, use instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
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 hasLanguageIdSettings() method.
LanguageIdSettings with the
relevant sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName). Note that multi-language identification (
IdentifyMultipleLanguages) doesn't support custom language models.
LanguageIdSettings supports two to five language codes. Each language code you include can
have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language
codes that you specify must match the languages of the associated custom language models, custom
vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions when using LanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom
vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in
your media is en-AU, your custom vocabulary is not applied to your transcription. If
you include LanguageOptions and include en-US as the only English language
dialect, your custom vocabulary is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic
language identification, use instead the parameter with the LanguageModelName
sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with
your request but do not want to use automatic language identification, use instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
public StartTranscriptionJobRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>toBuilder in class TranscribeRequestpublic static StartTranscriptionJobRequest.Builder builder()
public static Class<? extends StartTranscriptionJobRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.