MedicalTranscriptionJob

import type { MedicalTranscriptionJob } from "https://aws-api.deno.dev/v0.3/services/transcribeservice.ts?docs=full";

The data structure that contains the information for a medical transcription job.

interface MedicalTranscriptionJob {

CompletionTime?: Date | number | null;

ContentIdentificationType?: MedicalContentIdentificationType | null;

CreationTime?: Date | number | null;

FailureReason?: string | null;

LanguageCode?: LanguageCode | null;

Media?: Media | null;

MediaFormat?: MediaFormat | null;

MediaSampleRateHertz?: number | null;

MedicalTranscriptionJobName?: string | null;

Settings?: MedicalTranscriptionSetting | null;

Specialty?: Specialty | null;

StartTime?: Date | number | null;

Tags?: Tag[] | null;

Transcript?: MedicalTranscript | null;

TranscriptionJobStatus?: TranscriptionJobStatus | null;

Type?: Type | null;

}

§Properties

CompletionTime?: Date | number | null

[src]

A timestamp that shows when the job was completed.

ContentIdentificationType?: MedicalContentIdentificationType | null

[src]

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.

CreationTime?: Date | number | null

[src]

A timestamp that shows when the job was created.

FailureReason?: string | null

[src]

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.

LanguageCode?: LanguageCode | null

[src]

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.

Media?: Media | null

[src]

MediaFormat?: MediaFormat | null

[src]

The format of the input media file.

MediaSampleRateHertz?: number | null

[src]

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.

MedicalTranscriptionJobName?: string | null

[src]

The name for a given medical transcription job.

Settings?: MedicalTranscriptionSetting | null

[src]

Object that contains object.

Specialty?: Specialty | null

[src]

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

StartTime?: Date | number | null

[src]

A timestamp that shows when the job started processing.

Tags?: Tag[] | null

[src]

A key:value pair assigned to a given medical transcription job.

Transcript?: MedicalTranscript | null

[src]

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

TranscriptionJobStatus?: TranscriptionJobStatus | null

[src]

The completion status of a medical transcription job.

Type?: Type | null

[src]

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?.