Type Alias TranscriptParams

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

The parameters for creating a transcript

Type declaration

  • audio_url: string

    The URL of the audio or video file to transcribe.

  • Optionalaudio_end_at?: undefined | number

    The point in time, in milliseconds, to stop transcribing in your media file

  • Optionalaudio_start_from?: undefined | number

    The point in time, in milliseconds, to begin transcribing in your media file

  • Optionalauto_chapters?: undefined | boolean

    Enable Auto Chapters, can be true or false

  • Optionalauto_highlights?: undefined | boolean

    Enable Key Phrases, either true or false

  • Optionalboost_param?: undefined | TranscriptBoostParam

    The word boost parameter value

  • Optionalcontent_safety?: undefined | boolean

    Enable Content Moderation, can be true or false

  • Optionalcontent_safety_confidence?: undefined | number

    The confidence threshold for the Content Moderation model. Values must be between 25 and 100.

  • Optionalcustom_spelling?: undefined | TranscriptCustomSpelling[]

    Customize how words are spelled and formatted using to and from values

  • Optionalcustom_topics?: undefined | boolean

    Enable custom topics, either true or false

  • Optionaldisfluencies?: undefined | boolean

    Transcribe Filler Words, like "umm", in your media file; can be true or false

  • Optionaldual_channel?: undefined | boolean

    Enable Dual Channel transcription, can be true or false.

  • Optionalentity_detection?: undefined | boolean

    Enable Detection, can be true or false

  • Optionalfilter_profanity?: undefined | boolean

    Filter profanity from the transcribed text, can be true or false

  • Optionalformat_text?: undefined | boolean

    Enable Text Formatting, can be true or false

  • Optionaliab_categories?: undefined | boolean

    Enable Topic Detection, can be true or false

  • Optionallanguage_code?: undefined | null | LiteralUnion<TranscriptLanguageCode, string>

    The language of your audio file. Possible values are found in Supported Languages. The default value is 'en_us'.

  • Optionallanguage_detection?: undefined | boolean

    Enable Automatic language detection, either true or false.

  • Optionalpunctuate?: undefined | boolean

    Enable Automatic Punctuation, can be true or false

  • Optionalredact_pii?: undefined | boolean

    Redact PII from the transcribed text using the Redact PII model, can be true or false

  • Optionalredact_pii_audio?: undefined | 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.

  • Optionalredact_pii_audio_quality?: undefined | 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?: undefined | PiiPolicy[]

    The list of PII Redaction policies to enable. See PII redaction for more details.

  • Optionalredact_pii_sub?: undefined | null | SubstitutionPolicy

    The replacement logic for detected PII, can be "entity_type" or "hash". See PII redaction for more details.

  • Optionalsentiment_analysis?: undefined | boolean

    Enable Analysis, can be true or false

  • Optionalspeaker_labels?: undefined | boolean

    Enable Speaker diarization, can be true or false

  • Optionalspeakers_expected?: undefined | null | number

    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?: undefined | null | SpeechModel

    The speech model to use for the transcription. When null, the default model is used.

    Default Value

    null
  • Optionalspeech_threshold?: undefined | null | number

    Reject audio files that contain less than this fraction of speech. Valid values are in the range [0", 1] inclusive.

    Default Value

    "null
  • Optionalsummarization?: undefined | boolean

    Enable Summarization, can be true or false

  • Optionalsummary_model?: undefined | SummaryModel

    The model to summarize the transcript

    Default Value

    informative
  • Optionalsummary_type?: undefined | SummaryType

    The type of summary

    Default Value

    bullets
  • Optionaltopics?: undefined | string[]

    The list of custom topics

  • Optionalwebhook_auth_header_name?: undefined | null | string

    The header name to be sent with the transcript completed or failed webhook requests

    Default Value

    null
  • Optionalwebhook_auth_header_value?: undefined | null | string

    The header value to send back with the transcript completed or failed webhook requests for added security

    Default Value

    null
  • Optionalwebhook_url?: undefined | 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?: undefined | string[]

    The list of custom vocabulary to boost transcription probability for

Example

{
  "speech_model": null,
  "language_code": "en_us",
  "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
  "punctuate": true,
  "format_text": true,
  "dual_channel": true,
  "webhook_url": "https://your-webhook-url/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,
  "language_detection": false,
  "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": []
}

Settings

Member Visibility