Type Alias TranscriptOptionalParams

TranscriptOptionalParams: {
    audio_end_at?: number;
    audio_start_from?: number;
    auto_chapters?: boolean;
    auto_highlights?: boolean;
    boost_param?: TranscriptBoostParam;
    content_safety?: boolean;
    content_safety_confidence?: number;
    custom_spelling?: TranscriptCustomSpelling[];
    custom_topics?: boolean;
    disfluencies?: boolean;
    dual_channel?: boolean;
    entity_detection?: boolean;
    filter_profanity?: boolean;
    format_text?: boolean;
    iab_categories?: boolean;
    language_code?: LiteralUnion<TranscriptLanguageCode, string> | null;
    language_confidence_threshold?: number;
    language_detection?: boolean;
    multichannel?: boolean;
    punctuate?: boolean;
    redact_pii?: boolean;
    redact_pii_audio?: boolean;
    redact_pii_audio_quality?: RedactPiiAudioQuality;
    redact_pii_policies?: PiiPolicy[];
    redact_pii_sub?: SubstitutionPolicy | null;
    sentiment_analysis?: boolean;
    speaker_labels?: boolean;
    speakers_expected?: number | null;
    speech_model?: SpeechModel | null;
    speech_threshold?: number | null;
    summarization?: boolean;
    summary_model?: SummaryModel;
    summary_type?: SummaryType;
    topics?: string[];
    webhook_auth_header_name?: string | null;
    webhook_auth_header_value?: string | null;
    webhook_url?: string;
    word_boost?: string[];
}

The parameters for creating a transcript

Type declaration

Optionalaudio_end_at?: number
The point in time, in milliseconds, to stop transcribing in your media file
Optionalaudio_start_from?: number
The point in time, in milliseconds, to begin transcribing in your media file
Optionalauto_chapters?: boolean
Enable Auto Chapters, can be true or false
Default Value
```
false
```
Optionalauto_highlights?: boolean
Enable Key Phrases, either true or false
Default Value
```
false
```
Optionalboost_param?: TranscriptBoostParam
How much to boost specified words
Default Value
```
default
```
Optionalcontent_safety?: boolean
Enable Content Moderation, can be true or false
Default Value
```
false
```
Optionalcontent_safety_confidence?: number
The confidence threshold for the Content Moderation model. Values must be between 25 and 100.
Default Value
```
50
```
Optionalcustom_spelling?: TranscriptCustomSpelling[]
Customize how words are spelled and formatted using to and from values
Optionalcustom_topics?: boolean
Enable custom topics, either true or false
Default Value
```
false
```
Optionaldisfluencies?: boolean
Transcribe Filler Words, like "umm", in your media file; can be true or false
Default Value
```
false
```
Optionaldual_channel?: boolean
Deprecated
Enable Dual Channel transcription, can be true or false.
Default Value
```
false
```
Optionalentity_detection?: boolean
Enable Entity Detection, can be true or false
Default Value
```
false
```
Optionalfilter_profanity?: boolean
Filter profanity from the transcribed text, can be true or false
Default Value
```
false
```
Optionalformat_text?: boolean
Enable Text Formatting, can be true or false
Default Value
```
true
```
Optionaliab_categories?: boolean
Enable Topic Detection, can be true or false
Default Value
```
false
```
Optionallanguage_code?: LiteralUnion<TranscriptLanguageCode, string> | null
The language of your audio file. Possible values are found in Supported Languages. The default value is 'en_us'.
Default Value
```
en_us
```
Optionallanguage_confidence_threshold?: number
The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold. Defaults to 0.
Default Value
```
0
```
Optionallanguage_detection?: boolean
Enable Automatic language detection, either true or false.
Default Value
```
false
```
Optionalmultichannel?: boolean
Enable Multichannel transcription, can be true or false.
Default Value
```
false
```
Optionalpunctuate?: boolean
Enable Automatic Punctuation, can be true or false
Default Value
```
true
```
Optionalredact_pii?: boolean
Redact PII from the transcribed text using the Redact PII model, can be true or false
Default Value
```
false
```
Optionalredact_pii_audio?: boolean
Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See PII redaction for more details.
Default Value
```
false
```
Optionalredact_pii_audio_quality?: RedactPiiAudioQuality
Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See PII redaction for more details.
Default Value
```
"mp3"
```
Optionalredact_pii_policies?: PiiPolicy[]
The list of PII Redaction policies to enable. See PII redaction for more details.
Optionalredact_pii_sub?: SubstitutionPolicy | null
The replacement logic for detected PII, can be "entity_type" or "hash". See PII redaction for more details.
Default Value
```
"hash"
```
Optionalsentiment_analysis?: boolean
Enable Sentiment Analysis, can be true or false
Default Value
```
false
```
Optionalspeaker_labels?: boolean
Enable Speaker diarization, can be true or false
Default Value
```
false
```
Optionalspeakers_expected?: number | null
Tells the speaker label model how many speakers it should attempt to identify, up to 10". See Speaker diarization for more details.
Default Value
```
"null
```
Optionalspeech_model?: SpeechModel | null
The speech model to use for the transcription. When null, the "best" model is used.
Default Value
```
best
```
Optionalspeech_threshold?: number | null
Reject audio files that contain less than this fraction of speech. Valid values are in the range [0", 1] inclusive.
Default Value
```
0
```
Optionalsummarization?: boolean
Enable Summarization, can be true or false
Default Value
```
false
```
Optionalsummary_model?: SummaryModel
The model to summarize the transcript
Default Value
```
informative
```
Optionalsummary_type?: SummaryType
The type of summary
Default Value
```
bullets
```
Optionaltopics?: string[]
The list of custom topics
Optionalwebhook_auth_header_name?: string | null
The header name to be sent with the transcript completed or failed webhook requests
Default Value
```
null
```
Optionalwebhook_auth_header_value?: string | null
The header value to send back with the transcript completed or failed webhook requests for added security
Default Value
```
null
```
Optionalwebhook_url?: string
The URL to which we send webhook requests. We sends two different types of webhook requests. One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.
Optionalword_boost?: string[]
The list of custom vocabulary to boost transcription probability for

Example

{
  "speech_model": null,
  "language_code": "en_us",
  "language_detection": true,
  "language_confidence_threshold": 0.7,
  "punctuate": true,
  "format_text": true,
  "multichannel": true,
  "dual_channel": false,
  "webhook_url": "https://your-webhook-url.tld/path",
  "webhook_auth_header_name": "webhook-secret",
  "webhook_auth_header_value": "webhook-secret-value",
  "auto_highlights": true,
  "audio_start_from": 10,
  "audio_end_at": 280,
  "word_boost": [
    "aws",
    "azure",
    "google cloud"
  ],
  "boost_param": "high",
  "filter_profanity": true,
  "redact_pii": true,
  "redact_pii_audio": true,
  "redact_pii_audio_quality": "mp3",
  "redact_pii_policies": [
    "us_social_security_number",
    "credit_card_number"
  ],
  "redact_pii_sub": "hash",
  "speaker_labels": true,
  "speakers_expected": 2,
  "content_safety": true,
  "iab_categories": true,
  "custom_spelling": [],
  "disfluencies": false,
  "sentiment_analysis": true,
  "auto_chapters": true,
  "entity_detection": true,
  "speech_threshold": 0.5,
  "summarization": true,
  "summary_model": "informative",
  "summary_type": "bullets",
  "custom_topics": true,
  "topics": []
}

Type Alias TranscriptOptionalParams

Type declaration

Optionalaudio_end_at?: number

Optionalaudio_start_from?: number

Optionalauto_chapters?: boolean

Default Value

Optionalauto_highlights?: boolean

Default Value

Optionalboost_param?: TranscriptBoostParam

Default Value

Optionalcontent_safety?: boolean

Default Value

Optionalcontent_safety_confidence?: number

Default Value

Optionalcustom_spelling?: TranscriptCustomSpelling[]

Optionalcustom_topics?: boolean

Default Value

Optionaldisfluencies?: boolean

Default Value

Optionaldual_channel?: boolean

Deprecated

Default Value

Optionalentity_detection?: boolean

Default Value

Optionalfilter_profanity?: boolean

Default Value

Optionalformat_text?: boolean

Default Value

Optionaliab_categories?: boolean

Default Value

Optionallanguage_code?: LiteralUnion<TranscriptLanguageCode, string> | null

Default Value

Optionallanguage_confidence_threshold?: number

Default Value

Optionallanguage_detection?: boolean

Default Value

Optionalmultichannel?: boolean

Default Value

Optionalpunctuate?: boolean

Default Value

Optionalredact_pii?: boolean

Default Value

Optionalredact_pii_audio?: boolean

Default Value

Optionalredact_pii_audio_quality?: RedactPiiAudioQuality

Default Value

Optionalredact_pii_policies?: PiiPolicy[]

Optionalredact_pii_sub?: SubstitutionPolicy | null

Default Value

Optionalsentiment_analysis?: boolean

Default Value

Optionalspeaker_labels?: boolean

Default Value

Optionalspeakers_expected?: number | null

Default Value

Optionalspeech_model?: SpeechModel | null

Default Value

Optionalspeech_threshold?: number | null

Default Value

Optionalsummarization?: boolean

Default Value

Optionalsummary_model?: SummaryModel

Default Value

Optionalsummary_type?: SummaryType

Default Value

Optionaltopics?: string[]

Optionalwebhook_auth_header_name?: string | null

Default Value

Optionalwebhook_auth_header_value?: string | null

Default Value

Optionalwebhook_url?: string

Optionalword_boost?: string[]

Example

Settings

`Optional`audio_end_at?: number

`Optional`audio_start_from?: number

`Optional`auto_chapters?: boolean

`Optional`auto_highlights?: boolean

`Optional`boost_param?: TranscriptBoostParam

`Optional`content_safety?: boolean

`Optional`content_safety_confidence?: number

`Optional`custom_spelling?: TranscriptCustomSpelling[]

`Optional`custom_topics?: boolean

`Optional`disfluencies?: boolean

`Optional`dual_channel?: boolean

`Optional`entity_detection?: boolean

`Optional`filter_profanity?: boolean

`Optional`format_text?: boolean

`Optional`iab_categories?: boolean

`Optional`language_code?: LiteralUnion<TranscriptLanguageCode, string> | null

`Optional`language_confidence_threshold?: number

`Optional`language_detection?: boolean

`Optional`multichannel?: boolean

`Optional`punctuate?: boolean

`Optional`redact_pii?: boolean

`Optional`redact_pii_audio?: boolean

`Optional`redact_pii_audio_quality?: RedactPiiAudioQuality

`Optional`redact_pii_policies?: PiiPolicy[]

`Optional`redact_pii_sub?: SubstitutionPolicy | null

`Optional`sentiment_analysis?: boolean

`Optional`speaker_labels?: boolean

`Optional`speakers_expected?: number | null

`Optional`speech_model?: SpeechModel | null

`Optional`speech_threshold?: number | null

`Optional`summarization?: boolean

`Optional`summary_model?: SummaryModel

`Optional`summary_type?: SummaryType

`Optional`topics?: string[]

`Optional`webhook_auth_header_name?: string | null

`Optional`webhook_auth_header_value?: string | null

`Optional`webhook_url?: string

`Optional`word_boost?: string[]