com.ibm.watson.developer_cloud.speech_to_text.v1.model

Class CreateJobOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.speech_to_text.v1.model.CreateJobOptions

All Implemented Interfaces:

ObjectModel

public class CreateJobOptions
extends GenericModel

The createJob options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateJobOptions.Builder Builder.
static interface	CreateJobOptions.ContentType The format (MIME type) of the audio.
static interface	CreateJobOptions.Events If the job includes a callback URL, a comma-separated list of notification events to which to subscribe.
static interface	CreateJobOptions.Model The identifier of the model that is to be used for the recognition request.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	acousticCustomizationId() Gets the acousticCustomizationId.
java.io.InputStream	audio() Gets the audio.
java.lang.String	baseModelVersion() Gets the baseModelVersion.
java.lang.String	callbackUrl() Gets the callbackUrl.
java.lang.String	contentType() Gets the contentType.
java.lang.String	customizationId() Deprecated. Use the `languageCustomizationId` getter to get the customization ID (GUID) of a custom language model that is to be used with the recognition request.
java.lang.Double	customizationWeight() Gets the customizationWeight.
java.lang.String	events() Gets the events.
java.lang.String	grammarName() Gets the grammarName.
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.String	languageCustomizationId() Gets the languageCustomizationId.
java.lang.Long	maxAlternatives() Gets the maxAlternatives.
java.lang.String	model() Gets the model.
CreateJobOptions.Builder	newBuilder() New builder.
java.lang.Boolean	profanityFilter() Gets the profanityFilter.
java.lang.Boolean	redaction() Gets the redaction.
java.lang.Long	resultsTtl() Gets the resultsTtl.
java.lang.Boolean	smartFormatting() Gets the smartFormatting.
java.lang.Boolean	speakerLabels() Gets the speakerLabels.
java.lang.Boolean	timestamps() Gets the timestamps.
java.lang.String	userToken() Gets the userToken.
java.lang.Float	wordAlternativesThreshold() Gets the wordAlternativesThreshold.
java.lang.Boolean	wordConfidence() Gets the wordConfidence.

Methods inherited from class com.ibm.watson.developer_cloud.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 CreateJobOptions.Builder newBuilder()

New builder.

Returns:

a CreateJobOptions builder

audio

public java.io.InputStream audio()

Gets the audio. The audio to transcribe.

Returns:

the audio

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

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/models.html).

Returns:

the model

callbackUrl

public java.lang.String callbackUrl()

Gets the callbackUrl. A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using the **Register a callback** method. You can include the same callback URL with any number of job creation requests. Omit the parameter to poll the service for job completion and results. Use the `user_token` parameter to specify a unique user-specified string with each job to differentiate the callback notifications for the jobs.

Returns:

the callbackUrl

events

public java.lang.String events()

Gets the events. If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid events are * `recognitions.started` generates a callback notification when the service begins to process the job. * `recognitions.completed` generates a callback notification when the job is complete. You must use the **Check a job** method to retrieve the results before they time out or are deleted. * `recognitions.completed_with_results` generates a callback notification when the job is complete. The notification includes the results of the request. * `recognitions.failed` generates a callback notification if the service experiences an error while processing the job. The `recognitions.completed` and `recognitions.completed_with_results` events are incompatible. You can specify only of the two events. If the job includes a callback URL, omit the parameter to subscribe to the default events: `recognitions.started`, `recognitions.completed`, and `recognitions.failed`. If the job does not include a callback URL, omit the parameter.

Returns:

the events

userToken

public java.lang.String userToken()

Gets the userToken. If the job includes a callback URL, a user-specified string that the service is to include with each callback notification for the job; the token allows the user to maintain an internal mapping between jobs and notification events. If the job does not include a callback URL, omit the parameter.

Returns:

the userToken

resultsTtl

public java.lang.Long resultsTtl()

Gets the resultsTtl. The number of minutes for which the results are to be available after the job has finished. If not delivered via a callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. The parameter is valid with or without a callback URL.

Returns:

the resultsTtl

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/input.html#custom). **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/input.html#custom).

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 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/input.html#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/input.html#custom).

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 submitted 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 [Timeouts](https://cloud.ibm.com/docs/services/speech-to-text/input.html#timeouts).

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/output.html#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/output.html#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. See [Maximum alternatives](https://cloud.ibm.com/docs/services/speech-to-text/output.html#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/output.html#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/output.html#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/output.html#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/output.html#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/output.html#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/output.html#speaker_labels).

Returns:

the speakerLabels

customizationId

public java.lang.String customizationId()

Deprecated. Use the `languageCustomizationId` getter to get the customization ID (GUID) of a custom language model that is to be used with the recognition request.

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/output.html).

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/output.html#redaction).

Returns:

the redaction