Creates an instance of TranscriptRequest.
The URL of your media file to transcribe.
The duration of your media file, in seconds.
The point in time, in milliseconds, to stop transcribing in your media file.
The point in time, in milliseconds, to begin transcription from in your media file.
The URL of your media file to transcribe.
Enable Auto Chapters, can be true or false.
Enable Automatic Transcript Highlights, can be true or false.
The list of results when enabling Automatic Transcript Highlights.
The weight to apply to words/phrases in the word_boost array; can be "low", "default", or "high".
When Auto Chapters is enabled, the list of Auto Chapters results.
The confidence our model has in the transcribed text, between 0.0 and 1.0.
Enable Content Safety Detection, can be true or false.
The list of results when TranscriptRequest.content_safety is true.
Customize how words are spelled and formatted using to and from values.
Transcribe Filler Words, like "umm", in your media file; can be true or false.
Enable Dual Channel transcription, can be true or false.
When Entity Detection is enabled, the list of detected Entities.
Enable Entity Detection, can be true or false.
The error message if the transcript status is error.
Filter profanity from the transcribed text, can be true or false.
Enable Text Formatting, can be true or false.
Enable Topic Detection, can be true or false.
Enable Topic Detection, can be true or false.
The unique identifier of your transcription.
The language of your audio file. Possible values are found in Supported Languages. The default value is en_us.
Enable Automatic Language Detection, can be true or false.
The Automatic Language Detection feature can identify the dominant language that’s spoken in an audio file, and route the file to the appropriate model for the detected language.
Note - Automatic Language Detection supports detecting English, French, German, Italian, and Spanish currently. We will be adding support for more languages over time.
To enable this feature, include the language_detection parameter with a value of true in your POST request when submitting a file for processing.
If you know the language of the spoken audio in a file, you can specify that in your POST request as shown in the documentation for Specifying a Language.
Heads Up - In order to reliably identify the dominant language in a file, the model needs approximately 50 seconds of spoken audio in that language over the course of the audio file.
Enable Automatic Punctuation, can be true or false.
Redact PII from the transcribed text, can be true or false.
With PII Redaction, the API can automatically remove Personally Identifiable Information (PII), such as phone numbers and social security numbers, from the transcription text before it is returned to you.
All redacted text will be replaced with # characters. For example, if the phone number 111-2222 was spoken in the audio, it would be transcribed as ###-#### in the text.
Generate a copy of the original media file with spoken PII "beeped" out, can be true or false.
The list of PII Redaction policies to enable.
To best-fit PII Redaction to your use case and data, you can select from a set of redaction policies when using PII Redaction. Simply include any or some of the below policy names in the redact_pii_policies array when making your POST request as shown on the right.
| Policy Name | Description |
|---|---|
| medical_process | Medical process, including treatments, procedures, and tests (e.g., heart surgery, CT scan) |
| medical_condition | Name of a medical condition, disease, syndrome, deficit, or disorder (e.g., chronic fatigue syndrome, arrhythmia, depression) |
| blood_type | Blood type (e.g., O-, AB positive) |
| drug | Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, Panadol) |
| injury | Bodily injury (e.g., I broke my arm, I have a sprained wrist) |
| number_sequence | A "lazy" rule that will redact any sequence of numbers equal to or greater than 2 |
| email_address | Email address (e.g., support@assemblyai.com)) |
| date_of_birth | Date of Birth (e.g., Date of Birth: March 7,1961) |
| phone_number | Telephone or fax number |
| us_social_security_number | Social Security Number or equivalent |
| credit_card_number | Credit card number |
| credit_card_expiration | Expiration date of a credit card |
| credit_card_cvv | Credit card verification code (e.g., CVV: 080) |
| date | Specific calendar date (e.g., December 18) |
| nationality | Terms indicating nationality, ethnicity, or race (e.g., American, Asian, Caucasian) |
| event | Name of an event or holiday (e.g., Olympics, Yom Kippur) |
| language | Name of a natural language (e.g., Spanish, French) |
| location | Any Location reference including mailing address, postal code, city, state, province, or country |
| money_amount | Name and/or amount of currency (e.g., 15 pesos, $94.50) |
| person_name | Name of a person (e.g., Bob, Doug Jones) |
| person_age | Number associated with an age (e.g., 27, 75) |
| organization | Name of an organization (e.g., CNN, McDonalds, University of Alaska) |
| political_affiliation | Terms referring to a political party, movement, or ideology (e.g., Republican, Liberal) |
| occupation | Job title or profession (e.g., professor, actors, engineer, CPA) |
| religion | Terms indicating religious affiliation (e.g., Hindu, Catholic) |
| drivers_license | Driver’s license number (e.g., DL# 356933-540) |
| banking_information | Banking information, including account and routing numbers |
The replacement logic for detected PII, can be "entity_type" or "hash".
Enable Sentiment Analysis, can be true or false.
When Sentiment Analysis is enabled, the list of Sentiment Analysis results.
Enable Speaker Diarization, can be true or false.
The status of your transcription. queued, processing, completed, or error
The text transcription of your media file.
When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterances.
The status code we received from your server when delivering your webhook.
The URL we should send webhooks to when your transcript is complete.
A list of custom vocabulary to boost accuracy for.
A list of all the individual words transcribed.
Generated using TypeDoc
This is an object representing a transcription. You can create them, retrieve them to see their status and results, and delete them.