java.lang.Object
- com.assemblyai.api.resources.transcripts.requests.TranscriptParams

All Implemented Interfaces:: ITranscriptOptionalParams

public final class TranscriptParams
extends java.lang.Object
implements ITranscriptOptionalParams

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`TranscriptParams._FinalStage`
`static interface`	`TranscriptParams.AudioUrlStage`
`static class`	`TranscriptParams.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TranscriptParams.AudioUrlStage`	`builder()`
`boolean`	`equals(java.lang.Object other)`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalProperties()`
`java.util.Optional<java.lang.Integer>`	`getAudioEndAt()`
`java.util.Optional<java.lang.Integer>`	`getAudioStartFrom()`
`java.lang.String`	`getAudioUrl()`
`java.util.Optional<java.lang.Boolean>`	`getAutoChapters()`
`java.util.Optional<java.lang.Boolean>`	`getAutoHighlights()`
`java.util.Optional<TranscriptBoostParam>`	`getBoostParam()`
`java.util.Optional<java.lang.Boolean>`	`getContentSafety()`
`java.util.Optional<java.lang.Integer>`	`getContentSafetyConfidence()`
`java.util.Optional<java.util.List<TranscriptCustomSpelling>>`	`getCustomSpelling()`
`java.util.Optional<java.lang.Boolean>`	`getCustomTopics()`
`java.util.Optional<java.lang.Boolean>`	`getDisfluencies()`
`java.util.Optional<java.lang.Boolean>`	`getDualChannel()`
`java.util.Optional<java.lang.Boolean>`	`getEntityDetection()`
`java.util.Optional<java.lang.Boolean>`	`getFilterProfanity()`
`java.util.Optional<java.lang.Boolean>`	`getFormatText()`
`java.util.Optional<java.lang.Boolean>`	`getIabCategories()`
`java.util.Optional<TranscriptLanguageCode>`	`getLanguageCode()`
`java.util.Optional<java.lang.Boolean>`	`getLanguageDetection()`
`java.util.Optional<java.lang.Boolean>`	`getPunctuate()`
`java.util.Optional<java.lang.Boolean>`	`getRedactPii()`
`java.util.Optional<java.lang.Boolean>`	`getRedactPiiAudio()`
`java.util.Optional<RedactPiiAudioQuality>`	`getRedactPiiAudioQuality()`
`java.util.Optional<java.util.List<PiiPolicy>>`	`getRedactPiiPolicies()`
`java.util.Optional<SubstitutionPolicy>`	`getRedactPiiSub()`
`java.util.Optional<java.lang.Boolean>`	`getSentimentAnalysis()`
`java.util.Optional<java.lang.Boolean>`	`getSpeakerLabels()`
`java.util.Optional<java.lang.Integer>`	`getSpeakersExpected()`
`java.util.Optional<SpeechModel>`	`getSpeechModel()`
`java.util.Optional<java.lang.Double>`	`getSpeechThreshold()`
`java.util.Optional<java.lang.Boolean>`	`getSummarization()`
`java.util.Optional<SummaryModel>`	`getSummaryModel()`
`java.util.Optional<SummaryType>`	`getSummaryType()`
`java.util.Optional<java.util.List<java.lang.String>>`	`getTopics()`
`java.util.Optional<java.lang.String>`	`getWebhookAuthHeaderName()`
`java.util.Optional<java.lang.String>`	`getWebhookAuthHeaderValue()`
`java.util.Optional<java.lang.String>`	`getWebhookUrl()`
`java.util.Optional<java.util.List<java.lang.String>>`	`getWordBoost()`
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getSpeechModel
```
public java.util.Optional<SpeechModel> getSpeechModel()
```
    Specified by:
    
    getSpeechModel in interface ITranscriptOptionalParams
  - getLanguageCode
```
public java.util.Optional<TranscriptLanguageCode> getLanguageCode()
```
    Specified by:
    
    getLanguageCode in interface ITranscriptOptionalParams
  - getPunctuate
```
public java.util.Optional<java.lang.Boolean> getPunctuate()
```
    Specified by:
    
    getPunctuate in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Automatic Punctuation, can be true or false
  - getFormatText
```
public java.util.Optional<java.lang.Boolean> getFormatText()
```
    Specified by:
    
    getFormatText in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Text Formatting, can be true or false
  - getDualChannel
```
public java.util.Optional<java.lang.Boolean> getDualChannel()
```
    Specified by:
    
    getDualChannel in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Dual Channel transcription, can be true or false.
  - getWebhookUrl
```
public java.util.Optional<java.lang.String> getWebhookUrl()
```
    Specified by:
    
    getWebhookUrl in interface ITranscriptOptionalParams
    
    Returns:
    
    The URL to which AssemblyAI send webhooks upon trancription completion
  - getWebhookAuthHeaderName
```
public java.util.Optional<java.lang.String> getWebhookAuthHeaderName()
```
    Specified by:
    
    getWebhookAuthHeaderName in interface ITranscriptOptionalParams
    
    Returns:
    
    The header name which should be sent back with webhook calls
  - getWebhookAuthHeaderValue
```
public java.util.Optional<java.lang.String> getWebhookAuthHeaderValue()
```
    Specified by:
    
    getWebhookAuthHeaderValue in interface ITranscriptOptionalParams
    
    Returns:
    
    Specify a header name and value to send back with a webhook call for added security
  - getAutoHighlights
```
public java.util.Optional<java.lang.Boolean> getAutoHighlights()
```
    Specified by:
    
    getAutoHighlights in interface ITranscriptOptionalParams
    
    Returns:
    
    Whether Key Phrases is enabled, either true or false
  - getAudioStartFrom
```
public java.util.Optional<java.lang.Integer> getAudioStartFrom()
```
    Specified by:
    
    getAudioStartFrom in interface ITranscriptOptionalParams
    
    Returns:
    
    The point in time, in milliseconds, to begin transcribing in your media file
  - getAudioEndAt
```
public java.util.Optional<java.lang.Integer> getAudioEndAt()
```
    Specified by:
    
    getAudioEndAt in interface ITranscriptOptionalParams
    
    Returns:
    
    The point in time, in milliseconds, to stop transcribing in your media file
  - getWordBoost
```
public java.util.Optional<java.util.List<java.lang.String>> getWordBoost()
```
    Specified by:
    
    getWordBoost in interface ITranscriptOptionalParams
    
    Returns:
    
    The list of custom vocabulary to boost transcription probability for
  - getBoostParam
```
public java.util.Optional<TranscriptBoostParam> getBoostParam()
```
    Specified by:
    
    getBoostParam in interface ITranscriptOptionalParams
    
    Returns:
    
    The word boost parameter value
  - getFilterProfanity
```
public java.util.Optional<java.lang.Boolean> getFilterProfanity()
```
    Specified by:
    
    getFilterProfanity in interface ITranscriptOptionalParams
    
    Returns:
    
    Filter profanity from the transcribed text, can be true or false
  - getRedactPii
```
public java.util.Optional<java.lang.Boolean> getRedactPii()
```
    Specified by:
    
    getRedactPii in interface ITranscriptOptionalParams
    
    Returns:
    
    Redact PII from the transcribed text using the Redact PII model, can be true or false
  - getRedactPiiAudio
```
public java.util.Optional<java.lang.Boolean> getRedactPiiAudio()
```
    Specified by:
    
    getRedactPiiAudio in interface ITranscriptOptionalParams
    
    Returns:
    
    Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See PII redaction for more details.
  - getRedactPiiAudioQuality
```
public java.util.Optional<RedactPiiAudioQuality> getRedactPiiAudioQuality()
```
    Specified by:
    
    getRedactPiiAudioQuality in interface ITranscriptOptionalParams
    
    Returns:
    
    Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See PII redaction for more details.
  - getRedactPiiPolicies
```
public java.util.Optional<java.util.List<PiiPolicy>> getRedactPiiPolicies()
```
    Specified by:
    
    getRedactPiiPolicies in interface ITranscriptOptionalParams
    
    Returns:
    
    The list of PII Redaction policies to enable. See PII redaction for more details.
  - getRedactPiiSub
```
public java.util.Optional<SubstitutionPolicy> getRedactPiiSub()
```
    Specified by:
    
    getRedactPiiSub in interface ITranscriptOptionalParams
  - getSpeakerLabels
```
public java.util.Optional<java.lang.Boolean> getSpeakerLabels()
```
    Specified by:
    
    getSpeakerLabels in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Speaker diarization, can be true or false
  - getSpeakersExpected
```
public java.util.Optional<java.lang.Integer> getSpeakersExpected()
```
    Specified by:
    
    getSpeakersExpected in interface ITranscriptOptionalParams
    
    Returns:
    
    Tells 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()
```
    Specified by:
    
    getContentSafety in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Content Moderation, can be true or false
  - getContentSafetyConfidence
```
public java.util.Optional<java.lang.Integer> getContentSafetyConfidence()
```
    Specified by:
    
    getContentSafetyConfidence in interface ITranscriptOptionalParams
    
    Returns:
    
    The confidence threshold for content moderation. Values must be between 25 and 100.
  - getIabCategories
```
public java.util.Optional<java.lang.Boolean> getIabCategories()
```
    Specified by:
    
    getIabCategories in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Topic Detection, can be true or false
  - getLanguageDetection
```
public java.util.Optional<java.lang.Boolean> getLanguageDetection()
```
    Specified by:
    
    getLanguageDetection in interface ITranscriptOptionalParams
    
    Returns:
    
    Whether Automatic language detection was enabled in the transcription request, either true or false.
  - getCustomSpelling
```
public java.util.Optional<java.util.List<TranscriptCustomSpelling>> getCustomSpelling()
```
    Specified by:
    
    getCustomSpelling in interface ITranscriptOptionalParams
    
    Returns:
    
    Customize how words are spelled and formatted using to and from values
  - getDisfluencies
```
public java.util.Optional<java.lang.Boolean> getDisfluencies()
```
    Specified by:
    
    getDisfluencies in interface ITranscriptOptionalParams
    
    Returns:
    
    Transcribe Filler Words, like "umm", in your media file; can be true or false
  - getSentimentAnalysis
```
public java.util.Optional<java.lang.Boolean> getSentimentAnalysis()
```
    Specified by:
    
    getSentimentAnalysis in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Sentiment Analysis, can be true or false
  - getAutoChapters
```
public java.util.Optional<java.lang.Boolean> getAutoChapters()
```
    Specified by:
    
    getAutoChapters in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Auto Chapters, can be true or false
  - getEntityDetection
```
public java.util.Optional<java.lang.Boolean> getEntityDetection()
```
    Specified by:
    
    getEntityDetection in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Entity Detection, can be true or false
  - getSpeechThreshold
```
public java.util.Optional<java.lang.Double> getSpeechThreshold()
```
    Specified by:
    
    getSpeechThreshold in interface ITranscriptOptionalParams
    
    Returns:
    
    Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive.
  - getSummarization
```
public java.util.Optional<java.lang.Boolean> getSummarization()
```
    Specified by:
    
    getSummarization in interface ITranscriptOptionalParams
    
    Returns:
    
    Enable Summarization, can be true or false
  - getSummaryModel
```
public java.util.Optional<SummaryModel> getSummaryModel()
```
    Specified by:
    
    getSummaryModel in interface ITranscriptOptionalParams
    
    Returns:
    
    The model to summarize the transcript
  - getSummaryType
```
public java.util.Optional<SummaryType> getSummaryType()
```
    Specified by:
    
    getSummaryType in interface ITranscriptOptionalParams
    
    Returns:
    
    The type of summary
  - getCustomTopics
```
public java.util.Optional<java.lang.Boolean> getCustomTopics()
```
    Specified by:
    
    getCustomTopics in interface ITranscriptOptionalParams
    
    Returns:
    
    Whether custom topics is enabled, either true or false
  - getTopics
```
public java.util.Optional<java.util.List<java.lang.String>> getTopics()
```
    Specified by:
    
    getTopics in interface ITranscriptOptionalParams
    
    Returns:
    
    The list of custom topics provided, if custom topics is enabled
  - getAudioUrl
```
public java.lang.String getAudioUrl()
```
    Returns:
    
    The URL of the audio or video file to transcribe.
  - 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
  - builder
```
public static TranscriptParams.AudioUrlStage builder()
```

Class TranscriptParams

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSpeechModel

getLanguageCode

getPunctuate

getFormatText

getDualChannel

getWebhookUrl

getWebhookAuthHeaderName

getWebhookAuthHeaderValue

getAutoHighlights

getAudioStartFrom

getAudioEndAt

getWordBoost

getBoostParam

getFilterProfanity

getRedactPii

getRedactPiiAudio

getRedactPiiAudioQuality

getRedactPiiPolicies

getRedactPiiSub

getSpeakerLabels

getSpeakersExpected

getContentSafety

getContentSafetyConfidence

getIabCategories

getLanguageDetection

getCustomSpelling

getDisfluencies

getSentimentAnalysis

getAutoChapters

getEntityDetection

getSpeechThreshold

getSummarization

getSummaryModel

getSummaryType

getCustomTopics

getTopics

getAudioUrl

equals

getAdditionalProperties

hashCode

toString

builder