RecognizeOptions.Builder (parent 4.0.0 API)

java.lang.Object
- com.ibm.watson.developer_cloud.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

Builder()
Instantiates a new builder.

Constructors
Constructor and Description
`Builder()` Instantiates a new builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecognizeOptions`	`build()` Builds the profile options.
`RecognizeOptions.Builder`	`contentType(java.lang.String contentType)` The format of the audio data specified.
`RecognizeOptions.Builder`	`customizationId(java.lang.String customizationId)` Specifies the customization id(GUID).
`RecognizeOptions.Builder`	`inactivityTimeout(java.lang.Integer inactivityTimeout)` Inactivity timeout.
`RecognizeOptions.Builder`	`interimResults(java.lang.Boolean interimResults)` If true, the service sends interim results for the transcription.
`RecognizeOptions.Builder`	`keywords(java.lang.String... keywords)` Specifies an array of keyword strings to be matched in the input audio.
`RecognizeOptions.Builder`	`keywordsThreshold(java.lang.Double keywordsThreshold)` Specifies a minimum level of confidence that the service must have to report a matching keyword in the input audio.
`RecognizeOptions.Builder`	`maxAlternatives(java.lang.Integer maxAlternatives)` Maximum number of alternative transcripts returned.
`RecognizeOptions.Builder`	`model(java.lang.String model)` Sets the model name used for the recognition.
`RecognizeOptions.Builder`	`profanityFilter(java.lang.Boolean profanityFilter)` If true, filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks.
`RecognizeOptions.Builder`	`session(SpeechSession session)` Sets the session id.
`RecognizeOptions.Builder`	`sessionId(java.lang.String sessionId)` Sets session id.
`RecognizeOptions.Builder`	`smartFormatting(java.lang.Boolean smartFormatting)` If `true`, converts dates, times, series of digits and numbers, phone numbers, currency values, and Internet addresses into more readable, conventional representations in the final transcript of a recognition request.
`RecognizeOptions.Builder`	`speakerLabels(java.lang.Boolean speakerLabels)` If `true`, adds speaker labels to the transcript.
`RecognizeOptions.Builder`	`timestamps(java.lang.Boolean timestamps)` If true, time alignment for each word is returned.
`RecognizeOptions.Builder`	`wordAlternativesThreshold(java.lang.Double wordAlternativesThreshold)` Specifies a minimum level of confidence that the service must have to report a hypothesis for a word from the input audio.
`RecognizeOptions.Builder`	`wordConfidence(java.lang.Boolean wordConfidence)` If true, confidence measure per word is returned if available.

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

- Constructor Detail
  - Builder
```
public Builder()
```
    Instantiates a new builder.
- Method Detail
  - build
```
public RecognizeOptions build()
```
    Builds the profile options.
    
    Returns:
    
    the profile options
  - contentType
```
public RecognizeOptions.Builder contentType(java.lang.String contentType)
```
    The format of the audio data specified.
    - audio/flac for Free Lossless Audio Codec (FLAC)
    - audio/l16 for Linear 16-bit Pulse-Code Modulation (PCM)
    - audio/mp3 for MP3
    - audio/mpeg for MPEG-1
    - audio/mulaw for Mulaw
    - audio/webm for Webm
    - audio/wav for Waveform Audio File Format (WAV)
    - audio/ogg;codecs=opus for OGG format files that use the opus codec
    Parameters:
    
    contentType - the content type
    
    Returns:
    
    the recognize options
    
    Throws:
    
    java.lang.IllegalArgumentException - when contentType is null or invalid
  - smartFormatting
```
public RecognizeOptions.Builder smartFormatting(java.lang.Boolean smartFormatting)
```
    If true, converts dates, times, series of digits and numbers, phone numbers, currency values, and Internet addresses into more readable, conventional representations in the final transcript of a recognition request. If false (the default), no formatting is performed. Applies to US English transcription only.
    
    Parameters:
    
    smartFormatting - Smart formatting
    
    Returns:
    
    the recognize options
  - speakerLabels
```
public RecognizeOptions.Builder speakerLabels(java.lang.Boolean speakerLabels)
```
    If true, adds speaker labels to the transcript.
    
    Parameters:
    
    speakerLabels - Labels or "diarization"
    
    Returns:
    
    the recognize options
  - profanityFilter
```
public RecognizeOptions.Builder profanityFilter(java.lang.Boolean profanityFilter)
```
    If true, filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks. Set the parameter to false to return results with no censoring. Applies to US English transcription only.
    
    Parameters:
    
    profanityFilter - the profanity filter
    
    Returns:
    
    the recognize options
  - inactivityTimeout
```
public RecognizeOptions.Builder inactivityTimeout(java.lang.Integer inactivityTimeout)
```
    Inactivity timeout.
    
    Parameters:
    
    inactivityTimeout - the inactivity timeout
    
    Returns:
    
    the recognize options
  - interimResults
```
public RecognizeOptions.Builder interimResults(java.lang.Boolean interimResults)
```
    If true, the service sends interim results for the transcription. Otherwise, the recognition ends after first "end of speech" is detected. The default is false. This option is only supported with the SpeechToText.recognizeUsingWebSocket(InputStream, RecognizeOptions, RecognizeCallback) method.
    
    Parameters:
    
    interimResults - the interim results
    
    Returns:
    
    the recognize options
  - customizationId
```
public RecognizeOptions.Builder customizationId(java.lang.String customizationId)
```
    Specifies the customization id(GUID).
    
    Parameters:
    
    customizationId - the customization id
    
    Returns:
    
    the recognize options
  - keywords
```
public RecognizeOptions.Builder keywords(java.lang.String... keywords)
```
    Specifies an array of keyword strings to be matched in the input audio. By default, the service does no keyword spotting.
    
    Parameters:
    
    keywords - the keywords
    
    Returns:
    
    the recognize options
  - keywordsThreshold
```
public RecognizeOptions.Builder keywordsThreshold(java.lang.Double keywordsThreshold)
```
    Specifies a minimum level of confidence that the service must have to report a matching keyword in the input audio. Specify a probability value between 0 and 1 inclusive. A match must have at least the specified confidence to be returned. Omit the parameter or specify a value of null (the default) to spot no keywords. If you specify a valid threshold, you must also specify at least one keyword.
    
    Parameters:
    
    keywordsThreshold - the keywords threshold
    
    Returns:
    
    the recognize options
  - maxAlternatives
```
public RecognizeOptions.Builder maxAlternatives(java.lang.Integer maxAlternatives)
```
    Maximum number of alternative transcripts returned.
    
    Parameters:
    
    maxAlternatives - the max alternatives
    
    Returns:
    
    the recognize options
  - model
```
public RecognizeOptions.Builder model(java.lang.String model)
```
    Sets the model name used for the recognition.
    
    Parameters:
    
    model - the model
    
    Returns:
    
    the recognize options
  - session
```
public RecognizeOptions.Builder session(SpeechSession session)
```
    Sets the session id.
    
    Parameters:
    
    session - the SpeechSession
    
    Returns:
    
    the recognize options
  - sessionId
```
public RecognizeOptions.Builder sessionId(java.lang.String sessionId)
```
    Sets session id.
    
    Parameters:
    
    sessionId - the session id
    
    Returns:
    
    the recognize options
  - timestamps
```
public RecognizeOptions.Builder timestamps(java.lang.Boolean timestamps)
```
    If true, time alignment for each word is returned.
    
    Parameters:
    
    timestamps - the timestamps
    
    Returns:
    
    the recognize options
  - wordAlternativesThreshold
```
public RecognizeOptions.Builder wordAlternativesThreshold(java.lang.Double wordAlternativesThreshold)
```
    Specifies a minimum level of confidence that the service must have to report a hypothesis for a word from the input audio. Specify a probability value between 0 and 1 inclusive. A hypothesis must have at least the specified confidence to be returned as a word alternative. Omit the parameter or specify a value of null (the default) to return no word alternatives.
    
    Parameters:
    
    wordAlternativesThreshold - the wordAalternatives threshold
    
    Returns:
    
    the recognize options
  - wordConfidence
```
public RecognizeOptions.Builder wordConfidence(java.lang.Boolean wordConfidence)
```
    If true, confidence measure per word is returned if available.
    
    Parameters:
    
    wordConfidence - the word confidence
    
    Returns:
    
    the recognize options

Class RecognizeOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

contentType

smartFormatting

speakerLabels

profanityFilter

inactivityTimeout

interimResults

customizationId

keywords

keywordsThreshold

maxAlternatives

model

session

sessionId

timestamps

wordAlternativesThreshold

wordConfidence