2021/08/26 - Amazon Transcribe Service - 21 updated api methods
Changes This release adds support for batch transcription in six new languages - Afrikaans, Danish, Mandarin Chinese (Taiwan), New Zealand English, South African English, and Thai.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
See also: AWS API Documentation
Request Syntax
client.create_medical_vocabulary(
VocabularyName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
VocabularyFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the custom vocabulary. This case-sensitive name must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a ConflictException error.
string
[REQUIRED]
The language code for the language used for the entries in your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
string
[REQUIRED]
The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling. Enter information about your VocabularyFileUri in the following format:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
The following is an example URI for a vocabulary file that is stored in Amazon S3:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Medical Custom Vocabularies.
list
Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) -- [REQUIRED]
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) -- [REQUIRED]
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case sensitive.
LanguageCode (string) --
The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.
VocabularyState (string) --
The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.
LastModifiedTime (datetime) --
The date and time that you created the vocabulary.
FailureReason (string) --
If the VocabularyState field is FAILED, this field contains information about why the job failed.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
See also: AWS API Documentation
Request Syntax
client.create_vocabulary(
VocabularyName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
Phrases=[
'string',
],
VocabularyFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
string
[REQUIRED]
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.
list
An array of strings that contains the vocabulary entries.
(string) --
string
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom vocabularies.
list
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) -- [REQUIRED]
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) -- [REQUIRED]
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries.
VocabularyState (string) --
The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
LastModifiedTime (datetime) --
The date and time that the vocabulary was created.
FailureReason (string) --
If the VocabularyState field is FAILED, this field contains information about why the job failed.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
See also: AWS API Documentation
Request Syntax
client.create_vocabulary_filter(
VocabularyFilterName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
Words=[
'string',
],
VocabularyFilterFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.
string
[REQUIRED]
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
list
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
(string) --
string
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
list
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you create this new vocabulary filter.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) -- [REQUIRED]
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) -- [REQUIRED]
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the vocabulary filter.
LanguageCode (string) --
The language code of the words in the collection.
LastModifiedTime (datetime) --
The date and time that the vocabulary filter was modified.
{'CallAnalyticsJob': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'},
'Settings': {'LanguageOptions': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}}
Returns information about a call analytics job. To see the status of the job, check the CallAnalyticsJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.
See also: AWS API Documentation
Request Syntax
client.get_call_analytics_job(
CallAnalyticsJobName='string'
)
string
[REQUIRED]
The name of the analytics job you want information about. This value is case sensitive.
dict
Response Syntax
{
'CallAnalyticsJob': {
'CallAnalyticsJobName': 'string',
'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DataAccessRoleArn': 'string',
'IdentifiedLanguageScore': ...,
'Settings': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'LanguageModelName': 'string',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'LanguageOptions': [
'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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
]
},
'ChannelDefinitions': [
{
'ChannelId': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER'
},
]
}
}
Response Structure
(dict) --
CallAnalyticsJob (dict) --
An object that contains the results of your call analytics job.
CallAnalyticsJobName (string) --
The name of the call analytics job.
CallAnalyticsJobStatus (string) --
The status of the analytics job.
LanguageCode (string) --
If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for additional information.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the audio.
MediaFormat (string) --
The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
Identifies the location of a transcription.
TranscriptFileUri (string) --
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
RedactedTranscriptFileUri (string) --
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
StartTime (datetime) --
A timestamp that shows when the analytics job started processing.
CreationTime (datetime) --
A timestamp that shows when the analytics job was created.
CompletionTime (datetime) --
A timestamp that shows when the analytics job was completed.
FailureReason (string) --
If the AnalyticsJobStatus is FAILED, this field contains information about why the job failed.
The FailureReason field can contain 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 8,000 and 48,000 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.
DataAccessRoleArn (string) --
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified
Settings (dict) --
Provides information about the settings used to run a transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the call analytics job.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
LanguageModelName (string) --
The structure used to describe a custom language model.
ContentRedaction (dict) --
Settings for content redaction within a transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
LanguageOptions (list) --
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
(string) --
ChannelDefinitions (list) --
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
(dict) --
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
ChannelId (integer) --
A value that indicates the audio channel.
ParticipantRole (string) --
Indicates whether the person speaking on the audio channel is the agent or customer.
{'MedicalTranscriptionJob': {'LanguageCode': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}
Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.
See also: AWS API Documentation
Request Syntax
client.get_medical_transcription_job(
MedicalTranscriptionJobName='string'
)
string
[REQUIRED]
The name of the medical transcription job.
dict
Response Syntax
{
'MedicalTranscriptionJob': {
'MedicalTranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyName': 'string'
},
'ContentIdentificationType': 'PHI',
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
MedicalTranscriptionJob (dict) --
An object that contains the results of the medical transcription job.
MedicalTranscriptionJobName (string) --
The name for a given medical transcription job.
TranscriptionJobStatus (string) --
The completion status of a medical transcription job.
LanguageCode (string) --
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.
MediaSampleRateHertz (integer) --
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 MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
TranscriptFileUri (string) --
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
FailureReason (string) --
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 8,000 and 48,000 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
Settings (dict) --
Object that contains object.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyName (string) --
The name of the vocabulary to use when processing a medical transcription job.
ContentIdentificationType (string) --
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
Specialty (string) --
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to `Transcribing a medical conversation <https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html>`__for a list of supported specialties.
Type (string) --
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 What is Amazon Transcribe Medical?.
Tags (list) --
A key:value pair assigned to a given medical transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) --
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) --
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Retrieves information about a medical vocabulary.
See also: AWS API Documentation
Request Syntax
client.get_medical_vocabulary(
VocabularyName='string'
)
string
[REQUIRED]
The name of the vocabulary that you want information about. The value is case sensitive.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DownloadUri': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary returned by Amazon Transcribe Medical.
LanguageCode (string) --
The valid language code for your vocabulary entries.
VocabularyState (string) --
The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
FailureReason (string) --
If the VocabularyState is FAILED, this field contains information about why the job failed.
DownloadUri (string) --
The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
{'TranscriptionJob': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'},
'LanguageOptions': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}}
Returns information about a transcription job. To see the status of the 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 the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.
See also: AWS API Documentation
Request Syntax
client.get_transcription_job(
TranscriptionJobName='string'
)
string
[REQUIRED]
The name of the job.
dict
Response Syntax
{
'TranscriptionJob': {
'TranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'VocabularyName': 'string',
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag'
},
'ModelSettings': {
'LanguageModelName': 'string'
},
'JobExecutionSettings': {
'AllowDeferredExecution': True|False,
'DataAccessRoleArn': 'string'
},
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'IdentifyLanguage': True|False,
'LanguageOptions': [
'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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'IdentifiedLanguageScore': ...,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TranscriptionJob (dict) --
An object that contains the results of the transcription job.
TranscriptionJobName (string) --
The name of the transcription job.
TranscriptionJobStatus (string) --
The status of the transcription job.
LanguageCode (string) --
The language code for the input speech.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the audio track in the input media file.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
An object that describes the input media for the transcription job.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
An object that describes the output of the transcription job.
TranscriptFileUri (string) --
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
RedactedTranscriptFileUri (string) --
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job completed.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
The FailureReason field can contain 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 that 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 8,000 and 48,000 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 Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
Settings (dict) --
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the transcription job.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
ShowAlternatives (boolean) --
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
ModelSettings (dict) --
An object containing the details of your custom language model.
LanguageModelName (string) --
The name of your custom language model.
JobExecutionSettings (dict) --
Provides information about how a transcription job is executed.
AllowDeferredExecution (boolean) --
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
ContentRedaction (dict) --
An object that describes content redaction settings for the transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
IdentifyLanguage (boolean) --
A value that shows if automatic language identification was enabled for a transcription job.
LanguageOptions (list) --
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
(string) --
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
Tags (list) --
A key:value pair assigned to a given transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) --
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) --
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Gets information about a vocabulary.
See also: AWS API Documentation
Request Syntax
client.get_vocabulary(
VocabularyName='string'
)
string
[REQUIRED]
The name of the vocabulary to return information about. The name is case sensitive.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DownloadUri': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary to return.
LanguageCode (string) --
The language code of the vocabulary entries.
VocabularyState (string) --
The processing state of the vocabulary.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last modified.
FailureReason (string) --
If the VocabularyState field is FAILED, this field contains information about why the job failed.
DownloadUri (string) --
The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Returns information about a vocabulary filter.
See also: AWS API Documentation
Request Syntax
client.get_vocabulary_filter(
VocabularyFilterName='string'
)
string
[REQUIRED]
The name of the vocabulary filter for which to return information.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'DownloadUri': 'string'
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the vocabulary filter.
LanguageCode (string) --
The language code of the words in the vocabulary filter.
LastModifiedTime (datetime) --
The date and time that the contents of the vocabulary filter were updated.
DownloadUri (string) --
The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
{'CallAnalyticsJobSummaries': {'LanguageCode': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}
List call analytics jobs with a specified status or substring that matches their names.
See also: AWS API Documentation
Request Syntax
client.list_call_analytics_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
string
When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.
string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
string
If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.
integer
The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'CallAnalyticsJobSummaries': [
{
'CallAnalyticsJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string'
},
]
}
Response Structure
(dict) --
Status (string) --
When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
NextToken (string) --
The operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in your next request to the operation to return next page of jobs.
CallAnalyticsJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides summary information about a call analytics job.
CallAnalyticsJobName (string) --
The name of the call analytics job.
CreationTime (datetime) --
A timestamp that shows when the call analytics job was created.
StartTime (datetime) --
A timestamp that shows when the job began processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language of the transcript in the source audio file.
CallAnalyticsJobStatus (string) --
The status of the call analytics job.
FailureReason (string) --
If the CallAnalyticsJobStatus is FAILED, a description of the error.
{'MedicalTranscriptionJobSummaries': {'LanguageCode': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}
Lists medical transcription jobs with a specified status or substring that matches their names.
See also: AWS API Documentation
Request Syntax
client.list_medical_transcription_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
string
When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
string
If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
integer
The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'MedicalTranscriptionJobSummaries': [
{
'MedicalTranscriptionJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string',
'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET',
'Specialty': 'PRIMARYCARE',
'ContentIdentificationType': 'PHI',
'Type': 'CONVERSATION'|'DICTATION'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested status of the medical transcription jobs returned.
NextToken (string) --
The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
MedicalTranscriptionJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides summary information about a transcription job.
MedicalTranscriptionJobName (string) --
The name of a medical transcription job.
CreationTime (datetime) --
A timestamp that shows when the medical transcription job was created.
StartTime (datetime) --
A timestamp that shows when the job began processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language of the transcript in the source audio file.
TranscriptionJobStatus (string) --
The status of the medical transcription job.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED, a description of the error.
OutputLocationType (string) --
Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.
Specialty (string) --
The medical specialty of the transcription job. Refer to `Transcribing a medical conversation <https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html>`__for a list of supported specialties.
ContentIdentificationType (string) --
Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the transcription job to identify personal health information (PHI).
Type (string) --
The speech of the clinician in the input audio.
{'Vocabularies': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}}
Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.
See also: AWS API Documentation
Request Syntax
client.list_medical_vocabularies(
NextToken='string',
MaxResults=123,
StateEquals='PENDING'|'READY'|'FAILED',
NameContains='string'
)
string
If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.
integer
The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
string
When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.
string
Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both " vocabularyname" and " VocabularyName".
dict
Response Syntax
{
'Status': 'PENDING'|'READY'|'FAILED',
'NextToken': 'string',
'Vocabularies': [
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested vocabulary state.
NextToken (string) --
The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, include the token in the next request to the ListMedicalVocabularies operation .
Vocabularies (list) --
A list of objects that describe the vocabularies that match your search criteria.
(dict) --
Provides information about a custom vocabulary.
VocabularyName (string) --
The name of the vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last modified.
VocabularyState (string) --
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
{'TranscriptionJobSummaries': {'LanguageCode': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}
Lists transcription jobs with the specified status.
See also: AWS API Documentation
Request Syntax
client.list_transcription_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
string
When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
string
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
string
If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.
integer
The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'TranscriptionJobSummaries': [
{
'TranscriptionJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string',
'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'ModelSettings': {
'LanguageModelName': 'string'
},
'IdentifyLanguage': True|False,
'IdentifiedLanguageScore': ...
},
]
}
Response Structure
(dict) --
Status (string) --
The requested status of the jobs returned.
NextToken (string) --
The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
TranscriptionJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides a summary of information about a transcription job.
TranscriptionJobName (string) --
The name of the transcription job.
CreationTime (datetime) --
A timestamp that shows when the job was created.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language code for the input speech.
TranscriptionJobStatus (string) --
The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED, a description of the error.
OutputLocationType (string) --
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.
ContentRedaction (dict) --
The content redaction settings of the transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
ModelSettings (dict) --
The object used to call your custom language model to your transcription job.
LanguageModelName (string) --
The name of your custom language model.
IdentifyLanguage (boolean) --
Whether automatic language identification was enabled for a transcription job.
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
{'Vocabularies': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}}
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
See also: AWS API Documentation
Request Syntax
client.list_vocabularies(
NextToken='string',
MaxResults=123,
StateEquals='PENDING'|'READY'|'FAILED',
NameContains='string'
)
string
If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
integer
The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
string
When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
string
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.
dict
Response Syntax
{
'Status': 'PENDING'|'READY'|'FAILED',
'NextToken': 'string',
'Vocabularies': [
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested vocabulary state.
NextToken (string) --
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.
Vocabularies (list) --
A list of objects that describe the vocabularies that match the search criteria in the request.
(dict) --
Provides information about a custom vocabulary.
VocabularyName (string) --
The name of the vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last modified.
VocabularyState (string) --
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
{'VocabularyFilters': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}}
Gets information about vocabulary filters.
See also: AWS API Documentation
Request Syntax
client.list_vocabulary_filters(
NextToken='string',
MaxResults=123,
NameContains='string'
)
string
If the result of the previous request to ListVocabularyFilters was truncated, include the NextToken to fetch the next set of collections.
integer
The maximum number of filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
string
Filters the response so that it only contains vocabulary filters whose name contains the specified string.
dict
Response Syntax
{
'NextToken': 'string',
'VocabularyFilters': [
{
'VocabularyFilterName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The ListVocabularyFilters operation returns a page of collections at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularyFilters operation to return in the next page of jobs.
VocabularyFilters (list) --
The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
(dict) --
Provides information about a vocabulary filter.
VocabularyFilterName (string) --
The name of the vocabulary filter. The name must be unique in the account that holds the filter.
LanguageCode (string) --
The language code of the words in the vocabulary filter.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last updated.
{'Settings': {'LanguageOptions': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}}
Response {'CallAnalyticsJob': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'},
'Settings': {'LanguageOptions': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}}
Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
See also: AWS API Documentation
Request Syntax
client.start_call_analytics_job(
CallAnalyticsJobName='string',
Media={
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
OutputLocation='string',
OutputEncryptionKMSKeyId='string',
DataAccessRoleArn='string',
Settings={
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'LanguageModelName': 'string',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'LanguageOptions': [
'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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
]
},
ChannelDefinitions=[
{
'ChannelId': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER'
},
]
)
string
[REQUIRED]
The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.
dict
[REQUIRED]
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
string
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
s3://DOC-EXAMPLE-BUCKET1 If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
s3://DOC-EXAMPLE-BUCKET1/folder/ f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json If you specify a folder, you must provide a trailing slash.
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.
string
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.
You use either of the following to identify an Amazon Web Services KMS key in the current account:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputLocation parameter.
string
[REQUIRED]
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.
dict
A Settings object that provides optional settings for a call analytics job.
VocabularyName (string) --
The name of a vocabulary to use when processing the call analytics job.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
LanguageModelName (string) --
The structure used to describe a custom language model.
ContentRedaction (dict) --
Settings for content redaction within a transcription job.
RedactionType (string) -- [REQUIRED]
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) -- [REQUIRED]
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
LanguageOptions (list) --
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
(string) --
list
When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.
(dict) --
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
ChannelId (integer) --
A value that indicates the audio channel.
ParticipantRole (string) --
Indicates whether the person speaking on the audio channel is the agent or customer.
dict
Response Syntax
{
'CallAnalyticsJob': {
'CallAnalyticsJobName': 'string',
'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DataAccessRoleArn': 'string',
'IdentifiedLanguageScore': ...,
'Settings': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'LanguageModelName': 'string',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'LanguageOptions': [
'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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
]
},
'ChannelDefinitions': [
{
'ChannelId': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER'
},
]
}
}
Response Structure
(dict) --
CallAnalyticsJob (dict) --
An object containing the details of the asynchronous call analytics job.
CallAnalyticsJobName (string) --
The name of the call analytics job.
CallAnalyticsJobStatus (string) --
The status of the analytics job.
LanguageCode (string) --
If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for additional information.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the audio.
MediaFormat (string) --
The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
Identifies the location of a transcription.
TranscriptFileUri (string) --
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
RedactedTranscriptFileUri (string) --
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
StartTime (datetime) --
A timestamp that shows when the analytics job started processing.
CreationTime (datetime) --
A timestamp that shows when the analytics job was created.
CompletionTime (datetime) --
A timestamp that shows when the analytics job was completed.
FailureReason (string) --
If the AnalyticsJobStatus is FAILED, this field contains information about why the job failed.
The FailureReason field can contain 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 8,000 and 48,000 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.
DataAccessRoleArn (string) --
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified
Settings (dict) --
Provides information about the settings used to run a transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the call analytics job.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
LanguageModelName (string) --
The structure used to describe a custom language model.
ContentRedaction (dict) --
Settings for content redaction within a transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
LanguageOptions (list) --
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
(string) --
ChannelDefinitions (list) --
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
(dict) --
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
ChannelId (integer) --
A value that indicates the audio channel.
ParticipantRole (string) --
Indicates whether the person speaking on the audio channel is the agent or customer.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Response {'MedicalTranscriptionJob': {'LanguageCode': {'en-NZ',
'en-ZA',
'th-TH',
'zh-TW'}}}
Starts a batch job to transcribe medical speech to text.
See also: AWS API Documentation
Request Syntax
client.start_medical_transcription_job(
MedicalTranscriptionJobName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
MediaSampleRateHertz=123,
MediaFormat='mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
Media={
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
OutputBucketName='string',
OutputKey='string',
OutputEncryptionKMSKeyId='string',
Settings={
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyName': 'string'
},
ContentIdentificationType='PHI',
Specialty='PRIMARYCARE',
Type='CONVERSATION'|'DICTATION',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the medical transcription job. You can't use the strings " ." or " .." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
string
[REQUIRED]
The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
integer
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
string
The audio format of the input media file.
dict
[REQUIRED]
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
string
[REQUIRED]
The Amazon S3 location where the transcription is stored.
You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
string
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
string
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
dict
Optional settings for the medical transcription job.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyName (string) --
The name of the vocabulary to use when processing a medical transcription job.
string
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
string
[REQUIRED]
The medical specialty of any clinician speaking in the input media.
string
[REQUIRED]
The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
list
Add tags to an Amazon Transcribe medical transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) -- [REQUIRED]
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) -- [REQUIRED]
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'MedicalTranscriptionJob': {
'MedicalTranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyName': 'string'
},
'ContentIdentificationType': 'PHI',
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
MedicalTranscriptionJob (dict) --
A batch job submitted to transcribe medical speech to text.
MedicalTranscriptionJobName (string) --
The name for a given medical transcription job.
TranscriptionJobStatus (string) --
The completion status of a medical transcription job.
LanguageCode (string) --
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.
MediaSampleRateHertz (integer) --
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 MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
TranscriptFileUri (string) --
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
FailureReason (string) --
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 8,000 and 48,000 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
Settings (dict) --
Object that contains object.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyName (string) --
The name of the vocabulary to use when processing a medical transcription job.
ContentIdentificationType (string) --
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
Specialty (string) --
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to `Transcribing a medical conversation <https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html>`__for a list of supported specialties.
Type (string) --
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 What is Amazon Transcribe Medical?.
Tags (list) --
A key:value pair assigned to a given medical transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) --
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) --
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'},
'LanguageOptions': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Response {'TranscriptionJob': {'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'},
'LanguageOptions': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}}
Starts an asynchronous job to transcribe speech to text.
See also: AWS API Documentation
Request Syntax
client.start_transcription_job(
TranscriptionJobName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
MediaSampleRateHertz=123,
MediaFormat='mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
Media={
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
OutputBucketName='string',
OutputKey='string',
OutputEncryptionKMSKeyId='string',
Settings={
'VocabularyName': 'string',
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag'
},
ModelSettings={
'LanguageModelName': 'string'
},
JobExecutionSettings={
'AllowDeferredExecution': True|False,
'DataAccessRoleArn': 'string'
},
ContentRedaction={
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
IdentifyLanguage=True|False,
LanguageOptions=[
'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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the job. You can't use the strings " ." or " .." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
string
The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
integer
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
string
The format of the input media file.
dict
[REQUIRED]
An object that describes the input media for a transcription job.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
string
The location where the transcription is stored.
If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
string
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
string
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
You can use either of the following to identify a KMS key in the current account:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
dict
A Settings object that provides optional settings for a transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the transcription job.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
ShowAlternatives (boolean) --
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
dict
Choose the custom language model you use for your transcription job in this parameter.
LanguageModelName (string) --
The name of your custom language model.
dict
Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
AllowDeferredExecution (boolean) --
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
dict
An object that contains the request parameters for content redaction.
RedactionType (string) -- [REQUIRED]
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) -- [REQUIRED]
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
boolean
Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
list
An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
(string) --
list
Add tags to an Amazon Transcribe transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) -- [REQUIRED]
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) -- [REQUIRED]
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'TranscriptionJob': {
'TranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'VocabularyName': 'string',
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag'
},
'ModelSettings': {
'LanguageModelName': 'string'
},
'JobExecutionSettings': {
'AllowDeferredExecution': True|False,
'DataAccessRoleArn': 'string'
},
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'IdentifyLanguage': True|False,
'LanguageOptions': [
'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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'IdentifiedLanguageScore': ...,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TranscriptionJob (dict) --
An object containing details of the asynchronous transcription job.
TranscriptionJobName (string) --
The name of the transcription job.
TranscriptionJobStatus (string) --
The status of the transcription job.
LanguageCode (string) --
The language code for the input speech.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the audio track in the input media file.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
An object that describes the input media for the transcription job.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
An object that describes the output of the transcription job.
TranscriptFileUri (string) --
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
RedactedTranscriptFileUri (string) --
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job completed.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
The FailureReason field can contain 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 that 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 8,000 and 48,000 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 Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
Settings (dict) --
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the transcription job.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
ShowAlternatives (boolean) --
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
ModelSettings (dict) --
An object containing the details of your custom language model.
LanguageModelName (string) --
The name of your custom language model.
JobExecutionSettings (dict) --
Provides information about how a transcription job is executed.
AllowDeferredExecution (boolean) --
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
ContentRedaction (dict) --
An object that describes content redaction settings for the transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII.
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
IdentifyLanguage (boolean) --
A value that shows if automatic language identification was enabled for a transcription job.
LanguageOptions (list) --
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
(string) --
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
Tags (list) --
A key:value pair assigned to a given transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) --
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) --
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.
See also: AWS API Documentation
Request Syntax
client.update_medical_vocabulary(
VocabularyName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
VocabularyFileUri='string'
)
string
[REQUIRED]
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a ConflictException error.
string
[REQUIRED]
The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.
string
The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the updated vocabulary.
LanguageCode (string) --
The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
LastModifiedTime (datetime) --
The date and time that the vocabulary was updated.
VocabularyState (string) --
The processing state of the update to the vocabulary. When the VocabularyState field is READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
See also: AWS API Documentation
Request Syntax
client.update_vocabulary(
VocabularyName='string',
LanguageCode='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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
Phrases=[
'string',
],
VocabularyFileUri='string'
)
string
[REQUIRED]
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
string
[REQUIRED]
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.
list
An array of strings containing the vocabulary entries.
(string) --
string
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary that was updated.
LanguageCode (string) --
The language code of the vocabulary entries.
LastModifiedTime (datetime) --
The date and time that the vocabulary was updated.
VocabularyState (string) --
The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
{'LanguageCode': {'en-ZA', 'en-NZ', 'zh-TW', 'th-TH'}}
Updates a vocabulary filter with a new list of filtered words.
See also: AWS API Documentation
Request Syntax
client.update_vocabulary_filter(
VocabularyFilterName='string',
Words=[
'string',
],
VocabularyFilterFileUri='string'
)
string
[REQUIRED]
The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.
list
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
(string) --
string
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': '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'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the updated vocabulary filter.
LanguageCode (string) --
The language code of the words in the vocabulary filter.
LastModifiedTime (datetime) --
The date and time that the vocabulary filter was updated.