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

Class AddAudioOptions

java.lang.Object

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

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

All Implemented Interfaces:

ObjectModel

public class AddAudioOptions
extends GenericModel

The addAudio options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddAudioOptions.Builder Builder.
static interface	AddAudioOptions.ContainedContentType For an archive-type resource that contains audio files whose format is not `audio/wav`, specifies the format of the audio files.
static interface	AddAudioOptions.ContentType The type of the input: application/zip, application/gzip, audio/basic, audio/flac, audio/l16, audio/mp3, audio/mpeg, audio/mulaw, audio/ogg, audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or audio/webm;codecs=vorbis.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	allowOverwrite() Gets the allowOverwrite.
java.lang.String	audioName() Gets the audioName.
java.io.InputStream	audioResource() Gets the audioResource.
java.lang.String	containedContentType() Gets the containedContentType.
java.lang.String	contentType() Gets the contentType.
java.lang.String	customizationId() Gets the customizationId.
AddAudioOptions.Builder	newBuilder() New builder.

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 AddAudioOptions.Builder newBuilder()

New builder.

Returns:

a AddAudioOptions builder

customizationId

public java.lang.String customizationId()

Gets the customizationId. The GUID of the custom acoustic model to which an audio resource is to be added. You must make the request with service credentials created for the instance of the service that owns the custom model.

Returns:

the customizationId

audioName

public java.lang.String audioName()

Gets the audioName. The name of the audio resource that is to be added to the custom acoustic model. The name cannot contain spaces. Use a localized name that matches the language of the custom model.

Returns:

the audioName

audioResource

public java.io.InputStream audioResource()

Gets the audioResource.

Returns:

the audioResource

contentType

public java.lang.String contentType()

Gets the contentType. The type of the input: application/zip, application/gzip, audio/basic, audio/flac, audio/l16, audio/mp3, audio/mpeg, audio/mulaw, audio/ogg, audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or audio/webm;codecs=vorbis.

Returns:

the contentType

containedContentType

public java.lang.String containedContentType()

Gets the containedContentType. For an archive-type resource that contains audio files whose format is not `audio/wav`, specifies the format of the audio files. The header accepts all of the audio formats supported for use with speech recognition and with the `Content-Type` header, including the `rate`, `channels`, and `endianness` parameters that are used with some formats. For a complete list of supported audio formats, see [Audio formats](/docs/services/speech-to-text/input.html#formats).

Returns:

the containedContentType

allowOverwrite

public java.lang.Boolean allowOverwrite()

Gets the allowOverwrite. Indicates whether the specified audio resource is to overwrite an existing resource with the same name. If a resource with the same name already exists, the request fails unless `allow_overwrite` is set to `true`; by default, the parameter is `false`. The parameter has no effect if a resource with the same name does not already exist.

Returns:

the allowOverwrite