com.ibm.watson.speech_to_text.v1.model

Class RecognizeOptions.Builder

java.lang.Object

com.ibm.watson.speech_to_text.v1.model.RecognizeOptions.Builder

Enclosing class:

RecognizeOptions

public static class RecognizeOptions.Builder
extends java.lang.Object

Builder.

Constructor Summary

Constructors

Constructor and Description
RecognizeOptions.Builder() Instantiates a new builder.
RecognizeOptions.Builder(java.io.InputStream audio) Instantiates a new builder with required properties.

Method Summary

Methods

Modifier and Type	Method and Description
RecognizeOptions.Builder	acousticCustomizationId(java.lang.String acousticCustomizationId) Set the acousticCustomizationId.
RecognizeOptions.Builder	addKeyword(java.lang.String keyword) Adds an keyword to keywords.
RecognizeOptions.Builder	audio(java.io.File audio) Set the audio.
RecognizeOptions.Builder	audio(java.io.InputStream audio) Set the audio.
RecognizeOptions.Builder	audioMetrics(java.lang.Boolean audioMetrics) Set the audioMetrics.
RecognizeOptions.Builder	backgroundAudioSuppression(java.lang.Float backgroundAudioSuppression) Set the backgroundAudioSuppression.
RecognizeOptions.Builder	baseModelVersion(java.lang.String baseModelVersion) Set the baseModelVersion.
RecognizeOptions	build() Builds a RecognizeOptions.
RecognizeOptions.Builder	contentType(java.lang.String contentType) Set the contentType.
RecognizeOptions.Builder	customizationId(java.lang.String customizationId) Set the customizationId.
RecognizeOptions.Builder	customizationWeight(java.lang.Double customizationWeight) Set the customizationWeight.
RecognizeOptions.Builder	endOfPhraseSilenceTime(java.lang.Double endOfPhraseSilenceTime) Set the endOfPhraseSilenceTime.
RecognizeOptions.Builder	grammarName(java.lang.String grammarName) Set the grammarName.
RecognizeOptions.Builder	inactivityTimeout(long inactivityTimeout) Set the inactivityTimeout.
java.lang.Boolean	interimResults() Gets the interimResults.
RecognizeOptions.Builder	interimResults(java.lang.Boolean interimResults) Set the interimResults.
RecognizeOptions.Builder	keywords(java.util.List<java.lang.String> keywords) Set the keywords.
RecognizeOptions.Builder	keywordsThreshold(java.lang.Float keywordsThreshold) Set the keywordsThreshold.
RecognizeOptions.Builder	languageCustomizationId(java.lang.String languageCustomizationId) Set the languageCustomizationId.
RecognizeOptions.Builder	maxAlternatives(long maxAlternatives) Set the maxAlternatives.
RecognizeOptions.Builder	model(java.lang.String model) Set the model.
java.lang.Boolean	processingMetrics() Gets the processingMetrics.
RecognizeOptions.Builder	processingMetrics(java.lang.Boolean processingMetrics) Set the processingMetrics.
java.lang.Float	processingMetricsInterval() Gets the processingMetricsInterval.
RecognizeOptions.Builder	processingMetricsInterval(java.lang.Float processingMetricsInterval) Set the processingMetricsInterval.
RecognizeOptions.Builder	profanityFilter(java.lang.Boolean profanityFilter) Set the profanityFilter.
RecognizeOptions.Builder	redaction(java.lang.Boolean redaction) Set the redaction.
RecognizeOptions.Builder	smartFormatting(java.lang.Boolean smartFormatting) Set the smartFormatting.
RecognizeOptions.Builder	speakerLabels(java.lang.Boolean speakerLabels) Set the speakerLabels.
RecognizeOptions.Builder	speechDetectorSensitivity(java.lang.Float speechDetectorSensitivity) Set the speechDetectorSensitivity.
RecognizeOptions.Builder	splitTranscriptAtPhraseEnd(java.lang.Boolean splitTranscriptAtPhraseEnd) Set the splitTranscriptAtPhraseEnd.
RecognizeOptions.Builder	timestamps(java.lang.Boolean timestamps) Set the timestamps.
RecognizeOptions.Builder	wordAlternativesThreshold(java.lang.Float wordAlternativesThreshold) Set the wordAlternativesThreshold.
RecognizeOptions.Builder	wordConfidence(java.lang.Boolean wordConfidence) Set the wordConfidence.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecognizeOptions.Builder

public RecognizeOptions.Builder()

Instantiates a new builder.

RecognizeOptions.Builder

public RecognizeOptions.Builder(java.io.InputStream audio)

Instantiates a new builder with required properties.

Parameters:

audio - the audio

Method Detail

build

public RecognizeOptions build()

Builds a RecognizeOptions.

Returns:

the recognizeOptions

addKeyword

public RecognizeOptions.Builder addKeyword(java.lang.String keyword)

Adds an keyword to keywords.

Parameters:

keyword - the new keyword

Returns:

the RecognizeOptions builder

interimResults

public java.lang.Boolean interimResults()

Gets the interimResults.

If `true`, the service returns interim results as a stream of `SpeechRecognitionResults` objects. By default, the service returns a single `SpeechRecognitionResults` object with final results only.

NOTE: This parameter only works for the `recognizeUsingWebSocket` method.

Returns:

the interimResults

processingMetrics

public java.lang.Boolean processingMetrics()

Gets the processingMetrics.

If `true`, requests processing metrics about the service's transcription of the input audio. The service returns processing metrics at the interval specified by the `processing_metrics_interval` parameter. It also returns processing metrics for transcription events, for example, for final and interim results. By default, the service returns no processing metrics.

NOTE: This parameter only works for the `recognizeUsingWebSocket` method.

Returns:

the processingMetrics

processingMetricsInterval

public java.lang.Float processingMetricsInterval()

Gets the processingMetricsInterval.

Specifies the interval in real wall-clock seconds at which the service is to return processing metrics. The parameter is ignored unless the `processing_metrics` parameter is set to `true`.

The parameter accepts a minimum value of 0.1 seconds. The level of precision is not restricted, so you can specify values such as 0.25 and 0.125.

The service does not impose a maximum value. If you want to receive processing metrics only for transcription events instead of at periodic intervals, set the value to a large number. If the value is larger than the duration of the audio, the service returns processing metrics only for transcription events.

NOTE: This parameter only works for the `recognizeUsingWebSocket` method.

Returns:

the processingMetricsInterval

interimResults

public RecognizeOptions.Builder interimResults(java.lang.Boolean interimResults)

Set the interimResults.

NOTE: This parameter only works for the `recognizeUsingWebSocket` method.

Parameters:

interimResults - the interimResults

Returns:

the interimResults

processingMetrics

public RecognizeOptions.Builder processingMetrics(java.lang.Boolean processingMetrics)

Set the processingMetrics.

NOTE: This parameter only works for the `recognizeUsingWebSocket` method.

Parameters:

processingMetrics - the processingMetrics

Returns:

the processingMetrics

processingMetricsInterval

public RecognizeOptions.Builder processingMetricsInterval(java.lang.Float processingMetricsInterval)

Set the processingMetricsInterval.

NOTE: This parameter only works for the `recognizeUsingWebSocket` method.

Parameters:

processingMetricsInterval - the processingMetricsInterval

Returns:

the processingMetricsInterval

audio

public RecognizeOptions.Builder audio(java.io.InputStream audio)

Set the audio.

Parameters:

audio - the audio

Returns:

the RecognizeOptions builder

contentType

public RecognizeOptions.Builder contentType(java.lang.String contentType)

Set the contentType.

Parameters:

contentType - the contentType

Returns:

the RecognizeOptions builder

model

public RecognizeOptions.Builder model(java.lang.String model)

Set the model.

Parameters:

model - the model

Returns:

the RecognizeOptions builder

languageCustomizationId

public RecognizeOptions.Builder languageCustomizationId(java.lang.String languageCustomizationId)

Set the languageCustomizationId.

Parameters:

languageCustomizationId - the languageCustomizationId

Returns:

the RecognizeOptions builder

acousticCustomizationId

public RecognizeOptions.Builder acousticCustomizationId(java.lang.String acousticCustomizationId)

Set the acousticCustomizationId.

Parameters:

acousticCustomizationId - the acousticCustomizationId

Returns:

the RecognizeOptions builder

baseModelVersion

public RecognizeOptions.Builder baseModelVersion(java.lang.String baseModelVersion)

Set the baseModelVersion.

Parameters:

baseModelVersion - the baseModelVersion

Returns:

the RecognizeOptions builder

customizationWeight

public RecognizeOptions.Builder customizationWeight(java.lang.Double customizationWeight)

Set the customizationWeight.

Parameters:

customizationWeight - the customizationWeight

Returns:

the RecognizeOptions builder

inactivityTimeout

public RecognizeOptions.Builder inactivityTimeout(long inactivityTimeout)

Set the inactivityTimeout.

Parameters:

inactivityTimeout - the inactivityTimeout

Returns:

the RecognizeOptions builder

keywords

public RecognizeOptions.Builder keywords(java.util.List<java.lang.String> keywords)

Set the keywords. Existing keywords will be replaced.

Parameters:

keywords - the keywords

Returns:

the RecognizeOptions builder

keywordsThreshold

public RecognizeOptions.Builder keywordsThreshold(java.lang.Float keywordsThreshold)

Set the keywordsThreshold.

Parameters:

keywordsThreshold - the keywordsThreshold

Returns:

the RecognizeOptions builder

maxAlternatives

public RecognizeOptions.Builder maxAlternatives(long maxAlternatives)

Set the maxAlternatives.

Parameters:

maxAlternatives - the maxAlternatives

Returns:

the RecognizeOptions builder

wordAlternativesThreshold

public RecognizeOptions.Builder wordAlternativesThreshold(java.lang.Float wordAlternativesThreshold)

Set the wordAlternativesThreshold.

Parameters:

wordAlternativesThreshold - the wordAlternativesThreshold

Returns:

the RecognizeOptions builder

wordConfidence

public RecognizeOptions.Builder wordConfidence(java.lang.Boolean wordConfidence)

Set the wordConfidence.

Parameters:

wordConfidence - the wordConfidence

Returns:

the RecognizeOptions builder

timestamps

public RecognizeOptions.Builder timestamps(java.lang.Boolean timestamps)

Set the timestamps.

Parameters:

timestamps - the timestamps

Returns:

the RecognizeOptions builder

profanityFilter

public RecognizeOptions.Builder profanityFilter(java.lang.Boolean profanityFilter)

Set the profanityFilter.

Parameters:

profanityFilter - the profanityFilter

Returns:

the RecognizeOptions builder

smartFormatting

public RecognizeOptions.Builder smartFormatting(java.lang.Boolean smartFormatting)

Set the smartFormatting.

Parameters:

smartFormatting - the smartFormatting

Returns:

the RecognizeOptions builder

speakerLabels

public RecognizeOptions.Builder speakerLabels(java.lang.Boolean speakerLabels)

Set the speakerLabels.

Parameters:

speakerLabels - the speakerLabels

Returns:

the RecognizeOptions builder

customizationId

public RecognizeOptions.Builder customizationId(java.lang.String customizationId)

Set the customizationId.

Parameters:

customizationId - the customizationId

Returns:

the RecognizeOptions builder

grammarName

public RecognizeOptions.Builder grammarName(java.lang.String grammarName)

Set the grammarName.

Parameters:

grammarName - the grammarName

Returns:

the RecognizeOptions builder

redaction

public RecognizeOptions.Builder redaction(java.lang.Boolean redaction)

Set the redaction.

Parameters:

redaction - the redaction

Returns:

the RecognizeOptions builder

audioMetrics

public RecognizeOptions.Builder audioMetrics(java.lang.Boolean audioMetrics)

Set the audioMetrics.

Parameters:

audioMetrics - the audioMetrics

Returns:

the RecognizeOptions builder

endOfPhraseSilenceTime

public RecognizeOptions.Builder endOfPhraseSilenceTime(java.lang.Double endOfPhraseSilenceTime)

Set the endOfPhraseSilenceTime.

Parameters:

endOfPhraseSilenceTime - the endOfPhraseSilenceTime

Returns:

the RecognizeOptions builder

splitTranscriptAtPhraseEnd

public RecognizeOptions.Builder splitTranscriptAtPhraseEnd(java.lang.Boolean splitTranscriptAtPhraseEnd)

Set the splitTranscriptAtPhraseEnd.

Parameters:

splitTranscriptAtPhraseEnd - the splitTranscriptAtPhraseEnd

Returns:

the RecognizeOptions builder

speechDetectorSensitivity

public RecognizeOptions.Builder speechDetectorSensitivity(java.lang.Float speechDetectorSensitivity)

Set the speechDetectorSensitivity.

Parameters:

speechDetectorSensitivity - the speechDetectorSensitivity

Returns:

the RecognizeOptions builder

backgroundAudioSuppression

public RecognizeOptions.Builder backgroundAudioSuppression(java.lang.Float backgroundAudioSuppression)

Set the backgroundAudioSuppression.

Parameters:

backgroundAudioSuppression - the backgroundAudioSuppression

Returns:

the RecognizeOptions builder

audio

public RecognizeOptions.Builder audio(java.io.File audio)
                               throws java.io.FileNotFoundException

Set the audio.

Parameters:

audio - the audio

Returns:

the RecognizeOptions builder

Throws:

java.io.FileNotFoundException - if the file could not be found