com.ibm.watson.developer_cloud.speech_to_text.v1

Class RecognizeOptions

java.lang.Object

com.ibm.watson.developer_cloud.speech_to_text.v1.RecognizeOptions

public class RecognizeOptions
extends Object

Parameters to be use during a recognize call in the SpeechToText service.

Constructor Summary

Constructors

Constructor and Description
RecognizeOptions()

Method Summary

Modifier and Type	Method and Description
RecognizeOptions	contentType(String contentType) The format of the audio data specified as one of the following values: audio/flac for Free Lossless Audio Codec (FLAC) audio/l16 for Linear 16-bit Pulse-Code Modulation (PCM) audio/wav for Waveform Audio File Format (WAV) audio/ogg;codecs=opus for Ogg format files that use the opus codec
RecognizeOptions	continuous(Boolean continuous) If true, multiple final results that represent multiple consecutive phrases separated by pauses are returned.
String	getContentType() Gets the content type.
Boolean	getContinuous() Gets the continuous.
Integer	getInactivityTimeout() Gets the inactivity timeout.
Boolean	getInterimResults() Gets the interim results.
String[]	getKeywords() Gets the keywords.
Double	getKeywordsThreshold() Gets the keywords threshold.
Integer	getMaxAlternatives() Gets the max alternatives.
String	getModel() Gets the model.
String	getSessionId() Gets the session id.
Boolean	getTimestamps() Gets the timestamps.
Double	getWordAlternativesThreshold() Gets the word alternatives threshold.
Boolean	getWordConfidence() Gets the word confidence.
RecognizeOptions	inactivityTimeout(Integer inactivityTimeout) Inactivity timeout.
RecognizeOptions	interimResults(Boolean interimResults) If true, the service sends interim results for the transcription.
RecognizeOptions	keywords(String[] keywords) Specifies an array of keyword strings to be matched in the input audio.
RecognizeOptions	keywordsThreshold(Double keywordsThreshold) Specifies a minimum level of confidence that the service must have to report a matching keyword in the input audio.
RecognizeOptions	maxAlternatives(Integer maxAlternatives) Maximum number of alternative transcripts returned.
RecognizeOptions	model(String model) Sets the model name used for the recognition.
RecognizeOptions	session(SpeechSession session) Sets the session id.
RecognizeOptions	sessionId(String sessionId) Sets session id.
RecognizeOptions	timestamps(Boolean timestamps) If true, time alignment for each word is returned.
RecognizeOptions	wordAlternativesThreshold(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	wordConfidence(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

RecognizeOptions

public RecognizeOptions()

Method Detail

continuous

public RecognizeOptions continuous(Boolean continuous)

If true, multiple final results that represent multiple consecutive phrases separated by pauses are returned. Otherwise, the recognition ends after first "end of speech" is detected.

Parameters:

continuous - the continuous

Returns:

the recognize options

getContentType

public String getContentType()

Gets the content type.

Returns:

the contentType

getContinuous

public Boolean getContinuous()

Gets the continuous.

Returns:

the continuous

getInactivityTimeout

public Integer getInactivityTimeout()

Gets the inactivity timeout.

Returns:

the inactivity timeout

getInterimResults

public Boolean getInterimResults()

Gets the interim results.

Returns:

the interimResults

getKeywords

public String[] getKeywords()

Gets the keywords.

Returns:

the keywords

getKeywordsThreshold

public Double getKeywordsThreshold()

Gets the keywords threshold.

Returns:

the keywordsThreshold

getMaxAlternatives

public Integer getMaxAlternatives()

Gets the max alternatives.

Returns:

the maxAlternatives

getModel

public String getModel()

Gets the model.

Returns:

the model

getSessionId

public String getSessionId()

Gets the session id.

Returns:

the sessionId

getTimestamps

public Boolean getTimestamps()

Gets the timestamps.

Returns:

the timestamps

getWordAlternativesThreshold

public Double getWordAlternativesThreshold()

Gets the word alternatives threshold.

Returns:

the wordAlternativesThreshold

getWordConfidence

public Boolean getWordConfidence()

Gets the word confidence.

Returns:

the wordConfidence

inactivityTimeout

public RecognizeOptions inactivityTimeout(Integer inactivityTimeout)

Inactivity timeout.

Parameters:

inactivityTimeout - the inactivity timeout

Returns:

the recognize options

interimResults

public RecognizeOptions interimResults(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.

Parameters:

interimResults - the interim results

Returns:

the recognize options

keywords

public RecognizeOptions keywords(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 keywordsThreshold(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 maxAlternatives(Integer maxAlternatives)

Maximum number of alternative transcripts returned.

Parameters:

maxAlternatives - the max alternatives

Returns:

the recognize options

model

public RecognizeOptions model(String model)

Sets the model name used for the recognition.

Parameters:

model - the model

Returns:

the recognize options

session

public RecognizeOptions session(SpeechSession session)

Sets the session id.

Parameters:

session - the SpeechSession

Returns:

the recognize options

sessionId

public RecognizeOptions sessionId(String sessionId)

Sets session id.

Parameters:

sessionId - the session id

Returns:

the recognize options

timestamps

public RecognizeOptions timestamps(Boolean timestamps)

If true, time alignment for each word is returned.

Parameters:

timestamps - the timestamps

Returns:

the recognize options

wordAlternativesThreshold

public RecognizeOptions wordAlternativesThreshold(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

contentType

public RecognizeOptions contentType(String contentType)

The format of the audio data specified as one of the following values:

• audio/flac for Free Lossless Audio Codec (FLAC)
• audio/l16 for Linear 16-bit Pulse-Code Modulation (PCM)
• 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

wordConfidence

public RecognizeOptions wordConfidence(Boolean wordConfidence)

If true, confidence measure per word is returned if available.

Parameters:

wordConfidence - the word confidence

Returns:

the recognize options