ITranscribeStartTranscriptionJobRequest
Interface in AWS.Transcribe
Interface for StartTranscriptionJob requests.
Ancestors
Properties
ContentRedaction
property ContentRedaction: ITranscribeContentRedaction
Type: ITranscribeContentRedaction
Specify whether to flag or redact specified personally identifiable information (PII) in the transcript.
IdentifyLanguage
property IdentifyLanguage: TOptional<Boolean>
Specify whether to enable automatic language identification in the transcription job.
When enabled, a list of language codes can be optionally specified in LanguageOptions that you think may be present in the media. You must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in the request.
IdentifyMultipleLanguages
property IdentifyMultipleLanguages: TOptional<Boolean>
Specify whether to enable automatic multi-language identification in the transcription job.
When enabled, a list of language codes can be optionally specified in LanguageOptions that you think may be present in the media. You must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in the request.
JobExecutionSettings
property JobExecutionSettings: ITranscribeJobExecutionSettings
Type: ITranscribeJobExecutionSettings
Specify how the transcription job is processed.
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.
LanguageIdSettings
property LanguageIdSettings: TDictionary<string, ITranscribeLanguageIdSettings>
Type: ITranscribeLanguageIdSettings
Specifies settings for languages when using automatic language identification.
A maximum of 5 entries can be specified.
LanguageOptions
property LanguageOptions: TList<string>
Specify language codes representing languages you think will be present in 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. )
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. In most cases this value can be omitted. value.
ModelSettings
property ModelSettings: ITranscribeModelSettings
Type: ITranscribeModelSettings
Specify a custom language model to use when processing the transcription job.
OutputBucketName
property OutputBucketName: string
Specify the name of an Amazon S3 bucket to store the output from the 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 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 TranscriptionJobName. 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: ITranscribeSettings
Type: ITranscribeSettings
Specify additional settings for the transcription job.
Subtitles
property Subtitles: ITranscribeSubtitles
Type: ITranscribeSubtitles
Specify whether to generate subtitles for the input media.
Tags
property Tags: TList<ITranscribeTag>
Type: ITranscribeTag
Specify a list of tags to associate with the transcription job.
TranscriptionJobName
property TranscriptionJobName: string
Specify a unique name for the transcription job.
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. |
AddLanguageIdSettings
procedure AddLanguageIdSettings(const ALanguageCode: string; const ALanguageIdSettings: ITranscribeLanguageIdSettings);
Add
Parameters
| Name | Description |
|---|---|
ALanguageCode | The language code to apply settings to. Valid values:||||||||||||||||||||||||||||||||||||||. |
ALanguageIdSettings | Specify the settings to apply to the specified language code. |
AddLanguageOption
function AddLanguageOption(const ALanguageCode: string): Integer;
Add a language code to LanguageOptions.
Parameters
| Name | Description |
|---|---|
ALanguageCode | Specify a language code to add to LanguageOptions. Valid values:||||||||||||||||||||||||||||||||||||||. |
Returns
Returns the index of the language code added to LanguageOptions.
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.