@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TranscriptionJob extends Object implements Serializable, Cloneable, StructuredPojo
Provides detailed information about a transcription job.
To view the status of the specified transcription job, check the TranscriptionJobStatus
field. If the
status is COMPLETED
, the job is finished and you can find the results at the location specified in
TranscriptFileUri
. If the status is FAILED
, FailureReason
provides details on
why your transcription job failed.
If you enabled content redaction, the redacted transcript can be found at the location specified in
RedactedTranscriptFileUri
.
Constructor and Description |
---|
TranscriptionJob() |
Modifier and Type | Method and Description |
---|---|
TranscriptionJob |
addLanguageIdSettingsEntry(String key,
LanguageIdSettings value)
Add a single LanguageIdSettings entry
|
TranscriptionJob |
clearLanguageIdSettingsEntries()
Removes all the entries added into LanguageIdSettings.
|
TranscriptionJob |
clone() |
boolean |
equals(Object obj) |
Date |
getCompletionTime()
The date and time the specified transcription job finished processing.
|
ContentRedaction |
getContentRedaction()
Redacts or flags specified personally identifiable information (PII) in your transcript.
|
Date |
getCreationTime()
The date and time the specified transcription job request was made.
|
String |
getFailureReason()
If
TranscriptionJobStatus is FAILED , FailureReason contains information
about why the transcription job request failed. |
Float |
getIdentifiedLanguageScore()
The confidence score associated with the language identified in your media file.
|
Boolean |
getIdentifyLanguage()
Indicates whether automatic language identification was enabled (
TRUE ) for the specified
transcription job. |
Boolean |
getIdentifyMultipleLanguages()
Indicates whether automatic multi-language identification was enabled (
TRUE ) for the specified
transcription job. |
JobExecutionSettings |
getJobExecutionSettings()
Provides information about how your transcription job is being processed.
|
String |
getLanguageCode()
The language code used to create your transcription job.
|
List<LanguageCodeItem> |
getLanguageCodes()
The language codes used to create your transcription job.
|
Map<String,LanguageIdSettings> |
getLanguageIdSettings()
If using automatic language identification (
IdentifyLanguage ) 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<String> |
getLanguageOptions()
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.
|
Media |
getMedia()
Describes the Amazon S3 location of the media file you want to use in your request.
|
String |
getMediaFormat()
The format of the input media file.
|
Integer |
getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio track in your input media file.
|
ModelSettings |
getModelSettings()
The custom language model you want to include with your transcription job.
|
Settings |
getSettings()
Specify additional optional settings in your request, including channel identification, alternative
transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
|
Date |
getStartTime()
The date and time the specified transcription job began processing.
|
SubtitlesOutput |
getSubtitles()
Generate subtitles for your media file with your transcription request.
|
List<Tag> |
getTags()
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.
|
Transcript |
getTranscript()
Provides you with the Amazon S3 URI you can use to access your transcript.
|
String |
getTranscriptionJobName()
The name of the transcription job.
|
String |
getTranscriptionJobStatus()
Provides the status of the specified transcription job.
|
int |
hashCode() |
Boolean |
isIdentifyLanguage()
Indicates whether automatic language identification was enabled (
TRUE ) for the specified
transcription job. |
Boolean |
isIdentifyMultipleLanguages()
Indicates whether automatic multi-language identification was enabled (
TRUE ) for the specified
transcription job. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCompletionTime(Date completionTime)
The date and time the specified transcription job finished processing.
|
void |
setContentRedaction(ContentRedaction contentRedaction)
Redacts or flags specified personally identifiable information (PII) in your transcript.
|
void |
setCreationTime(Date creationTime)
The date and time the specified transcription job request was made.
|
void |
setFailureReason(String failureReason)
If
TranscriptionJobStatus is FAILED , FailureReason contains information
about why the transcription job request failed. |
void |
setIdentifiedLanguageScore(Float identifiedLanguageScore)
The confidence score associated with the language identified in your media file.
|
void |
setIdentifyLanguage(Boolean identifyLanguage)
Indicates whether automatic language identification was enabled (
TRUE ) for the specified
transcription job. |
void |
setIdentifyMultipleLanguages(Boolean identifyMultipleLanguages)
Indicates whether automatic multi-language identification was enabled (
TRUE ) for the specified
transcription job. |
void |
setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how your transcription job is being processed.
|
void |
setLanguageCode(String languageCode)
The language code used to create your transcription job.
|
void |
setLanguageCodes(Collection<LanguageCodeItem> languageCodes)
The language codes used to create your transcription job.
|
void |
setLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings)
If using automatic language identification (
IdentifyLanguage ) 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 ). |
void |
setLanguageOptions(Collection<String> 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.
|
void |
setMedia(Media media)
Describes the Amazon S3 location of the media file you want to use in your request.
|
void |
setMediaFormat(String mediaFormat)
The format of the input media file.
|
void |
setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in your input media file.
|
void |
setModelSettings(ModelSettings modelSettings)
The custom language model you want to include with your transcription job.
|
void |
setSettings(Settings settings)
Specify additional optional settings in your request, including channel identification, alternative
transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
|
void |
setStartTime(Date startTime)
The date and time the specified transcription job began processing.
|
void |
setSubtitles(SubtitlesOutput subtitles)
Generate subtitles for your media file with your transcription request.
|
void |
setTags(Collection<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.
|
void |
setTranscript(Transcript transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
|
void |
setTranscriptionJobName(String transcriptionJobName)
The name of the transcription job.
|
void |
setTranscriptionJobStatus(String transcriptionJobStatus)
Provides the status of the specified transcription job.
|
String |
toString()
Returns a string representation of this object.
|
TranscriptionJob |
withCompletionTime(Date completionTime)
The date and time the specified transcription job finished processing.
|
TranscriptionJob |
withContentRedaction(ContentRedaction contentRedaction)
Redacts or flags specified personally identifiable information (PII) in your transcript.
|
TranscriptionJob |
withCreationTime(Date creationTime)
The date and time the specified transcription job request was made.
|
TranscriptionJob |
withFailureReason(String failureReason)
If
TranscriptionJobStatus is FAILED , FailureReason contains information
about why the transcription job request failed. |
TranscriptionJob |
withIdentifiedLanguageScore(Float identifiedLanguageScore)
The confidence score associated with the language identified in your media file.
|
TranscriptionJob |
withIdentifyLanguage(Boolean identifyLanguage)
Indicates whether automatic language identification was enabled (
TRUE ) for the specified
transcription job. |
TranscriptionJob |
withIdentifyMultipleLanguages(Boolean identifyMultipleLanguages)
Indicates whether automatic multi-language identification was enabled (
TRUE ) for the specified
transcription job. |
TranscriptionJob |
withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how your transcription job is being processed.
|
TranscriptionJob |
withLanguageCode(LanguageCode languageCode)
The language code used to create your transcription job.
|
TranscriptionJob |
withLanguageCode(String languageCode)
The language code used to create your transcription job.
|
TranscriptionJob |
withLanguageCodes(Collection<LanguageCodeItem> languageCodes)
The language codes used to create your transcription job.
|
TranscriptionJob |
withLanguageCodes(LanguageCodeItem... languageCodes)
The language codes used to create your transcription job.
|
TranscriptionJob |
withLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings)
If using automatic language identification (
IdentifyLanguage ) 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 ). |
TranscriptionJob |
withLanguageOptions(Collection<String> 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.
|
TranscriptionJob |
withLanguageOptions(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.
|
TranscriptionJob |
withLanguageOptions(String... 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.
|
TranscriptionJob |
withMedia(Media media)
Describes the Amazon S3 location of the media file you want to use in your request.
|
TranscriptionJob |
withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
|
TranscriptionJob |
withMediaFormat(String mediaFormat)
The format of the input media file.
|
TranscriptionJob |
withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in your input media file.
|
TranscriptionJob |
withModelSettings(ModelSettings modelSettings)
The custom language model you want to include with your transcription job.
|
TranscriptionJob |
withSettings(Settings settings)
Specify additional optional settings in your request, including channel identification, alternative
transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
|
TranscriptionJob |
withStartTime(Date startTime)
The date and time the specified transcription job began processing.
|
TranscriptionJob |
withSubtitles(SubtitlesOutput subtitles)
Generate subtitles for your media file with your transcription request.
|
TranscriptionJob |
withTags(Collection<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.
|
TranscriptionJob |
withTags(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.
|
TranscriptionJob |
withTranscript(Transcript transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
|
TranscriptionJob |
withTranscriptionJobName(String transcriptionJobName)
The name of the transcription job.
|
TranscriptionJob |
withTranscriptionJobStatus(String transcriptionJobStatus)
Provides the status of the specified transcription job.
|
TranscriptionJob |
withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
Provides the status of the specified transcription job.
|
public void setTranscriptionJobName(String transcriptionJobName)
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
transcriptionJobName
- The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web
Services account.public String getTranscriptionJobName()
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
public TranscriptionJob withTranscriptionJobName(String transcriptionJobName)
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
transcriptionJobName
- The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web
Services account.public void setTranscriptionJobStatus(String transcriptionJobStatus)
Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details on why
your transcription job failed.
transcriptionJobStatus
- Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details
on why your transcription job failed.
TranscriptionJobStatus
public String getTranscriptionJobStatus()
Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details on why
your transcription job failed.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details
on why your transcription job failed.
TranscriptionJobStatus
public TranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus)
Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details on why
your transcription job failed.
transcriptionJobStatus
- Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details
on why your transcription job failed.
TranscriptionJobStatus
public TranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details on why
your transcription job failed.
transcriptionJobStatus
- Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the results at the location
specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
transcript redaction). If the status is FAILED
, FailureReason
provides details
on why your transcription job failed.
TranscriptionJobStatus
public void setLanguageCode(String languageCode)
The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
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.
languageCode
- The language code used to create your transcription job. For a list of supported languages and their
associated language codes, refer to the Supported languages
table.
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.
LanguageCode
public String getLanguageCode()
The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
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.
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.
LanguageCode
public TranscriptionJob withLanguageCode(String languageCode)
The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
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.
languageCode
- The language code used to create your transcription job. For a list of supported languages and their
associated language codes, refer to the Supported languages
table.
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.
LanguageCode
public TranscriptionJob withLanguageCode(LanguageCode languageCode)
The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
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.
languageCode
- The language code used to create your transcription job. For a list of supported languages and their
associated language codes, refer to the Supported languages
table.
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.
LanguageCode
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in your input media file.
mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in your input media file.public Integer getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio track in your input media file.
public TranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in your input media file.
mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in your input media file.public void setMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public String getMediaFormat()
The format of the input media file.
MediaFormat
public TranscriptionJob withMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public TranscriptionJob withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public void setMedia(Media media)
Describes the Amazon S3 location of the media file you want to use in your request.
media
- Describes the Amazon S3 location of the media file you want to use in your request.public Media getMedia()
Describes the Amazon S3 location of the media file you want to use in your request.
public TranscriptionJob withMedia(Media media)
Describes the Amazon S3 location of the media file you want to use in your request.
media
- Describes the Amazon S3 location of the media file you want to use in your request.public void setTranscript(Transcript transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
transcript
- Provides you with the Amazon S3 URI you can use to access your transcript.public Transcript getTranscript()
Provides you with the Amazon S3 URI you can use to access your transcript.
public TranscriptionJob withTranscript(Transcript transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
transcript
- Provides you with the Amazon S3 URI you can use to access your transcript.public void setStartTime(Date startTime)
The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
UTC-7 on May 4, 2022.
startTime
- The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at
12:32 PM UTC-7 on May 4, 2022.
public Date getStartTime()
The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
UTC-7 on May 4, 2022.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at
12:32 PM UTC-7 on May 4, 2022.
public TranscriptionJob withStartTime(Date startTime)
The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
UTC-7 on May 4, 2022.
startTime
- The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at
12:32 PM UTC-7 on May 4, 2022.
public void setCreationTime(Date creationTime)
The date and time the specified transcription job request was made.
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 a transcription job that started processing at 12:32 PM
UTC-7 on May 4, 2022.
creationTime
- The date and time the specified transcription job request was made.
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 a transcription job that started processing at
12:32 PM UTC-7 on May 4, 2022.
public Date getCreationTime()
The date and time the specified transcription job request was made.
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 a transcription job that started processing at 12:32 PM
UTC-7 on May 4, 2022.
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 a transcription job that started processing at
12:32 PM UTC-7 on May 4, 2022.
public TranscriptionJob withCreationTime(Date creationTime)
The date and time the specified transcription job request was made.
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 a transcription job that started processing at 12:32 PM
UTC-7 on May 4, 2022.
creationTime
- The date and time the specified transcription job request was made.
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 a transcription job that started processing at
12:32 PM UTC-7 on May 4, 2022.
public void setCompletionTime(Date completionTime)
The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
UTC-7 on May 4, 2022.
completionTime
- The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at
12:33 PM UTC-7 on May 4, 2022.
public Date getCompletionTime()
The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
UTC-7 on May 4, 2022.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at
12:33 PM UTC-7 on May 4, 2022.
public TranscriptionJob withCompletionTime(Date completionTime)
The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
UTC-7 on May 4, 2022.
completionTime
- The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at
12:33 PM UTC-7 on May 4, 2022.
public void setFailureReason(String failureReason)
If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.
The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
supported formats.
The media format provided does not match the detected media format
.
The media format specified in MediaFormat
doesn't match the format of the input file. Check the
media format of your media file and correct the specified value.
Invalid sample rate for audio file
.
The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
and 48,000 Hertz.
The sample rate provided does not match the detected sample rate
.
The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large
.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
failureReason
- If TranscriptionJobStatus
is FAILED
, FailureReason
contains
information about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.
The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list
of supported formats.
The media format provided does not match the detected media format
.
The media format specified in MediaFormat
doesn't match the format of the input file. Check
the media format of your media file and correct the specified value.
Invalid sample rate for audio file
.
The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be
between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate
.
The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in
your input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large
.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
public String getFailureReason()
If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.
The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
supported formats.
The media format provided does not match the detected media format
.
The media format specified in MediaFormat
doesn't match the format of the input file. Check the
media format of your media file and correct the specified value.
Invalid sample rate for audio file
.
The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
and 48,000 Hertz.
The sample rate provided does not match the detected sample rate
.
The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large
.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
TranscriptionJobStatus
is FAILED
, FailureReason
contains
information about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.
The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a
list of supported formats.
The media format provided does not match the detected media format
.
The media format specified in MediaFormat
doesn't match the format of the input file. Check
the media format of your media file and correct the specified value.
Invalid sample rate for audio file
.
The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be
between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate
.
The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in
your input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large
.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
public TranscriptionJob withFailureReason(String failureReason)
If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.
The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
supported formats.
The media format provided does not match the detected media format
.
The media format specified in MediaFormat
doesn't match the format of the input file. Check the
media format of your media file and correct the specified value.
Invalid sample rate for audio file
.
The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
and 48,000 Hertz.
The sample rate provided does not match the detected sample rate
.
The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large
.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
failureReason
- If TranscriptionJobStatus
is FAILED
, FailureReason
contains
information about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.
The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list
of supported formats.
The media format provided does not match the detected media format
.
The media format specified in MediaFormat
doesn't match the format of the input file. Check
the media format of your media file and correct the specified value.
Invalid sample rate for audio file
.
The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be
between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate
.
The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in
your input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large
.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
public void setSettings(Settings settings)
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you 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, do not use the Settings
parameter; use instead
the parameter with the
LanguageModelName
, VocabularyName
or
VocabularyFilterName
sub-parameters.
settings
- Specify additional optional settings in your request, including channel identification, alternative
transcriptions, speaker labeling; allows you 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, do not use the Settings
parameter;
use instead the parameter with the
LanguageModelName
, VocabularyName
or
VocabularyFilterName
sub-parameters.
public Settings getSettings()
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you 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, do not use the Settings
parameter; 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, do not use the Settings
parameter; use instead the parameter with the
LanguageModelName
,
VocabularyName
or VocabularyFilterName
sub-parameters.
public TranscriptionJob withSettings(Settings settings)
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you 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, do not use the Settings
parameter; use instead
the parameter with the
LanguageModelName
, VocabularyName
or
VocabularyFilterName
sub-parameters.
settings
- Specify additional optional settings in your request, including channel identification, alternative
transcriptions, speaker labeling; allows you 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, do not use the Settings
parameter;
use instead the parameter with the
LanguageModelName
, VocabularyName
or
VocabularyFilterName
sub-parameters.
public void setModelSettings(ModelSettings modelSettings)
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.
modelSettings
- 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.public ModelSettings getModelSettings()
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.
ModelSettings
in your request, you must include the LanguageModelName
sub-parameter.public TranscriptionJob withModelSettings(ModelSettings modelSettings)
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.
modelSettings
- 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.public void setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.
jobExecutionSettings
- Provides information about how your transcription job is being processed. This parameter shows if your
request is queued and what data access role is being used.public JobExecutionSettings getJobExecutionSettings()
Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.
public TranscriptionJob withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.
jobExecutionSettings
- Provides information about how your transcription job is being processed. This parameter shows if your
request is queued and what data access role is being used.public void setContentRedaction(ContentRedaction contentRedaction)
Redacts or flags specified personally identifiable information (PII) in your transcript.
contentRedaction
- Redacts or flags specified personally identifiable information (PII) in your transcript.public ContentRedaction getContentRedaction()
Redacts or flags specified personally identifiable information (PII) in your transcript.
public TranscriptionJob withContentRedaction(ContentRedaction contentRedaction)
Redacts or flags specified personally identifiable information (PII) in your transcript.
contentRedaction
- Redacts or flags specified personally identifiable information (PII) in your transcript.public void setIdentifyLanguage(Boolean identifyLanguage)
Indicates whether automatic language identification was enabled (TRUE
) for the specified
transcription job.
identifyLanguage
- Indicates whether automatic language identification was enabled (TRUE
) for the specified
transcription job.public Boolean getIdentifyLanguage()
Indicates whether automatic language identification was enabled (TRUE
) for the specified
transcription job.
TRUE
) for the specified
transcription job.public TranscriptionJob withIdentifyLanguage(Boolean identifyLanguage)
Indicates whether automatic language identification was enabled (TRUE
) for the specified
transcription job.
identifyLanguage
- Indicates whether automatic language identification was enabled (TRUE
) for the specified
transcription job.public Boolean isIdentifyLanguage()
Indicates whether automatic language identification was enabled (TRUE
) for the specified
transcription job.
TRUE
) for the specified
transcription job.public void setIdentifyMultipleLanguages(Boolean identifyMultipleLanguages)
Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
transcription job.
identifyMultipleLanguages
- Indicates whether automatic multi-language identification was enabled (TRUE
) for the
specified transcription job.public Boolean getIdentifyMultipleLanguages()
Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
transcription job.
TRUE
) for the
specified transcription job.public TranscriptionJob withIdentifyMultipleLanguages(Boolean identifyMultipleLanguages)
Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
transcription job.
identifyMultipleLanguages
- Indicates whether automatic multi-language identification was enabled (TRUE
) for the
specified transcription job.public Boolean isIdentifyMultipleLanguages()
Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
transcription job.
TRUE
) for the
specified transcription job.public List<String> getLanguageOptions()
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.
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.
LanguageCode
public void setLanguageOptions(Collection<String> 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.
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.
LanguageCode
public TranscriptionJob withLanguageOptions(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setLanguageOptions(java.util.Collection)
or withLanguageOptions(java.util.Collection)
if you
want to override the existing values.
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.
LanguageCode
public TranscriptionJob withLanguageOptions(Collection<String> 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.
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.
LanguageCode
public TranscriptionJob withLanguageOptions(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.
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.
LanguageCode
public void setIdentifiedLanguageScore(Float identifiedLanguageScore)
The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
identifiedLanguageScore
- The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
public Float getIdentifiedLanguageScore()
The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
public TranscriptionJob withIdentifiedLanguageScore(Float identifiedLanguageScore)
The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
identifiedLanguageScore
- The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
public List<LanguageCodeItem> getLanguageCodes()
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
public void setLanguageCodes(Collection<LanguageCodeItem> languageCodes)
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
languageCodes
- The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this
parameter, LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
public TranscriptionJob withLanguageCodes(LanguageCodeItem... languageCodes)
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
NOTE: This method appends the values to the existing list (if any). Use
setLanguageCodes(java.util.Collection)
or withLanguageCodes(java.util.Collection)
if you want
to override the existing values.
languageCodes
- The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this
parameter, LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
public TranscriptionJob withLanguageCodes(Collection<LanguageCodeItem> languageCodes)
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
languageCodes
- The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this
parameter, LanguageCode
.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
public List<Tag> getTags()
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.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
public void setTags(Collection<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.
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.
public TranscriptionJob withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.
public TranscriptionJob withTags(Collection<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.
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.
public void setSubtitles(SubtitlesOutput subtitles)
Generate subtitles for your media file with your transcription request.
subtitles
- Generate subtitles for your media file with your transcription request.public SubtitlesOutput getSubtitles()
Generate subtitles for your media file with your transcription request.
public TranscriptionJob withSubtitles(SubtitlesOutput subtitles)
Generate subtitles for your media file with your transcription request.
subtitles
- Generate subtitles for your media file with your transcription request.public Map<String,LanguageIdSettings> getLanguageIdSettings()
If using automatic language identification (IdentifyLanguage
) 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
).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage
without including a custom language model,
a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of
LanguageIdSettings
. Including language options can improve the accuracy of automatic language
identification.
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.
IdentifyLanguage
) 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
).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage
without including a custom
language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of LanguageIdSettings
. Including language options can improve the accuracy of
automatic language identification.
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 void setLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings)
If using automatic language identification (IdentifyLanguage
) 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
).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage
without including a custom language model,
a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of
LanguageIdSettings
. Including language options can improve the accuracy of automatic language
identification.
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.
languageIdSettings
- If using automatic language identification (IdentifyLanguage
) 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
).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage
without including a custom language
model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of
LanguageIdSettings
. Including language options can improve the accuracy of automatic language
identification.
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 TranscriptionJob withLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings)
If using automatic language identification (IdentifyLanguage
) 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
).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage
without including a custom language model,
a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of
LanguageIdSettings
. Including language options can improve the accuracy of automatic language
identification.
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.
languageIdSettings
- If using automatic language identification (IdentifyLanguage
) 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
).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage
without including a custom language
model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of
LanguageIdSettings
. Including language options can improve the accuracy of automatic language
identification.
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 TranscriptionJob addLanguageIdSettingsEntry(String key, LanguageIdSettings value)
public TranscriptionJob clearLanguageIdSettingsEntries()
public String toString()
toString
in class Object
Object.toString()
public TranscriptionJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.