RecognizeOptions (ibm-watson 7.3.0 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.model.GenericModel
- - com.ibm.watson.speech_to_text.v1.model.RecognizeOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel
```
public class RecognizeOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
```
The recognize options.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RecognizeOptions.Builder` Builder.
`static interface`	`RecognizeOptions.ContentType` The format (MIME type) of the audio.
`static interface`	`RecognizeOptions.Model` The identifier of the model that is to be used for the recognition request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`acousticCustomizationId()` Gets the acousticCustomizationId.
`java.io.InputStream`	`audio()` Gets the audio.
`java.lang.Boolean`	`audioMetrics()` Gets the audioMetrics.
`java.lang.String`	`baseModelVersion()` Gets the baseModelVersion.
`java.lang.String`	`contentType()` Gets the contentType.
`java.lang.String`	`customizationId()` Gets the customizationId.
`java.lang.Double`	`customizationWeight()` Gets the customizationWeight.
`java.lang.String`	`grammarName()` Gets the grammarName.
`java.lang.Long`	`inactivityTimeout()` Gets the inactivityTimeout.
`java.lang.Boolean`	`interimResults()` Gets the interimResults.
`java.util.List<java.lang.String>`	`keywords()` Gets the keywords.
`java.lang.Float`	`keywordsThreshold()` Gets the keywordsThreshold.
`java.lang.String`	`languageCustomizationId()` Gets the languageCustomizationId.
`java.lang.Long`	`maxAlternatives()` Gets the maxAlternatives.
`java.lang.String`	`model()` Gets the model.
`RecognizeOptions.Builder`	`newBuilder()` New builder.
`java.lang.Boolean`	`processingMetrics()` Gets the processingMetrics.
`java.lang.Float`	`processingMetricsInterval()` Gets the processingMetricsInterval.
`java.lang.Boolean`	`profanityFilter()` Gets the profanityFilter.
`java.lang.Boolean`	`redaction()` Gets the redaction.
`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 RecognizeOptions.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a RecognizeOptions builder
  - audio
```
public java.io.InputStream audio()
```
    Gets the audio. The audio to transcribe.
    
    Returns:
    
    the audio
  - model
```
public java.lang.String model()
```
    Gets the model. The identifier of the model that is to be used for the recognition request. See [Languages and models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-models#models).
    
    Returns:
    
    the model
  - languageCustomizationId
```
public java.lang.String languageCustomizationId()
```
    Gets the languageCustomizationId. The customization ID (GUID) of a custom language model that is to be used with the recognition request. The base model of the specified custom language model must match the model specified with the `model` parameter. You must make the request with credentials for the instance of the service that owns the custom model. By default, no custom language model is used. See [Custom models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input). **Note:** Use this parameter instead of the deprecated `customization_id` parameter.
    
    Returns:
    
    the languageCustomizationId
  - acousticCustomizationId
```
public java.lang.String acousticCustomizationId()
```
    Gets the acousticCustomizationId. The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request. The base model of the specified custom acoustic model must match the model specified with the `model` parameter. You must make the request with credentials for the instance of the service that owns the custom model. By default, no custom acoustic model is used. See [Custom models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
    
    Returns:
    
    the acousticCustomizationId
  - baseModelVersion
```
public java.lang.String baseModelVersion()
```
    Gets the baseModelVersion. The version of the specified base model that is to be used with the recognition request. Multiple versions of a base model can exist when a model is updated for internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. See [Base model version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#version).
    
    Returns:
    
    the baseModelVersion
  - customizationWeight
```
public java.lang.Double customizationWeight()
```
    Gets the customizationWeight. If you specify the customization ID (GUID) of a custom language model with the recognition request, the customization weight tells the service how much weight to give to words from the custom language model compared to those from the base model for the current request. Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified when the custom model was trained. The default value yields the best performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy of phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases. See [Custom models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#custom-input).
    
    Returns:
    
    the customizationWeight
  - inactivityTimeout
```
public java.lang.Long inactivityTimeout()
```
    Gets the inactivityTimeout. The time in seconds after which, if only silence (no speech) is detected in streaming audio, the connection is closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user simply walks away. Use `-1` for infinity. See [Inactivity timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#timeouts-inactivity).
    
    Returns:
    
    the inactivityTimeout
  - keywords
```
public java.util.List<java.lang.String> keywords()
```
    Gets the keywords. An array of keyword strings to spot in the audio. Each keyword string can include one or more string tokens. Keywords are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do not need to spot keywords. See [Keyword spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#keyword_spotting).
    
    Returns:
    
    the keywords
  - keywordsThreshold
```
public java.lang.Float keywordsThreshold()
```
    Gets the keywordsThreshold. A 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.0 and 1.0. If you specify a threshold, you must also specify one or more keywords. The service performs no keyword spotting if you omit either parameter. See [Keyword spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#keyword_spotting).
    
    Returns:
    
    the keywordsThreshold
  - maxAlternatives
```
public java.lang.Long maxAlternatives()
```
    Gets the maxAlternatives. The maximum number of alternative transcripts that the service is to return. By default, the service returns a single transcript. If you specify a value of `0`, the service uses the default value, `1`. See [Maximum alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#max_alternatives).
    
    Returns:
    
    the maxAlternatives
  - wordAlternativesThreshold
```
public java.lang.Float wordAlternativesThreshold()
```
    Gets the wordAlternativesThreshold. A 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.0 and 1.0. By default, the service computes no alternative words. See [Word alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_alternatives).
    
    Returns:
    
    the wordAlternativesThreshold
  - wordConfidence
```
public java.lang.Boolean wordConfidence()
```
    Gets the wordConfidence. If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for each word. By default, the service returns no word confidence scores. See [Word confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_confidence).
    
    Returns:
    
    the wordConfidence
  - timestamps
```
public java.lang.Boolean timestamps()
```
    Gets the timestamps. If `true`, the service returns time alignment for each word. By default, no timestamps are returned. See [Word timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#word_timestamps).
    
    Returns:
    
    the timestamps
  - profanityFilter
```
public java.lang.Boolean profanityFilter()
```
    Gets the profanityFilter. If `true`, the service 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. See [Profanity filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#profanity_filter).
    
    Returns:
    
    the profanityFilter
  - smartFormatting
```
public java.lang.Boolean smartFormatting()
```
    Gets the smartFormatting. If `true`, the service 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. For US English, the service also converts certain keyword strings to punctuation symbols. By default, the service performs no smart formatting. **Note:** Applies to US English, Japanese, and Spanish transcription only. See [Smart formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#smart_formatting).
    
    Returns:
    
    the smartFormatting
  - speakerLabels
```
public java.lang.Boolean speakerLabels()
```
    Gets the speakerLabels. If `true`, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, the service returns no speaker labels. Setting `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter. **Note:** Applies to US English, Japanese, and Spanish transcription only. To determine whether a language model supports speaker labels, you can also use the **Get a model** method and check that the attribute `speaker_labels` is set to `true`. See [Speaker labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#speaker_labels).
    
    Returns:
    
    the speakerLabels
  - customizationId
```
public java.lang.String customizationId()
```
    Gets the customizationId. **Deprecated.** Use the `language_customization_id` parameter to specify the customization ID (GUID) of a custom language model that is to be used with the recognition request. Do not specify both parameters with a request.
    
    Returns:
    
    the customizationId
  - grammarName
```
public java.lang.String grammarName()
```
    Gets the grammarName. The name of a grammar that is to be used with the recognition request. If you specify a grammar, you must also use the `language_customization_id` parameter to specify the name of the custom language model for which the grammar is defined. The service recognizes only strings that are recognized by the specified grammar; it does not recognize other custom words from the model's words resource. See [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-input#grammars-input).
    
    Returns:
    
    the grammarName
  - redaction
```
public java.lang.Boolean redaction()
```
    Gets the redaction. If `true`, the service redacts, or masks, numeric data from final transcripts. The feature redacts any number that has three or more consecutive digits by replacing each digit with an `X` character. It is intended to redact sensitive numeric data, such as credit card numbers. By default, the service performs no redaction. When you enable redaction, the service automatically enables smart formatting, regardless of whether you explicitly disable that feature. To ensure maximum security, the service also disables keyword spotting (ignores the `keywords` and `keywords_threshold` parameters) and returns only a single final transcript (forces the `max_alternatives` parameter to be `1`). **Note:** Applies to US English, Japanese, and Korean transcription only. See [Numeric redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-output#redaction).
    
    Returns:
    
    the redaction
  - audioMetrics
```
public java.lang.Boolean audioMetrics()
```
    Gets the audioMetrics. If `true`, requests detailed information about the signal characteristics of the input audio. The service returns audio metrics with the final transcription results. By default, the service returns no audio metrics.
    
    Returns:
    
    the audioMetrics
  - contentType
```
public java.lang.String contentType()
```
    Gets the contentType. The format (MIME type) of the audio. For more information about specifying an audio format, see **Audio formats (content types)** in the method description.
    
    Returns:
    
    the contentType
  - 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

Class RecognizeOptions

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

newBuilder

audio

model

languageCustomizationId

acousticCustomizationId

baseModelVersion

customizationWeight

inactivityTimeout

keywords

keywordsThreshold

maxAlternatives

wordAlternativesThreshold

wordConfidence

timestamps

profanityFilter

smartFormatting

speakerLabels

customizationId

grammarName

redaction

audioMetrics

contentType

interimResults

processingMetrics

processingMetricsInterval