public class MedicalTranscriptionJob
extends java.lang.Object
implements java.io.Serializable
The data structure that contains the information for a medical transcription job.
Constructor and Description |
---|
MedicalTranscriptionJob() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.Date |
getCompletionTime()
A timestamp that shows when the job was completed.
|
java.util.Date |
getCreationTime()
A timestamp that shows when the job was created.
|
java.lang.String |
getFailureReason()
If the
TranscriptionJobStatus field is FAILED ,
this field contains information about why the job failed. |
java.lang.String |
getLanguageCode()
The language code for the language spoken in the source audio file.
|
Media |
getMedia()
Describes the input media file in a transcription request.
|
java.lang.String |
getMediaFormat()
The format of the input media file.
|
java.lang.Integer |
getMediaSampleRateHertz()
The sample rate, in Hertz, of the source audio containing medical
information.
|
java.lang.String |
getMedicalTranscriptionJobName()
The name for a given medical transcription job.
|
MedicalTranscriptionSetting |
getSettings()
Object that contains object.
|
java.lang.String |
getSpecialty()
The medical specialty of any clinicians providing a dictation or having a
conversation.
|
java.util.Date |
getStartTime()
A timestamp that shows when the job started processing.
|
MedicalTranscript |
getTranscript()
An object that contains the
MedicalTranscript . |
java.lang.String |
getTranscriptionJobStatus()
The completion status of a medical transcription job.
|
java.lang.String |
getType()
The type of speech in the transcription job.
|
int |
hashCode() |
void |
setCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
|
void |
setCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
|
void |
setFailureReason(java.lang.String failureReason)
If the
TranscriptionJobStatus field is FAILED ,
this field contains information about why the job failed. |
void |
setLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the source audio file.
|
void |
setLanguageCode(java.lang.String languageCode)
The language code for the language spoken in the source audio file.
|
void |
setMedia(Media media)
Describes the input media file in a transcription request.
|
void |
setMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
|
void |
setMediaFormat(java.lang.String mediaFormat)
The format of the input media file.
|
void |
setMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical
information.
|
void |
setMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)
The name for a given medical transcription job.
|
void |
setSettings(MedicalTranscriptionSetting settings)
Object that contains object.
|
void |
setSpecialty(Specialty specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation.
|
void |
setSpecialty(java.lang.String specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation.
|
void |
setStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
|
void |
setTranscript(MedicalTranscript transcript)
An object that contains the
MedicalTranscript . |
void |
setTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The completion status of a medical transcription job.
|
void |
setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The completion status of a medical transcription job.
|
void |
setType(java.lang.String type)
The type of speech in the transcription job.
|
void |
setType(Type type)
The type of speech in the transcription job.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
MedicalTranscriptionJob |
withCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
|
MedicalTranscriptionJob |
withCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
|
MedicalTranscriptionJob |
withFailureReason(java.lang.String failureReason)
If the
TranscriptionJobStatus field is FAILED ,
this field contains information about why the job failed. |
MedicalTranscriptionJob |
withLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the source audio file.
|
MedicalTranscriptionJob |
withLanguageCode(java.lang.String languageCode)
The language code for the language spoken in the source audio file.
|
MedicalTranscriptionJob |
withMedia(Media media)
Describes the input media file in a transcription request.
|
MedicalTranscriptionJob |
withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
|
MedicalTranscriptionJob |
withMediaFormat(java.lang.String mediaFormat)
The format of the input media file.
|
MedicalTranscriptionJob |
withMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical
information.
|
MedicalTranscriptionJob |
withMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)
The name for a given medical transcription job.
|
MedicalTranscriptionJob |
withSettings(MedicalTranscriptionSetting settings)
Object that contains object.
|
MedicalTranscriptionJob |
withSpecialty(Specialty specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation.
|
MedicalTranscriptionJob |
withSpecialty(java.lang.String specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation.
|
MedicalTranscriptionJob |
withStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
|
MedicalTranscriptionJob |
withTranscript(MedicalTranscript transcript)
An object that contains the
MedicalTranscript . |
MedicalTranscriptionJob |
withTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The completion status of a medical transcription job.
|
MedicalTranscriptionJob |
withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The completion status of a medical transcription job.
|
MedicalTranscriptionJob |
withType(java.lang.String type)
The type of speech in the transcription job.
|
MedicalTranscriptionJob |
withType(Type type)
The type of speech in the transcription job.
|
public java.lang.String getMedicalTranscriptionJobName()
The name for a given medical transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
The name for a given medical transcription job.
public void setMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)
The name for a given medical transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
medicalTranscriptionJobName
- The name for a given medical transcription job.
public MedicalTranscriptionJob withMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)
The name for a given medical transcription job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
medicalTranscriptionJobName
- The name for a given medical transcription job.
public java.lang.String getTranscriptionJobStatus()
The completion status of a medical transcription job.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
The completion status of a medical transcription job.
TranscriptionJobStatus
public void setTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The completion status of a medical transcription job.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
- The completion status of a medical transcription job.
TranscriptionJobStatus
public MedicalTranscriptionJob withTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The completion status of a medical transcription job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
- The completion status of a medical transcription job.
TranscriptionJobStatus
public void setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The completion status of a medical transcription job.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
- The completion status of a medical transcription job.
TranscriptionJobStatus
public MedicalTranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The completion status of a medical transcription job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
- The completion status of a medical transcription job.
TranscriptionJobStatus
public java.lang.String getLanguageCode()
The language code for the language spoken in the source audio file. US
English (en-US) is the only supported language for medical
transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
The language code for the language spoken in the source audio
file. US English (en-US) is the only supported language for
medical transcriptions. Any other value you enter for language
code results in a BadRequestException
error.
LanguageCode
public void setLanguageCode(java.lang.String languageCode)
The language code for the language spoken in the source audio file. US
English (en-US) is the only supported language for medical
transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
-
The language code for the language spoken in the source audio
file. US English (en-US) is the only supported language for
medical transcriptions. Any other value you enter for language
code results in a BadRequestException
error.
LanguageCode
public MedicalTranscriptionJob withLanguageCode(java.lang.String languageCode)
The language code for the language spoken in the source audio file. US
English (en-US) is the only supported language for medical
transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
-
The language code for the language spoken in the source audio
file. US English (en-US) is the only supported language for
medical transcriptions. Any other value you enter for language
code results in a BadRequestException
error.
LanguageCode
public void setLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the source audio file. US
English (en-US) is the only supported language for medical
transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
-
The language code for the language spoken in the source audio
file. US English (en-US) is the only supported language for
medical transcriptions. Any other value you enter for language
code results in a BadRequestException
error.
LanguageCode
public MedicalTranscriptionJob withLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the source audio file. US
English (en-US) is the only supported language for medical
transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
-
The language code for the language spoken in the source audio
file. US English (en-US) is the only supported language for
medical transcriptions. Any other value you enter for language
code results in a BadRequestException
error.
LanguageCode
public java.lang.Integer getMediaSampleRateHertz()
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical
determines it for you. If you choose to specify the sample rate, it must
match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleHertz
blank and let Amazon
Transcribe Medical determine the sample rate.
Constraints:
Range: 8000 - 48000
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical
determines it for you. If you choose to specify the sample rate,
it must match the rate detected by Amazon Transcribe Medical. In
most cases, you should leave the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the sample
rate.
public void setMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical
determines it for you. If you choose to specify the sample rate, it must
match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleHertz
blank and let Amazon
Transcribe Medical determine the sample rate.
Constraints:
Range: 8000 - 48000
mediaSampleRateHertz
- The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe
Medical determines it for you. If you choose to specify the
sample rate, it must match the rate detected by Amazon
Transcribe Medical. In most cases, you should leave the
MediaSampleHertz
blank and let Amazon Transcribe
Medical determine the sample rate.
public MedicalTranscriptionJob withMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical
determines it for you. If you choose to specify the sample rate, it must
match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleHertz
blank and let Amazon
Transcribe Medical determine the sample rate.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 8000 - 48000
mediaSampleRateHertz
- The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe
Medical determines it for you. If you choose to specify the
sample rate, it must match the rate detected by Amazon
Transcribe Medical. In most cases, you should leave the
MediaSampleHertz
blank and let Amazon Transcribe
Medical determine the sample rate.
public java.lang.String getMediaFormat()
The format of the input media file.
Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
The format of the input media file.
MediaFormat
public void setMediaFormat(java.lang.String mediaFormat)
The format of the input media file.
Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
mediaFormat
- The format of the input media file.
MediaFormat
public MedicalTranscriptionJob withMediaFormat(java.lang.String mediaFormat)
The format of the input media file.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
mediaFormat
- The format of the input media file.
MediaFormat
public void setMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
mediaFormat
- The format of the input media file.
MediaFormat
public MedicalTranscriptionJob withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
mediaFormat
- The format of the input media file.
MediaFormat
public Media getMedia()
Describes the input media file in a transcription request.
Describes the input media file in a transcription request.
public void setMedia(Media media)
Describes the input media file in a transcription request.
media
- Describes the input media file in a transcription request.
public MedicalTranscriptionJob withMedia(Media media)
Describes the input media file in a transcription request.
Returns a reference to this object so that method calls can be chained together.
media
- Describes the input media file in a transcription request.
public MedicalTranscript getTranscript()
An object that contains the MedicalTranscript
. The
MedicalTranscript
contains the
TranscriptFileUri
.
An object that contains the MedicalTranscript
. The
MedicalTranscript
contains the
TranscriptFileUri
.
public void setTranscript(MedicalTranscript transcript)
An object that contains the MedicalTranscript
. The
MedicalTranscript
contains the
TranscriptFileUri
.
transcript
-
An object that contains the MedicalTranscript
.
The MedicalTranscript
contains the
TranscriptFileUri
.
public MedicalTranscriptionJob withTranscript(MedicalTranscript transcript)
An object that contains the MedicalTranscript
. The
MedicalTranscript
contains the
TranscriptFileUri
.
Returns a reference to this object so that method calls can be chained together.
transcript
-
An object that contains the MedicalTranscript
.
The MedicalTranscript
contains the
TranscriptFileUri
.
public java.util.Date getStartTime()
A timestamp that shows when the job started processing.
A timestamp that shows when the job started processing.
public void setStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
startTime
- A timestamp that shows when the job started processing.
public MedicalTranscriptionJob withStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
Returns a reference to this object so that method calls can be chained together.
startTime
- A timestamp that shows when the job started processing.
public java.util.Date getCreationTime()
A timestamp that shows when the job was created.
A timestamp that shows when the job was created.
public void setCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
creationTime
- A timestamp that shows when the job was created.
public MedicalTranscriptionJob withCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
Returns a reference to this object so that method calls can be chained together.
creationTime
- A timestamp that shows when the job was created.
public java.util.Date getCompletionTime()
A timestamp that shows when the job was completed.
A timestamp that shows when the job was completed.
public void setCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
completionTime
- A timestamp that shows when the job was completed.
public MedicalTranscriptionJob withCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
Returns a reference to this object so that method calls can be chained together.
completionTime
- A timestamp that shows when the job was completed.
public java.lang.String getFailureReason()
If the TranscriptionJobStatus
field is FAILED
,
this field contains information about why the job failed.
The FailureReason
field contains one of the following
values:
Unsupported media format
- The media format specified in the
MediaFormat
field of the request isn't valid. See the
description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified
in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate
specified in the MediaSampleRateHertz
of the request isn't
valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate
specified in the MediaSampleRateHertz
field in the request.
Check the sample rate of your media file and make sure that the two
values match.
Invalid file size: file size too large
- The size of your
audio file is larger than what Amazon Transcribe Medical can process. For
more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
-
Your audio contains more channels than Amazon Transcribe Medical is
configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web
Services General Reference
If the TranscriptionJobStatus
field is
FAILED
, this field contains information about why
the job failed.
The FailureReason
field contains one of the
following values:
Unsupported media format
- The media format specified
in the MediaFormat
field of the request isn't valid.
See the description of the MediaFormat
field for a
list of valid values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format
specified in the MediaFormat
field in the request.
Check the media format of your media file and make sure the two
values match.
Invalid sample rate for audio file
- The sample rate
specified in the MediaSampleRateHertz
of the request
isn't valid. The sample rate must be between 8000 and 48000
Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate
specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure
that the two values match.
Invalid file size: file size too large
- The size of
your audio file is larger than what Amazon Transcribe Medical can
process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical
Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe
Medical is configured to process. To request additional channels,
see Amazon Transcribe Medical Endpoints and Quotas in the
Amazon Web Services General Reference
public void setFailureReason(java.lang.String failureReason)
If the TranscriptionJobStatus
field is FAILED
,
this field contains information about why the job failed.
The FailureReason
field contains one of the following
values:
Unsupported media format
- The media format specified in the
MediaFormat
field of the request isn't valid. See the
description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified
in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate
specified in the MediaSampleRateHertz
of the request isn't
valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate
specified in the MediaSampleRateHertz
field in the request.
Check the sample rate of your media file and make sure that the two
values match.
Invalid file size: file size too large
- The size of your
audio file is larger than what Amazon Transcribe Medical can process. For
more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
-
Your audio contains more channels than Amazon Transcribe Medical is
configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web
Services General Reference
failureReason
-
If the TranscriptionJobStatus
field is
FAILED
, this field contains information about why
the job failed.
The FailureReason
field contains one of the
following values:
Unsupported media format
- The media format
specified in the MediaFormat
field of the request
isn't valid. See the description of the
MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format
specified in the MediaFormat
field in the
request. Check the media format of your media file and make
sure the two values match.
Invalid sample rate for audio file
- The sample
rate specified in the MediaSampleRateHertz
of the
request isn't valid. The sample rate must be between 8000 and
48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample
rate specified in the MediaSampleRateHertz
field
in the request. Check the sample rate of your media file and
make sure that the two values match.
Invalid file size: file size too large
- The size
of your audio file is larger than what Amazon Transcribe
Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical
Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe
Medical is configured to process. To request additional
channels, see Amazon Transcribe Medical Endpoints and Quotas in the
Amazon Web Services General Reference
public MedicalTranscriptionJob withFailureReason(java.lang.String failureReason)
If the TranscriptionJobStatus
field is FAILED
,
this field contains information about why the job failed.
The FailureReason
field contains one of the following
values:
Unsupported media format
- The media format specified in the
MediaFormat
field of the request isn't valid. See the
description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified
in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate
specified in the MediaSampleRateHertz
of the request isn't
valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate
specified in the MediaSampleRateHertz
field in the request.
Check the sample rate of your media file and make sure that the two
values match.
Invalid file size: file size too large
- The size of your
audio file is larger than what Amazon Transcribe Medical can process. For
more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
-
Your audio contains more channels than Amazon Transcribe Medical is
configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web
Services General Reference
Returns a reference to this object so that method calls can be chained together.
failureReason
-
If the TranscriptionJobStatus
field is
FAILED
, this field contains information about why
the job failed.
The FailureReason
field contains one of the
following values:
Unsupported media format
- The media format
specified in the MediaFormat
field of the request
isn't valid. See the description of the
MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format
specified in the MediaFormat
field in the
request. Check the media format of your media file and make
sure the two values match.
Invalid sample rate for audio file
- The sample
rate specified in the MediaSampleRateHertz
of the
request isn't valid. The sample rate must be between 8000 and
48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample
rate specified in the MediaSampleRateHertz
field
in the request. Check the sample rate of your media file and
make sure that the two values match.
Invalid file size: file size too large
- The size
of your audio file is larger than what Amazon Transcribe
Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical
Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe
Medical is configured to process. To request additional
channels, see Amazon Transcribe Medical Endpoints and Quotas in the
Amazon Web Services General Reference
public MedicalTranscriptionSetting getSettings()
Object that contains object.
Object that contains object.
public void setSettings(MedicalTranscriptionSetting settings)
Object that contains object.
settings
- Object that contains object.
public MedicalTranscriptionJob withSettings(MedicalTranscriptionSetting settings)
Object that contains object.
Returns a reference to this object so that method calls can be chained together.
settings
- Object that contains object.
public java.lang.String getSpecialty()
The medical specialty of any clinicians providing a dictation or having a
conversation. PRIMARYCARE
is the only available setting for
this object. This specialty enables you to generate transcriptions for
the following medical fields:
Family Medicine
Constraints:
Allowed Values: PRIMARYCARE
The medical specialty of any clinicians providing a dictation or
having a conversation. PRIMARYCARE
is the only
available setting for this object. This specialty enables you to
generate transcriptions for the following medical fields:
Family Medicine
Specialty
public void setSpecialty(java.lang.String specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation. PRIMARYCARE
is the only available setting for
this object. This specialty enables you to generate transcriptions for
the following medical fields:
Family Medicine
Constraints:
Allowed Values: PRIMARYCARE
specialty
-
The medical specialty of any clinicians providing a dictation
or having a conversation. PRIMARYCARE
is the only
available setting for this object. This specialty enables you
to generate transcriptions for the following medical fields:
Family Medicine
Specialty
public MedicalTranscriptionJob withSpecialty(java.lang.String specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation. PRIMARYCARE
is the only available setting for
this object. This specialty enables you to generate transcriptions for
the following medical fields:
Family Medicine
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: PRIMARYCARE
specialty
-
The medical specialty of any clinicians providing a dictation
or having a conversation. PRIMARYCARE
is the only
available setting for this object. This specialty enables you
to generate transcriptions for the following medical fields:
Family Medicine
Specialty
public void setSpecialty(Specialty specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation. PRIMARYCARE
is the only available setting for
this object. This specialty enables you to generate transcriptions for
the following medical fields:
Family Medicine
Constraints:
Allowed Values: PRIMARYCARE
specialty
-
The medical specialty of any clinicians providing a dictation
or having a conversation. PRIMARYCARE
is the only
available setting for this object. This specialty enables you
to generate transcriptions for the following medical fields:
Family Medicine
Specialty
public MedicalTranscriptionJob withSpecialty(Specialty specialty)
The medical specialty of any clinicians providing a dictation or having a
conversation. PRIMARYCARE
is the only available setting for
this object. This specialty enables you to generate transcriptions for
the following medical fields:
Family Medicine
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: PRIMARYCARE
specialty
-
The medical specialty of any clinicians providing a dictation
or having a conversation. PRIMARYCARE
is the only
available setting for this object. This specialty enables you
to generate transcriptions for the following medical fields:
Family Medicine
Specialty
public java.lang.String getType()
The type of speech in the transcription job. CONVERSATION
is
generally used for patient-physician dialogues. DICTATION
is
the setting for physicians speaking their notes after seeing a patient.
For more information, see how-it-works-med
Constraints:
Allowed Values: CONVERSATION, DICTATION
The type of speech in the transcription job.
CONVERSATION
is generally used for patient-physician
dialogues. DICTATION
is the setting for physicians
speaking their notes after seeing a patient. For more
information, see how-it-works-med
Type
public void setType(java.lang.String type)
The type of speech in the transcription job. CONVERSATION
is
generally used for patient-physician dialogues. DICTATION
is
the setting for physicians speaking their notes after seeing a patient.
For more information, see how-it-works-med
Constraints:
Allowed Values: CONVERSATION, DICTATION
type
-
The type of speech in the transcription job.
CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the
setting for physicians speaking their notes after seeing a
patient. For more information, see how-it-works-med
Type
public MedicalTranscriptionJob withType(java.lang.String type)
The type of speech in the transcription job. CONVERSATION
is
generally used for patient-physician dialogues. DICTATION
is
the setting for physicians speaking their notes after seeing a patient.
For more information, see how-it-works-med
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONVERSATION, DICTATION
type
-
The type of speech in the transcription job.
CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the
setting for physicians speaking their notes after seeing a
patient. For more information, see how-it-works-med
Type
public void setType(Type type)
The type of speech in the transcription job. CONVERSATION
is
generally used for patient-physician dialogues. DICTATION
is
the setting for physicians speaking their notes after seeing a patient.
For more information, see how-it-works-med
Constraints:
Allowed Values: CONVERSATION, DICTATION
type
-
The type of speech in the transcription job.
CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the
setting for physicians speaking their notes after seeing a
patient. For more information, see how-it-works-med
Type
public MedicalTranscriptionJob withType(Type type)
The type of speech in the transcription job. CONVERSATION
is
generally used for patient-physician dialogues. DICTATION
is
the setting for physicians speaking their notes after seeing a patient.
For more information, see how-it-works-med
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONVERSATION, DICTATION
type
-
The type of speech in the transcription job.
CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the
setting for physicians speaking their notes after seeing a
patient. For more information, see how-it-works-med
Type
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.