ITranscribeStartMedicalTranscriptionJobRequest
Interface in AWS.Transcribe
Interface for StartMedicalTranscriptionJob requests.
Ancestors
Properties
ContentIdentificationType
property ContentIdentificationType: string
Specify whether to label all personal health information (PHI) identified in the transcript.
Valid values: PHI.
KMSEncryptionContext
property KMSEncryptionContext: TDictionary<string, string>
Specify encryption context in the form of non-secret key-value pairs.
LanguageCode
property LanguageCode: string
Specify the language code that represents the language of the content of the media file.
Valid values: af-ZA | ar-AE | ar-SA | 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 | 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 | vi-VN | sv-SE. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.
Media
property Media: ITranscribeMedia
Type: ITranscribeMedia
Specify the location of the media to transcribe.
MediaFormat
property MediaFormat: string
Specify the format of the input media.
Valid values: mp3 | mp4 | wav | flac | ogg | amr | webm.
MediaSampleRateHertz
property MediaSampleRateHertz: TOptional<Integer>
Specify the sample rate in hertz, of the audio track in the input media file.
Valid range: minimum 16000, maximum 48000. If specified, the value must match the media file's sample rate otherwise it will fail. If not specified, Amazon Transcribe Medical determines the value automatically. It is advised to omit this value.
MedicalTranscriptionJobName
property MedicalTranscriptionJobName: string
Specify a unique name for the medical transcription job.
OutputBucketName
property OutputBucketName: string
Specify the name of an Amazon S3 bucket to store the output from the medical transcription job.
Do not include the s3:// prefix. To specify a sub-folder in the bucket, use the OutputKey parameter.
OutputEncryptionKMSKeyId
property OutputEncryptionKMSKeyId: string
Specify the KMS key you want to use to encrypt the medical transcription output.
OutputKey
property OutputKey: string
Specify the output location for the transcript within the Amazon S3 bucket specified by OutputBucketName.
If not specified, the default name will be the specified MedicalTranscriptionJobName. The OutputKey can be specified as:
- A folder to contain the transcript e.g.
transcripts/. - A custom filename to use, inluding path, to contain the transcript e.g.
transcripts/my-transcript.json. If a non-existent folder is specified, it is created for you.
Settings
property Settings: ITranscribeMedicalTranscriptionSetting
Type: ITranscribeMedicalTranscriptionSetting
Specify additional settings for the medical transcription job.
Specialty
property Specialty: string
Specify the predominent medical specialty represented in the media.
For batch transcriptions, the only valid value is PRIMARYCARE.
Tags
property Tags: TList<ITranscribeTag>
Type: ITranscribeTag
Specify a list of tags to associate with the medical transcription job.
Type
property Type: string
Specify whether the input media contains only one person (DICTATION), or a two people having a conversation (CONVERSATION).
Valid values: CONVERSATION | DICTATION. DICTATION is suitable medical professionals wanting to transcribe their voice memos. CONVERSATION may be used for transcribing doctor-patient dialog.
Methods
AddKMSEncryptionContext
procedure AddKMSEncryptionContext(const AKey, AValue: string);
Add a key-value pair to KMSEncryptionContext.
Parameters
| Name | Description |
|---|---|
AKey | Specify a key for the value being added to KMSEncryptionContext. |
AValue | Specify a value to add to KMSEncryptionContext. |
AddTag
function AddTag(const AKey, AValue: string): Integer;
Add a key-value pair to Tags.
Parameters
| Name | Description |
|---|---|
AKey | Specify a key for the tag. |
AValue | Specify a value for the tag. |
Returns
Returns the index of the tag added to Tags.