Table of Contents

Class TranscriptOptionalParams

Namespace
AssemblyAI.Transcripts
Assembly
AssemblyAI.dll
public record TranscriptOptionalParams : IEquatable<TranscriptOptionalParams>
Inheritance
TranscriptOptionalParams
Implements
Inherited Members
Extension Methods

Properties

AudioEndAt

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

[JsonPropertyName("audio_end_at")]
public int? AudioEndAt { get; set; }

Property Value

int?

AudioStartFrom

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

[JsonPropertyName("audio_start_from")]
public int? AudioStartFrom { get; set; }

Property Value

int?

AutoChapters

Enable Auto Chapters, can be true or false

[JsonPropertyName("auto_chapters")]
public bool? AutoChapters { get; set; }

Property Value

bool?

AutoHighlights

Enable Key Phrases, either true or false

[JsonPropertyName("auto_highlights")]
public bool? AutoHighlights { get; set; }

Property Value

bool?

BoostParam

How much to boost specified words

[JsonPropertyName("boost_param")]
public TranscriptBoostParam? BoostParam { get; set; }

Property Value

TranscriptBoostParam?

ContentSafety

Enable Content Moderation, can be true or false

[JsonPropertyName("content_safety")]
public bool? ContentSafety { get; set; }

Property Value

bool?

ContentSafetyConfidence

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

[JsonPropertyName("content_safety_confidence")]
public int? ContentSafetyConfidence { get; set; }

Property Value

int?

CustomSpelling

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

[JsonPropertyName("custom_spelling")]
public IEnumerable<TranscriptCustomSpelling>? CustomSpelling { get; set; }

Property Value

IEnumerable<TranscriptCustomSpelling>

CustomTopics

Enable custom topics, either true or false

[JsonPropertyName("custom_topics")]
public bool? CustomTopics { get; set; }

Property Value

bool?

Disfluencies

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

[JsonPropertyName("disfluencies")]
public bool? Disfluencies { get; set; }

Property Value

bool?

DualChannel

Enable Dual Channel transcription, can be true or false.

[JsonPropertyName("dual_channel")]
public bool? DualChannel { get; set; }

Property Value

bool?

EntityDetection

Enable Entity Detection, can be true or false

[JsonPropertyName("entity_detection")]
public bool? EntityDetection { get; set; }

Property Value

bool?

FilterProfanity

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

[JsonPropertyName("filter_profanity")]
public bool? FilterProfanity { get; set; }

Property Value

bool?

FormatText

Enable Text Formatting, can be true or false

[JsonPropertyName("format_text")]
public bool? FormatText { get; set; }

Property Value

bool?

IabCategories

Enable Topic Detection, can be true or false

[JsonPropertyName("iab_categories")]
public bool? IabCategories { get; set; }

Property Value

bool?

LanguageCode 

[JsonPropertyName("language_code")]
public TranscriptLanguageCode? LanguageCode { get; set; }

Property Value

TranscriptLanguageCode?

LanguageConfidenceThreshold

The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold. Defaults to 0.

[JsonPropertyName("language_confidence_threshold")]
public float? LanguageConfidenceThreshold { get; set; }

Property Value

float?

LanguageDetection

Enable Automatic language detection, either true or false.

[JsonPropertyName("language_detection")]
public bool? LanguageDetection { get; set; }

Property Value

bool?

Multichannel

Enable Multichannel transcription, can be true or false.

[JsonPropertyName("multichannel")]
public bool? Multichannel { get; set; }

Property Value

bool?

Punctuate

Enable Automatic Punctuation, can be true or false

[JsonPropertyName("punctuate")]
public bool? Punctuate { get; set; }

Property Value

bool?

RedactPii

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

[JsonPropertyName("redact_pii")]
public bool? RedactPii { get; set; }

Property Value

bool?

RedactPiiAudio

Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See PII redaction for more details.

[JsonPropertyName("redact_pii_audio")]
public bool? RedactPiiAudio { get; set; }

Property Value

bool?

RedactPiiAudioQuality

Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See PII redaction for more details.

[JsonPropertyName("redact_pii_audio_quality")]
public RedactPiiAudioQuality? RedactPiiAudioQuality { get; set; }

Property Value

RedactPiiAudioQuality?

RedactPiiPolicies

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

[JsonPropertyName("redact_pii_policies")]
public IEnumerable<PiiPolicy>? RedactPiiPolicies { get; set; }

Property Value

IEnumerable<PiiPolicy>

RedactPiiSub 

[JsonPropertyName("redact_pii_sub")]
public SubstitutionPolicy? RedactPiiSub { get; set; }

Property Value

SubstitutionPolicy?

SentimentAnalysis

Enable Sentiment Analysis, can be true or false

[JsonPropertyName("sentiment_analysis")]
public bool? SentimentAnalysis { get; set; }

Property Value

bool?

SpeakerLabels

Enable Speaker diarization, can be true or false

[JsonPropertyName("speaker_labels")]
public bool? SpeakerLabels { get; set; }

Property Value

bool?

SpeakersExpected

Tells the speaker label model how many speakers it should attempt to identify, up to 10. See Speaker diarization for more details.

[JsonPropertyName("speakers_expected")]
public int? SpeakersExpected { get; set; }

Property Value

int?

SpeechModel 

[JsonPropertyName("speech_model")]
public SpeechModel? SpeechModel { get; set; }

Property Value

SpeechModel?

SpeechThreshold

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

[JsonPropertyName("speech_threshold")]
public float? SpeechThreshold { get; set; }

Property Value

float?

Summarization

Enable Summarization, can be true or false

[JsonPropertyName("summarization")]
public bool? Summarization { get; set; }

Property Value

bool?

SummaryModel

The model to summarize the transcript

[JsonPropertyName("summary_model")]
public SummaryModel? SummaryModel { get; set; }

Property Value

SummaryModel?

SummaryType

The type of summary

[JsonPropertyName("summary_type")]
public SummaryType? SummaryType { get; set; }

Property Value

SummaryType?

Topics

The list of custom topics

[JsonPropertyName("topics")]
public IEnumerable<string>? Topics { get; set; }

Property Value

IEnumerable<string>

WebhookAuthHeaderName

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

[JsonPropertyName("webhook_auth_header_name")]
public string? WebhookAuthHeaderName { get; set; }

Property Value

string

WebhookAuthHeaderValue

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

[JsonPropertyName("webhook_auth_header_value")]
public string? WebhookAuthHeaderValue { get; set; }

Property Value

string

WebhookUrl

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.

[JsonPropertyName("webhook_url")]
public string? WebhookUrl { get; set; }

Property Value

string

WordBoost

The list of custom vocabulary to boost transcription probability for

[JsonPropertyName("word_boost")]
public IEnumerable<string>? WordBoost { get; set; }

Property Value

IEnumerable<string>

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.