Package com.assemblyai.api.resources.transcripts.types

Class Transcript

  • public final class Transcript
extends java.lang.Object

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns:
        The unique identifier of your transcript

      • getSpeechModel

        public java.util.Optional<SpeechModel> getSpeechModel()

      • getLanguageModel

        public java.lang.String getLanguageModel()
        Returns:
        The language model that was used for the transcript

      • getAcousticModel

        public java.lang.String getAcousticModel()
        Returns:
        The acoustic model that was used for the transcript

      • getStatus

        public TranscriptStatus getStatus()
        Returns:
        The status of your transcript. Possible values are queued, processing, completed, or error.

      • getLanguageCode

        public java.util.Optional<TranscriptLanguageCode> getLanguageCode()
        Returns:
        The language of your audio file. Possible values are found in Supported Languages. The default value is 'en_us'.

      • getAudioUrl

        public java.lang.String getAudioUrl()
        Returns:
        The URL of the media that was transcribed

      • getText

        public java.util.Optional<java.lang.String> getText()
        Returns:
        The textual transcript of your media file

      • getWords

        public java.util.Optional<java.util.List<TranscriptWord>> getWords()
        Returns:
        An array of temporally-sequential word objects, one for each word in the transcript. See Speech recognition for more information.

      • getUtterances

        public java.util.Optional<java.util.List<TranscriptUtterance>> getUtterances()
        Returns:
        When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterance objects. See Speaker diarization for more information.

      • getConfidence

        public java.util.Optional<java.lang.Double> getConfidence()
        Returns:
        The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)

      • getAudioDuration

        public java.util.Optional<java.lang.Double> getAudioDuration()
        Returns:
        The duration of this transcript object's media file, in seconds

      • getPunctuate

        public java.util.Optional<java.lang.Boolean> getPunctuate()
        Returns:
        Whether Automatic Punctuation is enabled, either true or false

      • getFormatText

        public java.util.Optional<java.lang.Boolean> getFormatText()
        Returns:
        Whether Text Formatting is enabled, either true or false

      • getDualChannel

        public java.util.Optional<java.lang.Boolean> getDualChannel()
        Returns:
        Whether Dual channel transcription was enabled in the transcription request, either true or false

      • getWebhookUrl

        public java.util.Optional<java.lang.String> getWebhookUrl()
        Returns:
        The URL to which we send webhooks upon trancription completion

      • getWebhookStatusCode

        public java.util.Optional<java.lang.Integer> getWebhookStatusCode()
        Returns:
        The status code we received from your server when delivering your webhook, if a webhook URL was provided

      • getWebhookAuth

        public boolean getWebhookAuth()
        Returns:
        Whether webhook authentication details were provided

      • getWebhookAuthHeaderName

        public java.util.Optional<java.lang.String> getWebhookAuthHeaderName()
        Returns:
        The header name which should be sent back with webhook calls

      • getSpeedBoost

        public java.util.Optional<java.lang.Boolean> getSpeedBoost()
        Returns:
        Whether speed boost is enabled

      • getAutoHighlights

        public boolean getAutoHighlights()
        Returns:
        Whether Key Phrases is enabled, either true or false

      • getAutoHighlightsResult

        public java.util.Optional<AutoHighlightsResult> getAutoHighlightsResult()

      • getAudioStartFrom

        public java.util.Optional<java.lang.Integer> getAudioStartFrom()
        Returns:
        The point in time, in milliseconds, in the file at which the transcription was started

      • getAudioEndAt

        public java.util.Optional<java.lang.Integer> getAudioEndAt()
        Returns:
        The point in time, in milliseconds, in the file at which the transcription was terminated

      • getWordBoost

        public java.util.Optional<java.util.List<java.lang.String>> getWordBoost()
        Returns:
        The list of custom vocabulary to boost transcription probability for

      • getBoostParam

        public java.util.Optional<java.lang.String> getBoostParam()
        Returns:
        The word boost parameter value

      • getFilterProfanity

        public java.util.Optional<java.lang.Boolean> getFilterProfanity()
        Returns:
        Whether Profanity Filtering is enabled, either true or false

      • getRedactPii

        public boolean getRedactPii()
        Returns:
        Whether PII Redaction is enabled, either true or false

      • getRedactPiiAudio

        public java.util.Optional<java.lang.Boolean> getRedactPiiAudio()
        Returns:
        Whether a redacted version of the audio file was generated, either true or false. See PII redaction for more information.

      • getRedactPiiPolicies

        public java.util.Optional<java.util.List<PiiPolicy>> getRedactPiiPolicies()
        Returns:
        The list of PII Redaction policies that were enabled, if PII Redaction is enabled. See PII redaction for more information.

      • getRedactPiiSub

        public java.util.Optional<SubstitutionPolicy> getRedactPiiSub()
        Returns:
        The replacement logic for detected PII, can be "entity_type" or "hash". See PII redaction for more details.

      • getSpeakerLabels

        public java.util.Optional<java.lang.Boolean> getSpeakerLabels()
        Returns:
        Whether Speaker diarization is enabled, can be true or false

      • getSpeakersExpected

        public java.util.Optional<java.lang.Integer> getSpeakersExpected()
        Returns:
        Tell the speaker label model how many speakers it should attempt to identify, up to 10. See Speaker diarization for more details.

      • getContentSafety

        public java.util.Optional<java.lang.Boolean> getContentSafety()
        Returns:
        Whether Content Moderation is enabled, can be true or false

      • getIabCategories

        public java.util.Optional<java.lang.Boolean> getIabCategories()
        Returns:
        Whether Topic Detection is enabled, can be true or false

      • getLanguageDetection

        public java.util.Optional<java.lang.Boolean> getLanguageDetection()
        Returns:
        Whether Automatic language detection is enabled, either true or false

      • getCustomSpelling

        public java.util.Optional<java.util.List<TranscriptCustomSpelling>> getCustomSpelling()
        Returns:
        Customize how words are spelled and formatted using to and from values

      • getAutoChapters

        public java.util.Optional<java.lang.Boolean> getAutoChapters()
        Returns:
        Whether Auto Chapters is enabled, can be true or false

      • getChapters

        public java.util.Optional<java.util.List<Chapter>> getChapters()
        Returns:
        An array of temporally sequential chapters for the audio file

      • getSummarization

        public boolean getSummarization()
        Returns:
        Whether Summarization is enabled, either true or false

      • getSummaryType

        public java.util.Optional<java.lang.String> getSummaryType()
        Returns:
        The type of summary generated, if Summarization is enabled

      • getSummaryModel

        public java.util.Optional<java.lang.String> getSummaryModel()
        Returns:
        The Summarization model used to generate the summary, if Summarization is enabled

      • getSummary

        public java.util.Optional<java.lang.String> getSummary()
        Returns:
        The generated summary of the media file, if Summarization is enabled

      • getCustomTopics

        public java.util.Optional<java.lang.Boolean> getCustomTopics()
        Returns:
        Whether custom topics is enabled, either true or false

      • getTopics

        public java.util.Optional<java.util.List<java.lang.String>> getTopics()
        Returns:
        The list of custom topics provided if custom topics is enabled

      • getDisfluencies

        public java.util.Optional<java.lang.Boolean> getDisfluencies()
        Returns:
        Transcribe Filler Words, like "umm", in your media file; can be true or false

      • getSentimentAnalysis

        public java.util.Optional<java.lang.Boolean> getSentimentAnalysis()
        Returns:
        Whether Sentiment Analysis is enabled, can be true or false

      • getSentimentAnalysisResults

        public java.util.Optional<java.util.List<SentimentAnalysisResult>> getSentimentAnalysisResults()
        Returns:
        An array of results for the Sentiment Analysis model, if it is enabled. See Sentiment analysis for more information.

      • getEntityDetection

        public java.util.Optional<java.lang.Boolean> getEntityDetection()
        Returns:
        Whether Entity Detection is enabled, can be true or false

      • getEntities

        public java.util.Optional<java.util.List<Entity>> getEntities()
        Returns:
        An array of results for the Entity Detection model, if it is enabled. See Entity detection for more information.

      • getSpeechThreshold

        public java.util.Optional<java.lang.Double> getSpeechThreshold()
        Returns:
        Defaults to null. Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive.

      • getThrottled

        public java.util.Optional<java.lang.Boolean> getThrottled()
        Returns:
        True while a request is throttled and false when a request is no longer throttled

      • getError

        public java.util.Optional<java.lang.String> getError()
        Returns:
        Error message of why the transcript failed

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object