RecognizeWithWebsocketsOptions.Builder (IBM Watson Java SDK 13.0.0 API)

java.lang.Object
- com.ibm.watson.speech_to_text.v1.model.RecognizeWithWebsocketsOptions.Builder

Enclosing class:: RecognizeWithWebsocketsOptions

public static class RecognizeWithWebsocketsOptions.Builder
extends Object

Builder.

Constructor Summary

Constructors
Constructor and Description

Builder()
Instantiates a new builder.

Builder(InputStream audio)
Instantiates a new builder with required properties.

Constructors
Constructor and Description
`Builder()` Instantiates a new builder.
`Builder(InputStream audio)` Instantiates a new builder with required properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecognizeWithWebsocketsOptions.Builder`	`acousticCustomizationId(String acousticCustomizationId)` Set the acousticCustomizationId.
`RecognizeWithWebsocketsOptions.Builder`	`addKeyword(String keyword)` Adds an keyword to keywords.
`RecognizeWithWebsocketsOptions.Builder`	`audio(File audio)` Set the audio.
`RecognizeWithWebsocketsOptions.Builder`	`audio(InputStream audio)` Set the audio.
`RecognizeWithWebsocketsOptions.Builder`	`audioMetrics(Boolean audioMetrics)` Set the audioMetrics.
`RecognizeWithWebsocketsOptions.Builder`	`backgroundAudioSuppression(Float backgroundAudioSuppression)` Set the backgroundAudioSuppression.
`RecognizeWithWebsocketsOptions.Builder`	`baseModelVersion(String baseModelVersion)` Set the baseModelVersion.
`RecognizeWithWebsocketsOptions`	`build()` Builds a RecognizeOptions.
`RecognizeWithWebsocketsOptions.Builder`	`characterInsertionBias(Float characterInsertionBias)` Set the characterInsertionBias.
`RecognizeWithWebsocketsOptions.Builder`	`contentType(String contentType)` Set the contentType.
`RecognizeWithWebsocketsOptions.Builder`	`customizationWeight(Double customizationWeight)` Set the customizationWeight.
`RecognizeWithWebsocketsOptions.Builder`	`endOfPhraseSilenceTime(Double endOfPhraseSilenceTime)` Set the endOfPhraseSilenceTime.
`RecognizeWithWebsocketsOptions.Builder`	`grammarName(String grammarName)` Set the grammarName.
`RecognizeWithWebsocketsOptions.Builder`	`inactivityTimeout(long inactivityTimeout)` Set the inactivityTimeout.
`RecognizeWithWebsocketsOptions.Builder`	`keywords(List<String> keywords)` Set the keywords.
`RecognizeWithWebsocketsOptions.Builder`	`keywordsThreshold(Float keywordsThreshold)` Set the keywordsThreshold.
`RecognizeWithWebsocketsOptions.Builder`	`languageCustomizationId(String languageCustomizationId)` Set the languageCustomizationId.
`RecognizeWithWebsocketsOptions.Builder`	`maxAlternatives(long maxAlternatives)` Set the maxAlternatives.
`RecognizeWithWebsocketsOptions.Builder`	`model(String model)` Set the model.
`RecognizeWithWebsocketsOptions.Builder`	`processingMetrics(Boolean processingMetrics)` Set the processingMetrics.
`RecognizeWithWebsocketsOptions.Builder`	`processingMetricsInterval(Float processingMetricsInterval)` Set the processingMetricsInterval.
`RecognizeWithWebsocketsOptions.Builder`	`profanityFilter(Boolean profanityFilter)` Set the profanityFilter.
`RecognizeWithWebsocketsOptions.Builder`	`redaction(Boolean redaction)` Set the redaction.
`RecognizeWithWebsocketsOptions.Builder`	`smartFormatting(Boolean smartFormatting)` Set the smartFormatting.
`RecognizeWithWebsocketsOptions.Builder`	`smartFormattingVersion(long smartFormattingVersion)` Set the smartFormattingVersion.
`RecognizeWithWebsocketsOptions.Builder`	`speakerLabels(Boolean speakerLabels)` Set the speakerLabels.
`RecognizeWithWebsocketsOptions.Builder`	`speechDetectorSensitivity(Float speechDetectorSensitivity)` Set the speechDetectorSensitivity.
`RecognizeWithWebsocketsOptions.Builder`	`splitTranscriptAtPhraseEnd(Boolean splitTranscriptAtPhraseEnd)` Set the splitTranscriptAtPhraseEnd.
`RecognizeWithWebsocketsOptions.Builder`	`timestamps(Boolean timestamps)` Set the timestamps.
`RecognizeWithWebsocketsOptions.Builder`	`wordAlternativesThreshold(Float wordAlternativesThreshold)` Set the wordAlternativesThreshold.
`RecognizeWithWebsocketsOptions.Builder`	`wordConfidence(Boolean wordConfidence)` Set the wordConfidence.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Instantiates a new builder.
  - Builder
```
public Builder(InputStream audio)
```
    Instantiates a new builder with required properties.
    
    Parameters:
    
    audio - the audio
- Method Detail
  - build
```
public RecognizeWithWebsocketsOptions build()
```
    Builds a RecognizeOptions.
    
    Returns:
    
    the new RecognizeOptions instance
  - addKeyword
```
public RecognizeWithWebsocketsOptions.Builder addKeyword(String keyword)
```
    Adds an keyword to keywords.
    
    Parameters:
    
    keyword - the new keyword
    
    Returns:
    
    the RecognizeOptions builder
  - audio
```
public RecognizeWithWebsocketsOptions.Builder audio(InputStream audio)
```
    Set the audio.
    
    Parameters:
    
    audio - the audio
    
    Returns:
    
    the RecognizeOptions builder
  - contentType
```
public RecognizeWithWebsocketsOptions.Builder contentType(String contentType)
```
    Set the contentType.
    
    Parameters:
    
    contentType - the contentType
    
    Returns:
    
    the RecognizeOptions builder
  - model
```
public RecognizeWithWebsocketsOptions.Builder model(String model)
```
    Set the model.
    
    Parameters:
    
    model - the model
    
    Returns:
    
    the RecognizeOptions builder
  - languageCustomizationId
```
public RecognizeWithWebsocketsOptions.Builder languageCustomizationId(String languageCustomizationId)
```
    Set the languageCustomizationId.
    
    Parameters:
    
    languageCustomizationId - the languageCustomizationId
    
    Returns:
    
    the RecognizeOptions builder
  - acousticCustomizationId
```
public RecognizeWithWebsocketsOptions.Builder acousticCustomizationId(String acousticCustomizationId)
```
    Set the acousticCustomizationId.
    
    Parameters:
    
    acousticCustomizationId - the acousticCustomizationId
    
    Returns:
    
    the RecognizeOptions builder
  - baseModelVersion
```
public RecognizeWithWebsocketsOptions.Builder baseModelVersion(String baseModelVersion)
```
    Set the baseModelVersion.
    
    Parameters:
    
    baseModelVersion - the baseModelVersion
    
    Returns:
    
    the RecognizeOptions builder
  - customizationWeight
```
public RecognizeWithWebsocketsOptions.Builder customizationWeight(Double customizationWeight)
```
    Set the customizationWeight.
    
    Parameters:
    
    customizationWeight - the customizationWeight
    
    Returns:
    
    the RecognizeOptions builder
  - inactivityTimeout
```
public RecognizeWithWebsocketsOptions.Builder inactivityTimeout(long inactivityTimeout)
```
    Set the inactivityTimeout.
    
    Parameters:
    
    inactivityTimeout - the inactivityTimeout
    
    Returns:
    
    the RecognizeOptions builder
  - keywords
```
public RecognizeWithWebsocketsOptions.Builder keywords(List<String> keywords)
```
    Set the keywords. Existing keywords will be replaced.
    
    Parameters:
    
    keywords - the keywords
    
    Returns:
    
    the RecognizeOptions builder
  - keywordsThreshold
```
public RecognizeWithWebsocketsOptions.Builder keywordsThreshold(Float keywordsThreshold)
```
    Set the keywordsThreshold.
    
    Parameters:
    
    keywordsThreshold - the keywordsThreshold
    
    Returns:
    
    the RecognizeOptions builder
  - maxAlternatives
```
public RecognizeWithWebsocketsOptions.Builder maxAlternatives(long maxAlternatives)
```
    Set the maxAlternatives.
    
    Parameters:
    
    maxAlternatives - the maxAlternatives
    
    Returns:
    
    the RecognizeOptions builder
  - wordAlternativesThreshold
```
public RecognizeWithWebsocketsOptions.Builder wordAlternativesThreshold(Float wordAlternativesThreshold)
```
    Set the wordAlternativesThreshold.
    
    Parameters:
    
    wordAlternativesThreshold - the wordAlternativesThreshold
    
    Returns:
    
    the RecognizeOptions builder
  - wordConfidence
```
public RecognizeWithWebsocketsOptions.Builder wordConfidence(Boolean wordConfidence)
```
    Set the wordConfidence.
    
    Parameters:
    
    wordConfidence - the wordConfidence
    
    Returns:
    
    the RecognizeOptions builder
  - timestamps
```
public RecognizeWithWebsocketsOptions.Builder timestamps(Boolean timestamps)
```
    Set the timestamps.
    
    Parameters:
    
    timestamps - the timestamps
    
    Returns:
    
    the RecognizeOptions builder
  - profanityFilter
```
public RecognizeWithWebsocketsOptions.Builder profanityFilter(Boolean profanityFilter)
```
    Set the profanityFilter.
    
    Parameters:
    
    profanityFilter - the profanityFilter
    
    Returns:
    
    the RecognizeOptions builder
  - smartFormatting
```
public RecognizeWithWebsocketsOptions.Builder smartFormatting(Boolean smartFormatting)
```
    Set the smartFormatting.
    
    Parameters:
    
    smartFormatting - the smartFormatting
    
    Returns:
    
    the RecognizeOptions builder
  - smartFormattingVersion
```
public RecognizeWithWebsocketsOptions.Builder smartFormattingVersion(long smartFormattingVersion)
```
    Set the smartFormattingVersion.
    
    Parameters:
    
    smartFormattingVersion - the smartFormattingVersion
    
    Returns:
    
    the RecognizeOptions builder
  - speakerLabels
```
public RecognizeWithWebsocketsOptions.Builder speakerLabels(Boolean speakerLabels)
```
    Set the speakerLabels.
    
    Parameters:
    
    speakerLabels - the speakerLabels
    
    Returns:
    
    the RecognizeOptions builder
  - grammarName
```
public RecognizeWithWebsocketsOptions.Builder grammarName(String grammarName)
```
    Set the grammarName.
    
    Parameters:
    
    grammarName - the grammarName
    
    Returns:
    
    the RecognizeOptions builder
  - redaction
```
public RecognizeWithWebsocketsOptions.Builder redaction(Boolean redaction)
```
    Set the redaction.
    
    Parameters:
    
    redaction - the redaction
    
    Returns:
    
    the RecognizeOptions builder
  - audioMetrics
```
public RecognizeWithWebsocketsOptions.Builder audioMetrics(Boolean audioMetrics)
```
    Set the audioMetrics.
    
    Parameters:
    
    audioMetrics - the audioMetrics
    
    Returns:
    
    the RecognizeOptions builder
  - endOfPhraseSilenceTime
```
public RecognizeWithWebsocketsOptions.Builder endOfPhraseSilenceTime(Double endOfPhraseSilenceTime)
```
    Set the endOfPhraseSilenceTime.
    
    Parameters:
    
    endOfPhraseSilenceTime - the endOfPhraseSilenceTime
    
    Returns:
    
    the RecognizeOptions builder
  - splitTranscriptAtPhraseEnd
```
public RecognizeWithWebsocketsOptions.Builder splitTranscriptAtPhraseEnd(Boolean splitTranscriptAtPhraseEnd)
```
    Set the splitTranscriptAtPhraseEnd.
    
    Parameters:
    
    splitTranscriptAtPhraseEnd - the splitTranscriptAtPhraseEnd
    
    Returns:
    
    the RecognizeOptions builder
  - speechDetectorSensitivity
```
public RecognizeWithWebsocketsOptions.Builder speechDetectorSensitivity(Float speechDetectorSensitivity)
```
    Set the speechDetectorSensitivity.
    
    Parameters:
    
    speechDetectorSensitivity - the speechDetectorSensitivity
    
    Returns:
    
    the RecognizeOptions builder
  - backgroundAudioSuppression
```
public RecognizeWithWebsocketsOptions.Builder backgroundAudioSuppression(Float backgroundAudioSuppression)
```
    Set the backgroundAudioSuppression.
    
    Parameters:
    
    backgroundAudioSuppression - the backgroundAudioSuppression
    
    Returns:
    
    the RecognizeOptions builder
  - characterInsertionBias
```
public RecognizeWithWebsocketsOptions.Builder characterInsertionBias(Float characterInsertionBias)
```
    Set the characterInsertionBias.
    
    Parameters:
    
    characterInsertionBias - the characterInsertionBias
    
    Returns:
    
    the RecognizeOptions builder
  - audio
```
public RecognizeWithWebsocketsOptions.Builder audio(File audio)
                                             throws FileNotFoundException
```
    Set the audio.
    
    Parameters:
    
    audio - the audio
    
    Returns:
    
    the RecognizeOptions builder
    
    Throws:
    
    FileNotFoundException - if the file could not be found
  - processingMetrics
```
public RecognizeWithWebsocketsOptions.Builder processingMetrics(Boolean processingMetrics)
```
    Set the processingMetrics.
    NOTE: This parameter only works for the `recognizeUsingWebSocket` method.
    
    Parameters:
    
    processingMetrics - the processingMetrics
    
    Returns:
    
    the processingMetrics
  - processingMetricsInterval
```
public RecognizeWithWebsocketsOptions.Builder processingMetricsInterval(Float processingMetricsInterval)
```
    Set the processingMetricsInterval.
    NOTE: This parameter only works for the `recognizeUsingWebSocket` method.
    
    Parameters:
    
    processingMetricsInterval - the processingMetricsInterval
    
    Returns:
    
    the processingMetricsInterval

Class RecognizeWithWebsocketsOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

build

addKeyword

audio

contentType

model

languageCustomizationId

acousticCustomizationId

baseModelVersion

customizationWeight

inactivityTimeout

keywords

keywordsThreshold

maxAlternatives

wordAlternativesThreshold

wordConfidence

timestamps

profanityFilter

smartFormatting

smartFormattingVersion

speakerLabels

grammarName

redaction

audioMetrics

endOfPhraseSilenceTime

splitTranscriptAtPhraseEnd

speechDetectorSensitivity

backgroundAudioSuppression

characterInsertionBias

audio

processingMetrics

processingMetricsInterval