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

Class Transcript.Builder

java.lang.Object

com.assemblyai.api.resources.transcripts.types.Transcript.Builder

All Implemented Interfaces:

Transcript._FinalStage, Transcript.AcousticModelStage, Transcript.AudioUrlStage, Transcript.AutoHighlightsStage, Transcript.IdStage, Transcript.LanguageModelStage, Transcript.RedactPiiStage, Transcript.StatusStage, Transcript.SummarizationStage, Transcript.WebhookAuthStage

Enclosing class:

Transcript

public static final class Transcript.Builder
extends java.lang.Object
implements Transcript.IdStage, Transcript.LanguageModelStage, Transcript.AcousticModelStage, Transcript.StatusStage, Transcript.AudioUrlStage, Transcript.WebhookAuthStage, Transcript.AutoHighlightsStage, Transcript.RedactPiiStage, Transcript.SummarizationStage, Transcript._FinalStage

Method Summary

Modifier and Type	Method	Description
Transcript.StatusStage	acousticModel(java.lang.String acousticModel)	The acoustic model that was used for the transcript
Transcript._FinalStage	audioDuration(java.lang.Double audioDuration)	The duration of this transcript object's media file, in seconds
Transcript._FinalStage	audioDuration(java.util.Optional<java.lang.Double> audioDuration)
Transcript._FinalStage	audioEndAt(java.lang.Integer audioEndAt)	The point in time, in milliseconds, in the file at which the transcription was terminated
Transcript._FinalStage	audioEndAt(java.util.Optional<java.lang.Integer> audioEndAt)
Transcript._FinalStage	audioStartFrom(java.lang.Integer audioStartFrom)	The point in time, in milliseconds, in the file at which the transcription was started
Transcript._FinalStage	audioStartFrom(java.util.Optional<java.lang.Integer> audioStartFrom)
Transcript.WebhookAuthStage	audioUrl(java.lang.String audioUrl)	The URL of the media that was transcribed
Transcript._FinalStage	autoChapters(java.lang.Boolean autoChapters)	Whether Auto Chapters is enabled, can be true or false
Transcript._FinalStage	autoChapters(java.util.Optional<java.lang.Boolean> autoChapters)
Transcript.RedactPiiStage	autoHighlights(boolean autoHighlights)	Whether Key Phrases is enabled, either true or false
Transcript._FinalStage	autoHighlightsResult(AutoHighlightsResult autoHighlightsResult)
Transcript._FinalStage	autoHighlightsResult(java.util.Optional<AutoHighlightsResult> autoHighlightsResult)
Transcript._FinalStage	boostParam(java.lang.String boostParam)	The word boost parameter value
Transcript._FinalStage	boostParam(java.util.Optional<java.lang.String> boostParam)
Transcript	build()
Transcript._FinalStage	chapters(java.util.List<Chapter> chapters)	An array of temporally sequential chapters for the audio file
Transcript._FinalStage	chapters(java.util.Optional<java.util.List<Chapter>> chapters)
Transcript._FinalStage	confidence(java.lang.Double confidence)	The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)
Transcript._FinalStage	confidence(java.util.Optional<java.lang.Double> confidence)
Transcript._FinalStage	contentSafety(java.lang.Boolean contentSafety)	Whether Content Moderation is enabled, can be true or false
Transcript._FinalStage	contentSafety(java.util.Optional<java.lang.Boolean> contentSafety)
Transcript._FinalStage	contentSafetyLabels(ContentSafetyLabelsResult contentSafetyLabels)
Transcript._FinalStage	contentSafetyLabels(java.util.Optional<ContentSafetyLabelsResult> contentSafetyLabels)
Transcript._FinalStage	customSpelling(java.util.List<TranscriptCustomSpelling> customSpelling)	Customize how words are spelled and formatted using to and from values
Transcript._FinalStage	customSpelling(java.util.Optional<java.util.List<TranscriptCustomSpelling>> customSpelling)
Transcript._FinalStage	customTopics(java.lang.Boolean customTopics)	Whether custom topics is enabled, either true or false
Transcript._FinalStage	customTopics(java.util.Optional<java.lang.Boolean> customTopics)
Transcript._FinalStage	disfluencies(java.lang.Boolean disfluencies)	Transcribe Filler Words, like "umm", in your media file; can be true or false
Transcript._FinalStage	disfluencies(java.util.Optional<java.lang.Boolean> disfluencies)
Transcript._FinalStage	dualChannel(java.lang.Boolean dualChannel)	Whether Dual channel transcription was enabled in the transcription request, either true or false
Transcript._FinalStage	dualChannel(java.util.Optional<java.lang.Boolean> dualChannel)
Transcript._FinalStage	entities(java.util.List<Entity> entities)	An array of results for the Entity Detection model, if it is enabled.
Transcript._FinalStage	entities(java.util.Optional<java.util.List<Entity>> entities)
Transcript._FinalStage	entityDetection(java.lang.Boolean entityDetection)	Whether Entity Detection is enabled, can be true or false
Transcript._FinalStage	entityDetection(java.util.Optional<java.lang.Boolean> entityDetection)
Transcript._FinalStage	error(java.lang.String error)	Error message of why the transcript failed
Transcript._FinalStage	error(java.util.Optional<java.lang.String> error)
Transcript._FinalStage	filterProfanity(java.lang.Boolean filterProfanity)	Whether Profanity Filtering is enabled, either true or false
Transcript._FinalStage	filterProfanity(java.util.Optional<java.lang.Boolean> filterProfanity)
Transcript._FinalStage	formatText(java.lang.Boolean formatText)	Whether Text Formatting is enabled, either true or false
Transcript._FinalStage	formatText(java.util.Optional<java.lang.Boolean> formatText)
Transcript.Builder	from(Transcript other)
Transcript._FinalStage	iabCategories(java.lang.Boolean iabCategories)	Whether Topic Detection is enabled, can be true or false
Transcript._FinalStage	iabCategories(java.util.Optional<java.lang.Boolean> iabCategories)
Transcript._FinalStage	iabCategoriesResult(TopicDetectionModelResult iabCategoriesResult)
Transcript._FinalStage	iabCategoriesResult(java.util.Optional<TopicDetectionModelResult> iabCategoriesResult)
Transcript.LanguageModelStage	id(java.lang.String id)	The unique identifier of your transcript
Transcript._FinalStage	languageCode(TranscriptLanguageCode languageCode)	The language of your audio file.
Transcript._FinalStage	languageCode(java.util.Optional<TranscriptLanguageCode> languageCode)
Transcript._FinalStage	languageDetection(java.lang.Boolean languageDetection)	Whether Automatic language detection is enabled, either true or false
Transcript._FinalStage	languageDetection(java.util.Optional<java.lang.Boolean> languageDetection)
Transcript.AcousticModelStage	languageModel(java.lang.String languageModel)	The language model that was used for the transcript
Transcript._FinalStage	punctuate(java.lang.Boolean punctuate)	Whether Automatic Punctuation is enabled, either true or false
Transcript._FinalStage	punctuate(java.util.Optional<java.lang.Boolean> punctuate)
Transcript.SummarizationStage	redactPii(boolean redactPii)	Whether PII Redaction is enabled, either true or false
Transcript._FinalStage	redactPiiAudio(java.lang.Boolean redactPiiAudio)	Whether a redacted version of the audio file was generated, either true or false.
Transcript._FinalStage	redactPiiAudio(java.util.Optional<java.lang.Boolean> redactPiiAudio)
Transcript._FinalStage	redactPiiAudioQuality(RedactPiiAudioQuality redactPiiAudioQuality)
Transcript._FinalStage	redactPiiAudioQuality(java.util.Optional<RedactPiiAudioQuality> redactPiiAudioQuality)
Transcript._FinalStage	redactPiiPolicies(java.util.List<PiiPolicy> redactPiiPolicies)	The list of PII Redaction policies that were enabled, if PII Redaction is enabled.
Transcript._FinalStage	redactPiiPolicies(java.util.Optional<java.util.List<PiiPolicy>> redactPiiPolicies)
Transcript._FinalStage	redactPiiSub(SubstitutionPolicy redactPiiSub)	The replacement logic for detected PII, can be "entity_type" or "hash".
Transcript._FinalStage	redactPiiSub(java.util.Optional<SubstitutionPolicy> redactPiiSub)
Transcript._FinalStage	sentimentAnalysis(java.lang.Boolean sentimentAnalysis)	Whether Sentiment Analysis is enabled, can be true or false
Transcript._FinalStage	sentimentAnalysis(java.util.Optional<java.lang.Boolean> sentimentAnalysis)
Transcript._FinalStage	sentimentAnalysisResults(java.util.List<SentimentAnalysisResult> sentimentAnalysisResults)	An array of results for the Sentiment Analysis model, if it is enabled.
Transcript._FinalStage	sentimentAnalysisResults(java.util.Optional<java.util.List<SentimentAnalysisResult>> sentimentAnalysisResults)
Transcript._FinalStage	speakerLabels(java.lang.Boolean speakerLabels)	Whether Speaker diarization is enabled, can be true or false
Transcript._FinalStage	speakerLabels(java.util.Optional<java.lang.Boolean> speakerLabels)
Transcript._FinalStage	speakersExpected(java.lang.Integer speakersExpected)	Tell the speaker label model how many speakers it should attempt to identify, up to 10.
Transcript._FinalStage	speakersExpected(java.util.Optional<java.lang.Integer> speakersExpected)
Transcript._FinalStage	speechModel(SpeechModel speechModel)
Transcript._FinalStage	speechModel(java.util.Optional<SpeechModel> speechModel)
Transcript._FinalStage	speechThreshold(java.lang.Double speechThreshold)	Defaults to null.
Transcript._FinalStage	speechThreshold(java.util.Optional<java.lang.Double> speechThreshold)
Transcript._FinalStage	speedBoost(java.lang.Boolean speedBoost)	Whether speed boost is enabled
Transcript._FinalStage	speedBoost(java.util.Optional<java.lang.Boolean> speedBoost)
Transcript.AudioUrlStage	status(TranscriptStatus status)	The status of your transcript.
Transcript._FinalStage	summarization(boolean summarization)	Whether Summarization is enabled, either true or false
Transcript._FinalStage	summary(java.lang.String summary)	The generated summary of the media file, if Summarization is enabled
Transcript._FinalStage	summary(java.util.Optional<java.lang.String> summary)
Transcript._FinalStage	summaryModel(java.lang.String summaryModel)	The Summarization model used to generate the summary, if Summarization is enabled
Transcript._FinalStage	summaryModel(java.util.Optional<java.lang.String> summaryModel)
Transcript._FinalStage	summaryType(java.lang.String summaryType)	The type of summary generated, if Summarization is enabled
Transcript._FinalStage	summaryType(java.util.Optional<java.lang.String> summaryType)
Transcript._FinalStage	text(java.lang.String text)	The textual transcript of your media file
Transcript._FinalStage	text(java.util.Optional<java.lang.String> text)
Transcript._FinalStage	throttled(java.lang.Boolean throttled)	True while a request is throttled and false when a request is no longer throttled
Transcript._FinalStage	throttled(java.util.Optional<java.lang.Boolean> throttled)
Transcript._FinalStage	topics(java.util.List<java.lang.String> topics)	The list of custom topics provided if custom topics is enabled
Transcript._FinalStage	topics(java.util.Optional<java.util.List<java.lang.String>> topics)
Transcript._FinalStage	utterances(java.util.List<TranscriptUtterance> utterances)	When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterance objects.
Transcript._FinalStage	utterances(java.util.Optional<java.util.List<TranscriptUtterance>> utterances)
Transcript.AutoHighlightsStage	webhookAuth(boolean webhookAuth)	Whether webhook authentication details were provided
Transcript._FinalStage	webhookAuthHeaderName(java.lang.String webhookAuthHeaderName)	The header name which should be sent back with webhook calls
Transcript._FinalStage	webhookAuthHeaderName(java.util.Optional<java.lang.String> webhookAuthHeaderName)
Transcript._FinalStage	webhookStatusCode(java.lang.Integer webhookStatusCode)	The status code we received from your server when delivering your webhook, if a webhook URL was provided
Transcript._FinalStage	webhookStatusCode(java.util.Optional<java.lang.Integer> webhookStatusCode)
Transcript._FinalStage	webhookUrl(java.lang.String webhookUrl)	The URL to which we send webhooks upon trancription completion
Transcript._FinalStage	webhookUrl(java.util.Optional<java.lang.String> webhookUrl)
Transcript._FinalStage	wordBoost(java.util.List<java.lang.String> wordBoost)	The list of custom vocabulary to boost transcription probability for
Transcript._FinalStage	wordBoost(java.util.Optional<java.util.List<java.lang.String>> wordBoost)
Transcript._FinalStage	words(java.util.List<TranscriptWord> words)	An array of temporally-sequential word objects, one for each word in the transcript.
Transcript._FinalStage	words(java.util.Optional<java.util.List<TranscriptWord>> words)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public Transcript.Builder from(Transcript other)

Specified by:

from in interface Transcript.IdStage

id

public Transcript.LanguageModelStage id(java.lang.String id)

The unique identifier of your transcript

Specified by:

id in interface Transcript.IdStage

Returns:

Reference to this so that method calls can be chained together.

languageModel

public Transcript.AcousticModelStage languageModel(java.lang.String languageModel)

The language model that was used for the transcript

Specified by:

languageModel in interface Transcript.LanguageModelStage

Returns:

Reference to this so that method calls can be chained together.

acousticModel

public Transcript.StatusStage acousticModel(java.lang.String acousticModel)

The acoustic model that was used for the transcript

Specified by:

acousticModel in interface Transcript.AcousticModelStage

Returns:

Reference to this so that method calls can be chained together.

status

public Transcript.AudioUrlStage status(TranscriptStatus status)

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

Specified by:

status in interface Transcript.StatusStage

Returns:

Reference to this so that method calls can be chained together.

audioUrl

public Transcript.WebhookAuthStage audioUrl(java.lang.String audioUrl)

The URL of the media that was transcribed

Specified by:

audioUrl in interface Transcript.AudioUrlStage

Returns:

Reference to this so that method calls can be chained together.

webhookAuth

public Transcript.AutoHighlightsStage webhookAuth(boolean webhookAuth)

Whether webhook authentication details were provided

Specified by:

webhookAuth in interface Transcript.WebhookAuthStage

Returns:

Reference to this so that method calls can be chained together.

autoHighlights

public Transcript.RedactPiiStage autoHighlights(boolean autoHighlights)

Whether Key Phrases is enabled, either true or false

Specified by:

autoHighlights in interface Transcript.AutoHighlightsStage

Returns:

Reference to this so that method calls can be chained together.

redactPii

public Transcript.SummarizationStage redactPii(boolean redactPii)

Whether PII Redaction is enabled, either true or false

Specified by:

redactPii in interface Transcript.RedactPiiStage

Returns:

Reference to this so that method calls can be chained together.

summarization

public Transcript._FinalStage summarization(boolean summarization)

Whether Summarization is enabled, either true or false

Specified by:

summarization in interface Transcript.SummarizationStage

Returns:

Reference to this so that method calls can be chained together.

error

public Transcript._FinalStage error(java.lang.String error)

Error message of why the transcript failed

Specified by:

error in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

error

public Transcript._FinalStage error(java.util.Optional<java.lang.String> error)

Specified by:

error in interface Transcript._FinalStage

throttled

public Transcript._FinalStage throttled(java.lang.Boolean throttled)

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

Specified by:

throttled in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

throttled

public Transcript._FinalStage throttled(java.util.Optional<java.lang.Boolean> throttled)

Specified by:

throttled in interface Transcript._FinalStage

speechThreshold

public Transcript._FinalStage speechThreshold(java.lang.Double speechThreshold)

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

Specified by:

speechThreshold in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

speechThreshold

public Transcript._FinalStage speechThreshold(java.util.Optional<java.lang.Double> speechThreshold)

Specified by:

speechThreshold in interface Transcript._FinalStage

entities

public Transcript._FinalStage entities(java.util.List<Entity> entities)

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

Specified by:

entities in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

entities

public Transcript._FinalStage entities(java.util.Optional<java.util.List<Entity>> entities)

Specified by:

entities in interface Transcript._FinalStage

entityDetection

public Transcript._FinalStage entityDetection(java.lang.Boolean entityDetection)

Whether Entity Detection is enabled, can be true or false

Specified by:

entityDetection in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

entityDetection

public Transcript._FinalStage entityDetection(java.util.Optional<java.lang.Boolean> entityDetection)

Specified by:

entityDetection in interface Transcript._FinalStage

sentimentAnalysisResults

public Transcript._FinalStage sentimentAnalysisResults(java.util.List<SentimentAnalysisResult> sentimentAnalysisResults)

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

Specified by:

sentimentAnalysisResults in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sentimentAnalysisResults

public Transcript._FinalStage sentimentAnalysisResults(java.util.Optional<java.util.List<SentimentAnalysisResult>> sentimentAnalysisResults)

Specified by:

sentimentAnalysisResults in interface Transcript._FinalStage

sentimentAnalysis

public Transcript._FinalStage sentimentAnalysis(java.lang.Boolean sentimentAnalysis)

Whether Sentiment Analysis is enabled, can be true or false

Specified by:

sentimentAnalysis in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sentimentAnalysis

public Transcript._FinalStage sentimentAnalysis(java.util.Optional<java.lang.Boolean> sentimentAnalysis)

Specified by:

sentimentAnalysis in interface Transcript._FinalStage

disfluencies

public Transcript._FinalStage disfluencies(java.lang.Boolean disfluencies)

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

Specified by:

disfluencies in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

disfluencies

public Transcript._FinalStage disfluencies(java.util.Optional<java.lang.Boolean> disfluencies)

Specified by:

disfluencies in interface Transcript._FinalStage

topics

public Transcript._FinalStage topics(java.util.List<java.lang.String> topics)

The list of custom topics provided if custom topics is enabled

Specified by:

topics in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

topics

public Transcript._FinalStage topics(java.util.Optional<java.util.List<java.lang.String>> topics)

Specified by:

topics in interface Transcript._FinalStage

customTopics

public Transcript._FinalStage customTopics(java.lang.Boolean customTopics)

Whether custom topics is enabled, either true or false

Specified by:

customTopics in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

customTopics

public Transcript._FinalStage customTopics(java.util.Optional<java.lang.Boolean> customTopics)

Specified by:

customTopics in interface Transcript._FinalStage

summary

public Transcript._FinalStage summary(java.lang.String summary)

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

Specified by:

summary in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

summary

public Transcript._FinalStage summary(java.util.Optional<java.lang.String> summary)

Specified by:

summary in interface Transcript._FinalStage

summaryModel

public Transcript._FinalStage summaryModel(java.lang.String summaryModel)

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

Specified by:

summaryModel in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

summaryModel

public Transcript._FinalStage summaryModel(java.util.Optional<java.lang.String> summaryModel)

Specified by:

summaryModel in interface Transcript._FinalStage

summaryType

public Transcript._FinalStage summaryType(java.lang.String summaryType)

The type of summary generated, if Summarization is enabled

Specified by:

summaryType in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

summaryType

public Transcript._FinalStage summaryType(java.util.Optional<java.lang.String> summaryType)

Specified by:

summaryType in interface Transcript._FinalStage

chapters

public Transcript._FinalStage chapters(java.util.List<Chapter> chapters)

An array of temporally sequential chapters for the audio file

Specified by:

chapters in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

chapters

public Transcript._FinalStage chapters(java.util.Optional<java.util.List<Chapter>> chapters)

Specified by:

chapters in interface Transcript._FinalStage

autoChapters

public Transcript._FinalStage autoChapters(java.lang.Boolean autoChapters)

Whether Auto Chapters is enabled, can be true or false

Specified by:

autoChapters in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

autoChapters

public Transcript._FinalStage autoChapters(java.util.Optional<java.lang.Boolean> autoChapters)

Specified by:

autoChapters in interface Transcript._FinalStage

customSpelling

public Transcript._FinalStage customSpelling(java.util.List<TranscriptCustomSpelling> customSpelling)

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

Specified by:

customSpelling in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

customSpelling

public Transcript._FinalStage customSpelling(java.util.Optional<java.util.List<TranscriptCustomSpelling>> customSpelling)

Specified by:

customSpelling in interface Transcript._FinalStage

languageDetection

public Transcript._FinalStage languageDetection(java.lang.Boolean languageDetection)

Whether Automatic language detection is enabled, either true or false

Specified by:

languageDetection in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

languageDetection

public Transcript._FinalStage languageDetection(java.util.Optional<java.lang.Boolean> languageDetection)

Specified by:

languageDetection in interface Transcript._FinalStage

iabCategoriesResult

public Transcript._FinalStage iabCategoriesResult(TopicDetectionModelResult iabCategoriesResult)

Specified by:

iabCategoriesResult in interface Transcript._FinalStage

iabCategoriesResult

public Transcript._FinalStage iabCategoriesResult(java.util.Optional<TopicDetectionModelResult> iabCategoriesResult)

Specified by:

iabCategoriesResult in interface Transcript._FinalStage

iabCategories

public Transcript._FinalStage iabCategories(java.lang.Boolean iabCategories)

Whether Topic Detection is enabled, can be true or false

Specified by:

iabCategories in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

iabCategories

public Transcript._FinalStage iabCategories(java.util.Optional<java.lang.Boolean> iabCategories)

Specified by:

iabCategories in interface Transcript._FinalStage

contentSafetyLabels

public Transcript._FinalStage contentSafetyLabels(ContentSafetyLabelsResult contentSafetyLabels)

Specified by:

contentSafetyLabels in interface Transcript._FinalStage

contentSafetyLabels

public Transcript._FinalStage contentSafetyLabels(java.util.Optional<ContentSafetyLabelsResult> contentSafetyLabels)

Specified by:

contentSafetyLabels in interface Transcript._FinalStage

contentSafety

public Transcript._FinalStage contentSafety(java.lang.Boolean contentSafety)

Whether Content Moderation is enabled, can be true or false

Specified by:

contentSafety in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

contentSafety

public Transcript._FinalStage contentSafety(java.util.Optional<java.lang.Boolean> contentSafety)

Specified by:

contentSafety in interface Transcript._FinalStage

speakersExpected

public Transcript._FinalStage speakersExpected(java.lang.Integer speakersExpected)

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

Specified by:

speakersExpected in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

speakersExpected

public Transcript._FinalStage speakersExpected(java.util.Optional<java.lang.Integer> speakersExpected)

Specified by:

speakersExpected in interface Transcript._FinalStage

speakerLabels

public Transcript._FinalStage speakerLabels(java.lang.Boolean speakerLabels)

Whether Speaker diarization is enabled, can be true or false

Specified by:

speakerLabels in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

speakerLabels

public Transcript._FinalStage speakerLabels(java.util.Optional<java.lang.Boolean> speakerLabels)

Specified by:

speakerLabels in interface Transcript._FinalStage

redactPiiSub

public Transcript._FinalStage redactPiiSub(SubstitutionPolicy redactPiiSub)

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

Specified by:

redactPiiSub in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

redactPiiSub

public Transcript._FinalStage redactPiiSub(java.util.Optional<SubstitutionPolicy> redactPiiSub)

Specified by:

redactPiiSub in interface Transcript._FinalStage

redactPiiPolicies

public Transcript._FinalStage redactPiiPolicies(java.util.List<PiiPolicy> redactPiiPolicies)

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

Specified by:

redactPiiPolicies in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

redactPiiPolicies

public Transcript._FinalStage redactPiiPolicies(java.util.Optional<java.util.List<PiiPolicy>> redactPiiPolicies)

Specified by:

redactPiiPolicies in interface Transcript._FinalStage

redactPiiAudioQuality

public Transcript._FinalStage redactPiiAudioQuality(RedactPiiAudioQuality redactPiiAudioQuality)

Specified by:

redactPiiAudioQuality in interface Transcript._FinalStage

redactPiiAudioQuality

public Transcript._FinalStage redactPiiAudioQuality(java.util.Optional<RedactPiiAudioQuality> redactPiiAudioQuality)

Specified by:

redactPiiAudioQuality in interface Transcript._FinalStage

redactPiiAudio

public Transcript._FinalStage redactPiiAudio(java.lang.Boolean redactPiiAudio)

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

Specified by:

redactPiiAudio in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

redactPiiAudio

public Transcript._FinalStage redactPiiAudio(java.util.Optional<java.lang.Boolean> redactPiiAudio)

Specified by:

redactPiiAudio in interface Transcript._FinalStage

filterProfanity

public Transcript._FinalStage filterProfanity(java.lang.Boolean filterProfanity)

Whether Profanity Filtering is enabled, either true or false

Specified by:

filterProfanity in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

filterProfanity

public Transcript._FinalStage filterProfanity(java.util.Optional<java.lang.Boolean> filterProfanity)

Specified by:

filterProfanity in interface Transcript._FinalStage

boostParam

public Transcript._FinalStage boostParam(java.lang.String boostParam)

The word boost parameter value

Specified by:

boostParam in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

boostParam

public Transcript._FinalStage boostParam(java.util.Optional<java.lang.String> boostParam)

Specified by:

boostParam in interface Transcript._FinalStage

wordBoost

public Transcript._FinalStage wordBoost(java.util.List<java.lang.String> wordBoost)

The list of custom vocabulary to boost transcription probability for

Specified by:

wordBoost in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

wordBoost

public Transcript._FinalStage wordBoost(java.util.Optional<java.util.List<java.lang.String>> wordBoost)

Specified by:

wordBoost in interface Transcript._FinalStage

audioEndAt

public Transcript._FinalStage audioEndAt(java.lang.Integer audioEndAt)

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

Specified by:

audioEndAt in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

audioEndAt

public Transcript._FinalStage audioEndAt(java.util.Optional<java.lang.Integer> audioEndAt)

Specified by:

audioEndAt in interface Transcript._FinalStage

audioStartFrom

public Transcript._FinalStage audioStartFrom(java.lang.Integer audioStartFrom)

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

Specified by:

audioStartFrom in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

audioStartFrom

public Transcript._FinalStage audioStartFrom(java.util.Optional<java.lang.Integer> audioStartFrom)

Specified by:

audioStartFrom in interface Transcript._FinalStage

autoHighlightsResult

public Transcript._FinalStage autoHighlightsResult(AutoHighlightsResult autoHighlightsResult)

Specified by:

autoHighlightsResult in interface Transcript._FinalStage

autoHighlightsResult

public Transcript._FinalStage autoHighlightsResult(java.util.Optional<AutoHighlightsResult> autoHighlightsResult)

Specified by:

autoHighlightsResult in interface Transcript._FinalStage

speedBoost

public Transcript._FinalStage speedBoost(java.lang.Boolean speedBoost)

Whether speed boost is enabled

Specified by:

speedBoost in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

speedBoost

public Transcript._FinalStage speedBoost(java.util.Optional<java.lang.Boolean> speedBoost)

Specified by:

speedBoost in interface Transcript._FinalStage

webhookAuthHeaderName

public Transcript._FinalStage webhookAuthHeaderName(java.lang.String webhookAuthHeaderName)

The header name which should be sent back with webhook calls

Specified by:

webhookAuthHeaderName in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

webhookAuthHeaderName

public Transcript._FinalStage webhookAuthHeaderName(java.util.Optional<java.lang.String> webhookAuthHeaderName)

Specified by:

webhookAuthHeaderName in interface Transcript._FinalStage

webhookStatusCode

public Transcript._FinalStage webhookStatusCode(java.lang.Integer webhookStatusCode)

The status code we received from your server when delivering your webhook, if a webhook URL was provided

Specified by:

webhookStatusCode in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

webhookStatusCode

public Transcript._FinalStage webhookStatusCode(java.util.Optional<java.lang.Integer> webhookStatusCode)

Specified by:

webhookStatusCode in interface Transcript._FinalStage

webhookUrl

public Transcript._FinalStage webhookUrl(java.lang.String webhookUrl)

The URL to which we send webhooks upon trancription completion

Specified by:

webhookUrl in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

webhookUrl

public Transcript._FinalStage webhookUrl(java.util.Optional<java.lang.String> webhookUrl)

Specified by:

webhookUrl in interface Transcript._FinalStage

dualChannel

public Transcript._FinalStage dualChannel(java.lang.Boolean dualChannel)

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

Specified by:

dualChannel in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

dualChannel

public Transcript._FinalStage dualChannel(java.util.Optional<java.lang.Boolean> dualChannel)

Specified by:

dualChannel in interface Transcript._FinalStage

formatText

public Transcript._FinalStage formatText(java.lang.Boolean formatText)

Whether Text Formatting is enabled, either true or false

Specified by:

formatText in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

formatText

public Transcript._FinalStage formatText(java.util.Optional<java.lang.Boolean> formatText)

Specified by:

formatText in interface Transcript._FinalStage

punctuate

public Transcript._FinalStage punctuate(java.lang.Boolean punctuate)

Whether Automatic Punctuation is enabled, either true or false

Specified by:

punctuate in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

punctuate

public Transcript._FinalStage punctuate(java.util.Optional<java.lang.Boolean> punctuate)

Specified by:

punctuate in interface Transcript._FinalStage

audioDuration

public Transcript._FinalStage audioDuration(java.lang.Double audioDuration)

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

Specified by:

audioDuration in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

audioDuration

public Transcript._FinalStage audioDuration(java.util.Optional<java.lang.Double> audioDuration)

Specified by:

audioDuration in interface Transcript._FinalStage

confidence

public Transcript._FinalStage confidence(java.lang.Double confidence)

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

Specified by:

confidence in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

confidence

public Transcript._FinalStage confidence(java.util.Optional<java.lang.Double> confidence)

Specified by:

confidence in interface Transcript._FinalStage

utterances

public Transcript._FinalStage utterances(java.util.List<TranscriptUtterance> utterances)

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

Specified by:

utterances in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

utterances

public Transcript._FinalStage utterances(java.util.Optional<java.util.List<TranscriptUtterance>> utterances)

Specified by:

utterances in interface Transcript._FinalStage

words

public Transcript._FinalStage words(java.util.List<TranscriptWord> words)

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

Specified by:

words in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

words

public Transcript._FinalStage words(java.util.Optional<java.util.List<TranscriptWord>> words)

Specified by:

words in interface Transcript._FinalStage

text

public Transcript._FinalStage text(java.lang.String text)

The textual transcript of your media file

Specified by:

text in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

text

public Transcript._FinalStage text(java.util.Optional<java.lang.String> text)

Specified by:

text in interface Transcript._FinalStage

languageCode

public Transcript._FinalStage languageCode(TranscriptLanguageCode languageCode)

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

Specified by:

languageCode in interface Transcript._FinalStage

Returns:

Reference to this so that method calls can be chained together.

languageCode

public Transcript._FinalStage languageCode(java.util.Optional<TranscriptLanguageCode> languageCode)

Specified by:

languageCode in interface Transcript._FinalStage

speechModel

public Transcript._FinalStage speechModel(SpeechModel speechModel)

Specified by:

speechModel in interface Transcript._FinalStage

speechModel

public Transcript._FinalStage speechModel(java.util.Optional<SpeechModel> speechModel)

Specified by:

speechModel in interface Transcript._FinalStage

build

public Transcript build()

Specified by:

build in interface Transcript._FinalStage