com.ibm.watson.speech_to_text.v1.model

Class MultipartRecognition

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.speech_to_text.v1.model.MultipartRecognition

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class MultipartRecognition
extends com.ibm.cloud.sdk.core.service.model.GenericModel

MultipartRecognition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultipartRecognition.Builder Builder.
static interface	MultipartRecognition.PartContentType The audio format (MIME type) of the audio in the following parts: * `audio/basic` (Use only with narrowband models.) * `audio/flac` * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of channels (`channels`) and endianness (`endianness`) of the audio.) * `audio/mp3` * `audio/mpeg` * `audio/mulaw` (Specify the sampling rate of the audio.) * `audio/ogg` (The service automatically detects the codec of the input audio.) * `audio/ogg;codecs=opus` * `audio/ogg;codecs=vorbis` * `audio/wav` (Provide audio with a maximum of nine channels.) * `audio/webm` (The service automatically detects the codec of the input audio.) * `audio/webm;codecs=opus` * `audio/webm;codecs=vorbis` All data parts must have the same audio format.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	dataPartsCount() Gets the dataPartsCount.
java.lang.Long	inactivityTimeout() Gets the inactivityTimeout.
java.util.List<java.lang.String>	keywords() Gets the keywords.
java.lang.Float	keywordsThreshold() Gets the keywordsThreshold.
java.lang.Long	maxAlternatives() Gets the maxAlternatives.
MultipartRecognition.Builder	newBuilder() New builder.
java.lang.String	partContentType() Gets the partContentType.
java.lang.Boolean	profanityFilter() Gets the profanityFilter.
java.lang.Long	sequenceId() Gets the sequenceId.
java.lang.Boolean	smartFormatting() Gets the smartFormatting.
java.lang.Boolean	speakerLabels() Gets the speakerLabels.
java.lang.Boolean	timestamps() Gets the timestamps.
java.lang.Float	wordAlternativesThreshold() Gets the wordAlternativesThreshold.
java.lang.Boolean	wordConfidence() Gets the wordConfidence.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public MultipartRecognition.Builder newBuilder()

New builder.

Returns:

a MultipartRecognition builder

partContentType

public java.lang.String partContentType()

Gets the partContentType. The audio format (MIME type) of the audio in the following parts: * `audio/basic` (Use only with narrowband models.) * `audio/flac` * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of channels (`channels`) and endianness (`endianness`) of the audio.) * `audio/mp3` * `audio/mpeg` * `audio/mulaw` (Specify the sampling rate of the audio.) * `audio/ogg` (The service automatically detects the codec of the input audio.) * `audio/ogg;codecs=opus` * `audio/ogg;codecs=vorbis` * `audio/wav` (Provide audio with a maximum of nine channels.) * `audio/webm` (The service automatically detects the codec of the input audio.) * `audio/webm;codecs=opus` * `audio/webm;codecs=vorbis` All data parts must have the same audio format. For information about the supported audio formats, including specifying the sampling rate, channels, and endianness for the indicated formats, see [Audio formats] (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-audio-formats). The information includes links to a number of Internet sites that provide technical and usage details about the different formats.

Returns:

the partContentType

dataPartsCount

public java.lang.Long dataPartsCount()

Gets the dataPartsCount. The number of audio data parts (audio files) sent with the request. Server-side end-of-stream detection is applied to the last (and possibly the only) data part. If omitted, the number of parts is determined from the request itself.

Returns:

the dataPartsCount

sequenceId

public java.lang.Long sequenceId()

Gets the sequenceId. The sequence ID for all data parts of this recognition task in the form of a user-specified integer. If omitted, no sequence ID is associated with the recognition task. Used only for session-based requests.

Returns:

the sequenceId

inactivityTimeout

public java.lang.Long inactivityTimeout()

Gets the inactivityTimeout. The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is closed with a 400 error and, for session-based methods, with `session_closed` set to `true`. Useful for stopping audio submission from a live microphone when a user simply walks away. Use `-1` for infinity.

Returns:

the inactivityTimeout

keywords

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

Gets the keywords. Array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are spotted only in the final hypothesis, not in interim results (if supported by the method). If you specify any keywords, you must also specify a keywords threshold. Omit the parameter or specify an empty array if you do not need to spot keywords.

Returns:

the keywords

keywordsThreshold

public java.lang.Float keywordsThreshold()

Gets the keywordsThreshold. Confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword spotting is performed if you omit the parameter. If you specify a threshold, you must also specify one or more keywords.

Returns:

the keywordsThreshold

maxAlternatives

public java.lang.Long maxAlternatives()

Gets the maxAlternatives. Maximum number of alternative transcripts to be returned. By default, a single transcription is returned.

Returns:

the maxAlternatives

wordAlternativesThreshold

public java.lang.Float wordAlternativesThreshold()

Gets the wordAlternativesThreshold. Confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known as \"Confusion Networks\"). An alternative word is considered if its confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the parameter.

Returns:

the wordAlternativesThreshold

wordConfidence

public java.lang.Boolean wordConfidence()

Gets the wordConfidence. If `true`, a confidence measure in the range 0 to 1 is returned for each word.

Returns:

the wordConfidence

timestamps

public java.lang.Boolean timestamps()

Gets the timestamps. If `true`, time alignment for each word is returned.

Returns:

the timestamps

profanityFilter

public java.lang.Boolean profanityFilter()

Gets the profanityFilter. If `true` (the default), 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.

Returns:

the profanityFilter

smartFormatting

public java.lang.Boolean smartFormatting()

Gets the 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.

Returns:

the smartFormatting

speakerLabels

public java.lang.Boolean speakerLabels()

Gets the speakerLabels. Indicates whether labels that identify which words were spoken by which participants in a multi-person exchange are to be included in the response. The default is `false`; no speaker labels are returned. Setting `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter.\n\n To determine whether a language model supports speaker labels, use the `GET /v1/models` method and check that the attribute `speaker_labels` is set to `true`. You can also refer to [Speaker labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#speaker_labels).

Returns:

the speakerLabels