Table of Contents

Class Transcript

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

Properties

AcousticModel

The acoustic model that was used for the transcript

[JsonPropertyName("acoustic_model")]
public required string AcousticModel { get; set; }

Property Value

string

AudioChannels

The number of audio channels in the audio file. This is only present when multichannel is enabled.

[JsonPropertyName("audio_channels")]
public int? AudioChannels { get; set; }

Property Value

int?

AudioDuration

The duration of this transcript object's media file, in seconds

[JsonPropertyName("audio_duration")]
public int? AudioDuration { get; set; }

Property Value

int?

AudioEndAt

The point in time, in milliseconds, in the file at which the transcription was terminated

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

Property Value

int?

AudioStartFrom

The point in time, in milliseconds, in the file at which the transcription was started

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

Property Value

int?

AudioUrl

The URL of the media that was transcribed

[JsonPropertyName("audio_url")]
public required string AudioUrl { get; set; }

Property Value

string

AutoChapters

Whether Auto Chapters is enabled, can be true or false

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

Property Value

bool?

AutoHighlights

Whether Key Phrases is enabled, either true or false

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

Property Value

bool

AutoHighlightsResult 

[JsonPropertyName("auto_highlights_result")]
public AutoHighlightsResult? AutoHighlightsResult { get; set; }

Property Value

AutoHighlightsResult

BoostParam

The word boost parameter value

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

Property Value

string

Chapters

An array of temporally sequential chapters for the audio file

[JsonPropertyName("chapters")]
public IEnumerable<Chapter>? Chapters { get; set; }

Property Value

IEnumerable<Chapter>

Confidence

The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)

[JsonPropertyName("confidence")]
public double? Confidence { get; set; }

Property Value

double?

ContentSafety

Whether Content Moderation is enabled, can be true or false

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

Property Value

bool?

ContentSafetyLabels 

[JsonPropertyName("content_safety_labels")]
public ContentSafetyLabelsResult? ContentSafetyLabels { get; set; }

Property Value

ContentSafetyLabelsResult

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

Whether custom topics is enabled, 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

Whether Dual channel transcription was enabled in the transcription request, either true or false

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

Property Value

bool?

Entities

An array of results for the Entity Detection model, if it is enabled. See Entity detection for more information.

[JsonPropertyName("entities")]
public IEnumerable<Entity>? Entities { get; set; }

Property Value

IEnumerable<Entity>

EntityDetection

Whether Entity Detection is enabled, can be true or false

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

Property Value

bool?

Error

Error message of why the transcript failed

[JsonPropertyName("error")]
public string? Error { get; set; }

Property Value

string

FilterProfanity

Whether Profanity Filtering is enabled, either true or false

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

Property Value

bool?

FormatText

Whether Text Formatting is enabled, either true or false

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

Property Value

bool?

IabCategories

Whether Topic Detection is enabled, can be true or false

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

Property Value

bool?

IabCategoriesResult 

[JsonPropertyName("iab_categories_result")]
public TopicDetectionModelResult? IabCategoriesResult { get; set; }

Property Value

TopicDetectionModelResult

Id

The unique identifier of your transcript

[JsonPropertyName("id")]
public required string Id { get; set; }

Property Value

string

LanguageCode

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

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

Property Value

TranscriptLanguageCode?

LanguageConfidence

The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence)

[JsonPropertyName("language_confidence")]
public double? LanguageConfidence { get; set; }

Property Value

double?

LanguageConfidenceThreshold

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

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

Property Value

float?

LanguageDetection

Whether Automatic language detection is enabled, either true or false

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

Property Value

bool?

LanguageModel

The language model that was used for the transcript

[JsonPropertyName("language_model")]
public required string LanguageModel { get; set; }

Property Value

string

Multichannel

Whether Multichannel transcription was enabled in the transcription request, either true or false

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

Property Value

bool?

Punctuate

Whether Automatic Punctuation is enabled, either true or false

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

Property Value

bool?

RedactPii

Whether PII Redaction is enabled, either true or false

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

Property Value

bool

RedactPiiAudio

Whether a redacted version of the audio file was generated, either true or false. See PII redaction for more information.

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

Property Value

bool?

RedactPiiAudioQuality 

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

Property Value

RedactPiiAudioQuality?

RedactPiiPolicies

The list of PII Redaction policies that were enabled, if PII Redaction is enabled. See PII redaction for more information.

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

Property Value

IEnumerable<PiiPolicy>

RedactPiiSub

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

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

Property Value

SubstitutionPolicy?

SentimentAnalysis

Whether Sentiment Analysis is enabled, can be true or false

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

Property Value

bool?

SentimentAnalysisResults

An array of results for the Sentiment Analysis model, if it is enabled. See Sentiment Analysis for more information.

[JsonPropertyName("sentiment_analysis_results")]
public IEnumerable<SentimentAnalysisResult>? SentimentAnalysisResults { get; set; }

Property Value

IEnumerable<SentimentAnalysisResult>

SpeakerLabels

Whether Speaker diarization is enabled, can be true or false

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

Property Value

bool?

SpeakersExpected

Tell 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

Defaults to null. 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?

SpeedBoost

Whether speed boost is enabled

[JsonPropertyName("speed_boost")]
public bool? SpeedBoost { get; set; }

Property Value

bool?

Status

The status of your transcript. Possible values are queued, processing, completed, or error.

[JsonPropertyName("status")]
public required TranscriptStatus Status { get; set; }

Property Value

TranscriptStatus

Summarization

Whether Summarization is enabled, either true or false

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

Property Value

bool

Summary

The generated summary of the media file, if Summarization is enabled

[JsonPropertyName("summary")]
public string? Summary { get; set; }

Property Value

string

SummaryModel

The Summarization model used to generate the summary, if Summarization is enabled

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

Property Value

string

SummaryType

The type of summary generated, if Summarization is enabled

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

Property Value

string

Text

The textual transcript of your media file

[JsonPropertyName("text")]
public string? Text { get; set; }

Property Value

string

Throttled

True while a request is throttled and false when a request is no longer throttled

[JsonPropertyName("throttled")]
public bool? Throttled { get; set; }

Property Value

bool?

Topics

The list of custom topics provided if custom topics is enabled

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

Property Value

IEnumerable<string>

Utterances

When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects. See Speaker diarization and Multichannel transcription for more information.

[JsonPropertyName("utterances")]
public IEnumerable<TranscriptUtterance>? Utterances { get; set; }

Property Value

IEnumerable<TranscriptUtterance>

WebhookAuth

Whether webhook authentication details were provided

[JsonPropertyName("webhook_auth")]
public required bool WebhookAuth { get; set; }

Property Value

bool

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

WebhookStatusCode

The status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided

[JsonPropertyName("webhook_status_code")]
public int? WebhookStatusCode { get; set; }

Property Value

int?

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>

Words

An array of temporally-sequential word objects, one for each word in the transcript. See Speech recognition for more information.

[JsonPropertyName("words")]
public IEnumerable<TranscriptWord>? Words { get; set; }

Property Value

IEnumerable<TranscriptWord>

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.