SpeechToText (parent 5.1.0 API)

java.lang.Object
- com.ibm.watson.developer_cloud.service.WatsonService
- - com.ibm.watson.developer_cloud.speech_to_text.v1.SpeechToText

```
public class SpeechToText
extends WatsonService
```
The Speech to Text service uses IBM's speech recognition capabilities to convert English speech into text. The transcription of incoming audio is continuously sent back to the client with minimal delay, and it is corrected as more speech is heard.

See Also:

Speech to Text

Field Summary
- Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService
  defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors
Constructor and Description
`SpeechToText()` Instantiates a new `SpeechToText`.
`SpeechToText(java.lang.String username, java.lang.String password)` Instantiates a new `SpeechToText` with username and password.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceCall<java.lang.Void>`	`addAudio(AddAudioOptions addAudioOptions)` Adds an audio resource to a custom acoustic model.
`ServiceCall<java.lang.Void>`	`addCorpus(AddCorpusOptions addCorpusOptions)` Adds a corpus text file to a custom language model.
`ServiceCall<java.lang.Void>`	`addWord(AddWordOptions addWordOptions)` Adds a custom word to a custom language model.
`ServiceCall<java.lang.Void>`	`addWords(AddWordsOptions addWordsOptions)` Adds one or more custom words to a custom language model.
`ServiceCall<RecognitionJob>`	`checkJob(CheckJobOptions checkJobOptions)` Checks the status of the specified asynchronous job.
`ServiceCall<RecognitionJobs>`	`checkJobs()` Checks the status of all asynchronous jobs.
`ServiceCall<RecognitionJobs>`	`checkJobs(CheckJobsOptions checkJobsOptions)` Checks the status of all asynchronous jobs.
`ServiceCall<AcousticModel>`	`createAcousticModel(CreateAcousticModelOptions createAcousticModelOptions)` Creates a custom acoustic model.
`ServiceCall<RecognitionJob>`	`createJob(CreateJobOptions createJobOptions)` Creates a job for an asynchronous recognition request.
`ServiceCall<LanguageModel>`	`createLanguageModel(CreateLanguageModelOptions createLanguageModelOptions)` Creates a custom language model.
`ServiceCall<java.lang.Void>`	`deleteAcousticModel(DeleteAcousticModelOptions deleteAcousticModelOptions)` Deletes a custom acoustic model.
`ServiceCall<java.lang.Void>`	`deleteAudio(DeleteAudioOptions deleteAudioOptions)` Deletes an audio resource from a custom acoustic model.
`ServiceCall<java.lang.Void>`	`deleteCorpus(DeleteCorpusOptions deleteCorpusOptions)` Deletes a corpus from a custom language model.
`ServiceCall<java.lang.Void>`	`deleteJob(DeleteJobOptions deleteJobOptions)` Deletes the specified asynchronous job.
`ServiceCall<java.lang.Void>`	`deleteLanguageModel(DeleteLanguageModelOptions deleteLanguageModelOptions)` Deletes a custom language model.
`ServiceCall<java.lang.Void>`	`deleteWord(DeleteWordOptions deleteWordOptions)` Deletes a custom word from a custom language model.
`ServiceCall<AcousticModel>`	`getAcousticModel(GetAcousticModelOptions getAcousticModelOptions)` Lists information about a custom acoustic model.
`ServiceCall<AudioListing>`	`getAudio(GetAudioOptions getAudioOptions)` Lists information about an audio resource for a custom acoustic model.
`ServiceCall<Corpus>`	`getCorpus(GetCorpusOptions getCorpusOptions)` Lists information about a corpus for a custom language model.
`ServiceCall<LanguageModel>`	`getLanguageModel(GetLanguageModelOptions getLanguageModelOptions)` Lists information about a custom language model.
`ServiceCall<SpeechModel>`	`getModel(GetModelOptions getModelOptions)` Retrieves information about the model.
`ServiceCall<Word>`	`getWord(GetWordOptions getWordOptions)` Lists a custom word from a custom language model.
`ServiceCall<AcousticModels>`	`listAcousticModels()` Lists information about all custom acoustic models.
`ServiceCall<AcousticModels>`	`listAcousticModels(ListAcousticModelsOptions listAcousticModelsOptions)` Lists information about all custom acoustic models.
`ServiceCall<AudioResources>`	`listAudio(ListAudioOptions listAudioOptions)` Lists information about all audio resources for a custom acoustic model.
`ServiceCall<Corpora>`	`listCorpora(ListCorporaOptions listCorporaOptions)` Lists information about all corpora for a custom language model.
`ServiceCall<LanguageModels>`	`listLanguageModels()` Lists information about all custom language models.
`ServiceCall<LanguageModels>`	`listLanguageModels(ListLanguageModelsOptions listLanguageModelsOptions)` Lists information about all custom language models.
`ServiceCall<SpeechModels>`	`listModels()` Retrieves the models available for the service.
`ServiceCall<SpeechModels>`	`listModels(ListModelsOptions listModelsOptions)` Retrieves the models available for the service.
`ServiceCall<Words>`	`listWords(ListWordsOptions listWordsOptions)` Lists all custom words from a custom language model.
`ServiceCall<SpeechRecognitionResults>`	`recognize(RecognizeOptions recognizeOptions)` Recognizes an audio file and returns `SpeechRecognitionResults`. Here is an example of how to recognize an audio file:
`okhttp3.WebSocket`	`recognizeUsingWebSocket(RecognizeOptions recognizeOptions, RecognizeCallback callback)` Sends audio and returns transcription results for recognition requests over a WebSocket connection.
`ServiceCall<RegisterStatus>`	`registerCallback(RegisterCallbackOptions registerCallbackOptions)` Registers a callback URL for use with the asynchronous interface.
`ServiceCall<java.lang.Void>`	`resetAcousticModel(ResetAcousticModelOptions resetAcousticModelOptions)` Resets a custom acoustic model.
`ServiceCall<java.lang.Void>`	`resetLanguageModel(ResetLanguageModelOptions resetLanguageModelOptions)` Resets a custom language model.
`ServiceCall<java.lang.Void>`	`trainAcousticModel(TrainAcousticModelOptions trainAcousticModelOptions)` Trains a custom acoustic model.
`ServiceCall<java.lang.Void>`	`trainLanguageModel(TrainLanguageModelOptions trainLanguageModelOptions)` Trains a custom language model.
`ServiceCall<java.lang.Void>`	`unregisterCallback(UnregisterCallbackOptions unregisterCallbackOptions)` Removes the registration for an asynchronous callback URL.
`ServiceCall<java.lang.Void>`	`upgradeAcousticModel(UpgradeAcousticModelOptions upgradeAcousticModelOptions)` Upgrades a custom acoustic model.
`ServiceCall<java.lang.Void>`	`upgradeLanguageModel(UpgradeLanguageModelOptions upgradeLanguageModelOptions)` Upgrades a custom language model.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService
configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SpeechToText
```
public SpeechToText()
```
    Instantiates a new `SpeechToText`.
  - SpeechToText
```
public SpeechToText(java.lang.String username,
                    java.lang.String password)
```
    Instantiates a new `SpeechToText` with username and password.
    
    Parameters:
    
    username - the username
    
    password - the password
- Method Detail
  - getModel
```
public ServiceCall<SpeechModel> getModel(GetModelOptions getModelOptions)
```
    Retrieves information about the model. Returns information about a single specified language model that is available for use with the service. The information includes the name of the model and its minimum sampling rate in Hertz, among other things.
    
    Parameters:
    
    getModelOptions - the GetModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of SpeechModel
  - listModels
```
public ServiceCall<SpeechModels> listModels(ListModelsOptions listModelsOptions)
```
    Retrieves the models available for the service. Returns a list of all language models that are available for use with the service. The information includes the name of the model and its minimum sampling rate in Hertz, among other things.
    
    Parameters:
    
    listModelsOptions - the ListModelsOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of SpeechModels
  - listModels
```
public ServiceCall<SpeechModels> listModels()
```
    Retrieves the models available for the service. Returns a list of all language models that are available for use with the service. The information includes the name of the model and its minimum sampling rate in Hertz, among other things.
    
    Returns:
    
    a ServiceCall with a response type of SpeechModels
  - recognize
```
public ServiceCall<SpeechRecognitionResults> recognize(RecognizeOptions recognizeOptions)
```
    Recognizes an audio file and returns SpeechRecognitionResults.
    
    Here is an example of how to recognize an audio file:
```
 SpeechToText service = new SpeechToText();
 service.setUsernameAndPassword("USERNAME", "PASSWORD");
 service.setEndPoint("SERVICE_URL");

 RecognizeOptions options = new RecognizeOptions().maxAlternatives(3).continuous(true);

 File audio = new File("sample1.wav");

 SpeechResults results = service.recognize(audio, options).execute();
 System.out.println(results);
 
```
    Parameters:
    
    recognizeOptions - the recognize options
    
    Returns:
    
    the SpeechRecognitionResults
  - recognizeUsingWebSocket
```
public okhttp3.WebSocket recognizeUsingWebSocket(RecognizeOptions recognizeOptions,
                                                 RecognizeCallback callback)
```
    Sends audio and returns transcription results for recognition requests over a WebSocket connection. Requests and responses are enabled over a single TCP connection that abstracts much of the complexity of the request to offer efficient implementation, low latency, high throughput, and an asynchronous response. By default, only final results are returned for any request; to enable interim results, set the interimResults parameter to true. The service imposes a data size limit of 100 MB per utterance (per recognition request). You can send multiple utterances over a single WebSocket connection. The service automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding. (For the audio/l16 format, you can specify the endianness.)
    
    Parameters:
    
    recognizeOptions - the recognize options
    
    callback - the RecognizeCallback instance where results will be sent
    
    Returns:
    
    the WebSocket
  - checkJob
```
public ServiceCall<RecognitionJob> checkJob(CheckJobOptions checkJobOptions)
```
    Checks the status of the specified asynchronous job. Returns information about the specified job. The response always includes the status of the job and its creation and update times. If the status is `completed`, the response includes the results of the recognition request. You must submit the request with the service credentials of the user who created the job. You can use the method to retrieve the results of any job, regardless of whether it was submitted with a callback URL and the `recognitions.completed_with_results` event, and you can retrieve the results multiple times for as long as they remain available.
    
    Parameters:
    
    checkJobOptions - the CheckJobOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of RecognitionJob
  - checkJobs
```
public ServiceCall<RecognitionJobs> checkJobs(CheckJobsOptions checkJobsOptions)
```
    Checks the status of all asynchronous jobs. Returns the ID and status of the latest 100 outstanding jobs associated with the service credentials with which it is called. The method also returns the creation and update times of each job, and, if a job was created with a callback URL and a user token, the user token for the job. To obtain the results for a job whose status is `completed` or not one of the latest 100 outstanding jobs, use the `GET /v1/recognitions/{id}` method. A job and its results remain available until you delete them with the `DELETE /v1/recognitions/{id}` method or until the job's time to live expires, whichever comes first.
    
    Parameters:
    
    checkJobsOptions - the CheckJobsOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of RecognitionJobs
  - checkJobs
```
public ServiceCall<RecognitionJobs> checkJobs()
```
    Checks the status of all asynchronous jobs. Returns the ID and status of the latest 100 outstanding jobs associated with the service credentials with which it is called. The method also returns the creation and update times of each job, and, if a job was created with a callback URL and a user token, the user token for the job. To obtain the results for a job whose status is `completed` or not one of the latest 100 outstanding jobs, use the `GET /v1/recognitions/{id}` method. A job and its results remain available until you delete them with the `DELETE /v1/recognitions/{id}` method or until the job's time to live expires, whichever comes first.
    
    Returns:
    
    a ServiceCall with a response type of RecognitionJobs
  - createJob
```
public ServiceCall<RecognitionJob> createJob(CreateJobOptions createJobOptions)
```
    Creates a job for an asynchronous recognition request. Creates a job for a new asynchronous recognition request. The job is owned by the user whose service credentials are used to create it. How you learn the status and results of a job depends on the parameters you include with the job creation request: * By callback notification: Include the `callback_url` query parameter to specify a URL to which the service is to send callback notifications when the status of the job changes. Optionally, you can also include the `events` and `user_token` query parameters to subscribe to specific events and to specify a string that is to be included with each notification for the job. * By polling the service: Omit the `callback_url`, `events`, and `user_token` query parameters. You must then use the `GET /v1/recognitions` or `GET /v1/recognitions/{id}` methods to check the status of the job, using the latter to retrieve the results when the job is complete. The two approaches are not mutually exclusive. You can poll the service for job status or obtain results from the service manually even if you include a callback URL. In both cases, you can include the `results_ttl` parameter to specify how long the results are to remain available after the job is complete. Note that using the HTTPS `GET /v1/recognitions/{id}` method to retrieve results is more secure than receiving them via callback notification over HTTP because it provides confidentiality in addition to authentication and data integrity. The method supports the same basic parameters as other HTTP and WebSocket recognition requests. The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding. (For the `audio/l16` format, you can specify the endianness.).
    
    Parameters:
    
    createJobOptions - the CreateJobOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of RecognitionJob
  - deleteJob
```
public ServiceCall<java.lang.Void> deleteJob(DeleteJobOptions deleteJobOptions)
```
    Deletes the specified asynchronous job. Deletes the specified job. You cannot delete a job that the service is actively processing. Once you delete a job, its results are no longer available. The service automatically deletes a job and its results when the time to live for the results expires. You must submit the request with the service credentials of the user who created the job.
    
    Parameters:
    
    deleteJobOptions - the DeleteJobOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - registerCallback
```
public ServiceCall<RegisterStatus> registerCallback(RegisterCallbackOptions registerCallbackOptions)
```
    Registers a callback URL for use with the asynchronous interface. Registers a callback URL with the service for use with subsequent asynchronous recognition requests. The service attempts to register, or white-list, the callback URL if it is not already registered by sending a `GET` request to the callback URL. The service passes a random alphanumeric challenge string via the `challenge_string` query parameter of the request. The request includes an `Accept` header that specifies `text/plain` as the required response type. To be registered successfully, the callback URL must respond to the `GET` request from the service. The response must send status code 200 and must include the challenge string in its body. Set the `Content-Type` response header to `text/plain`. Upon receiving this response, the service responds to the original `POST` registration request with response code 201. The service sends only a single `GET` request to the callback URL. If the service does not receive a reply with a response code of 200 and a body that echoes the challenge string sent by the service within five seconds, it does not white-list the URL; it instead sends status code 400 in response to the `POST` registration request. If the requested callback URL is already white-listed, the service responds to the initial registration request with response code 200. If you specify a user secret with the request, the service uses it as a key to calculate an HMAC-SHA1 signature of the challenge string in its response to the `POST` request. It sends this signature in the `X-Callback-Signature` header of its `GET` request to the URL during registration. It also uses the secret to calculate a signature over the payload of every callback notification that uses the URL. The signature provides authentication and data integrity for HTTP communications. Once you successfully register a callback URL, you can use it with an indefinite number of recognition requests. You can register a maximum of 20 callback URLS in a one-hour span of time. For more information, see [Registering a callback URL](https://console.bluemix.net/docs/services/speech-to-text/async.html#register).
    
    Parameters:
    
    registerCallbackOptions - the RegisterCallbackOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of RegisterStatus
  - unregisterCallback
```
public ServiceCall<java.lang.Void> unregisterCallback(UnregisterCallbackOptions unregisterCallbackOptions)
```
    Removes the registration for an asynchronous callback URL. Unregisters a callback URL that was previously white-listed with a `POST register_callback` request for use with the asynchronous interface. Once unregistered, the URL can no longer be used with asynchronous recognition requests.
    
    Parameters:
    
    unregisterCallbackOptions - the UnregisterCallbackOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - createLanguageModel
```
public ServiceCall<LanguageModel> createLanguageModel(CreateLanguageModelOptions createLanguageModelOptions)
```
    Creates a custom language model. Creates a new custom language model for a specified base model. The custom language model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to create it.
    
    Parameters:
    
    createLanguageModelOptions - the CreateLanguageModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of LanguageModel
  - deleteLanguageModel
```
public ServiceCall<java.lang.Void> deleteLanguageModel(DeleteLanguageModelOptions deleteLanguageModelOptions)
```
    Deletes a custom language model. Deletes an existing custom language model. The custom model cannot be deleted if another request, such as adding a corpus to the model, is currently being processed. You must use credentials for the instance of the service that owns a model to delete it.
    
    Parameters:
    
    deleteLanguageModelOptions - the DeleteLanguageModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - getLanguageModel
```
public ServiceCall<LanguageModel> getLanguageModel(GetLanguageModelOptions getLanguageModelOptions)
```
    Lists information about a custom language model. Lists information about a specified custom language model. You must use credentials for the instance of the service that owns a model to list information about it.
    
    Parameters:
    
    getLanguageModelOptions - the GetLanguageModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of LanguageModel
  - listLanguageModels
```
public ServiceCall<LanguageModels> listLanguageModels(ListLanguageModelsOptions listLanguageModelsOptions)
```
    Lists information about all custom language models. Lists information about all custom language models that are owned by an instance of the service. Use the `language` parameter to see all custom language models for the specified language; omit the parameter to see all custom language models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.
    
    Parameters:
    
    listLanguageModelsOptions - the ListLanguageModelsOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of LanguageModels
  - listLanguageModels
```
public ServiceCall<LanguageModels> listLanguageModels()
```
    Lists information about all custom language models. Lists information about all custom language models that are owned by an instance of the service. Use the `language` parameter to see all custom language models for the specified language; omit the parameter to see all custom language models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.
    
    Returns:
    
    a ServiceCall with a response type of LanguageModels
  - resetLanguageModel
```
public ServiceCall<java.lang.Void> resetLanguageModel(ResetLanguageModelOptions resetLanguageModelOptions)
```
    Resets a custom language model. Resets a custom language model by removing all corpora and words from the model. Resetting a custom language model initializes the model to its state when it was first created. Metadata such as the name and language of the model are preserved, but the model's words resource is removed and must be re-created. You must use credentials for the instance of the service that owns a model to reset it.
    
    Parameters:
    
    resetLanguageModelOptions - the ResetLanguageModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - trainLanguageModel
```
public ServiceCall<java.lang.Void> trainLanguageModel(TrainLanguageModelOptions trainLanguageModelOptions)
```
    Trains a custom language model. Initiates the training of a custom language model with new corpora, custom words, or both. After adding, modifying, or deleting corpora or words for a custom language model, use this method to begin the actual training of the model on the latest data. You can specify whether the custom language model is to be trained with all words from its words resource or only with words that were added or modified by the user. You must use credentials for the instance of the service that owns a model to train it. The training method is asynchronous. It can take on the order of minutes to complete depending on the amount of data on which the service is being trained and the current load on the service. The method returns an HTTP 200 response code to indicate that the training process has begun. You can monitor the status of the training by using the `GET /v1/customizations/{customization_id}` method to poll the model's status. Use a loop to check the status every 10 seconds. The method returns a `Customization` object that includes `status` and `progress` fields. A status of `available` means that the custom model is trained and ready to use. The service cannot accept subsequent training requests, or requests to add new corpora or words, until the existing request completes. Training can fail to start for the following reasons: * The service is currently handling another request for the custom model, such as another training request or a request to add a corpus or words to the model. * No training data (corpora or words) have been added to the custom model. * One or more words that were added to the custom model have invalid sounds-like pronunciations that you must fix.
    
    Parameters:
    
    trainLanguageModelOptions - the TrainLanguageModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - upgradeLanguageModel
```
public ServiceCall<java.lang.Void> upgradeLanguageModel(UpgradeLanguageModelOptions upgradeLanguageModelOptions)
```
    Upgrades a custom language model. Initiates the upgrade of a custom language model to the latest version of its base language model. The upgrade method is asynchronous. It can take on the order of minutes to complete depending on the amount of data in the custom model and the current load on the service. A custom model must be in the `ready` or `available` state to be upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the status of the upgrade by using the `GET /v1/customizations/{customization_id}` method to poll the model's status. Use a loop to check the status every 10 seconds. While it is being upgraded, the custom model has the status `upgrading`. When the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent requests for the model until the upgrade completes. For more information, see [Upgrading custom models](https://console.bluemix.net/docs/services/speech-to-text/custom-upgrade.html).
    
    Parameters:
    
    upgradeLanguageModelOptions - the UpgradeLanguageModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - addCorpus
```
public ServiceCall<java.lang.Void> addCorpus(AddCorpusOptions addCorpusOptions)
```
    Adds a corpus text file to a custom language model. Adds a single corpus text file of new training data to a custom language model. Use multiple requests to submit multiple corpus text files. You must use credentials for the instance of the service that owns a model to add a corpus to it. Note that adding a corpus does not affect the custom language model until you train the model for the new data by using the `POST /v1/customizations/{customization_id}/train` method. Submit a plain text file that contains sample sentences from the domain of interest to enable the service to extract words in context. The more sentences you add that represent the context in which speakers use words from the domain, the better the service's recognition accuracy. For guidelines about adding a corpus text file and for information about how the service parses a corpus file, see [Preparing a corpus text file](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#prepareCorpus). The call returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the contents of the corpus and automatically extracts new words that it finds. This can take on the order of a minute or two to complete depending on the total number of words and the number of new words in the corpus, as well as the current load on the service. You cannot submit requests to add additional corpora or words to the custom model, or to train the model, until the service's analysis of the corpus for the current request completes. Use the `GET /v1/customizations/{customization_id}/corpora/{corpus_name}` method to check the status of the analysis. The service auto-populates the model's words resource with any word that is not found in its base vocabulary; these are referred to as out-of-vocabulary (OOV) words. You can use the `GET /v1/customizations/{customization_id}/words` method to examine the words resource, using other words method to eliminate typos and modify how words are pronounced as needed. To add a corpus file that has the same name as an existing corpus, set the allow_overwrite query parameter to true; otherwise, the request fails. Overwriting an existing corpus causes the service to process the corpus text file and extract OOV words anew. Before doing so, it removes any OOV words associated with the existing corpus from the model's words resource unless they were also added by another corpus or they have been modified in some way with the `POST /v1/customizations/{customization_id}/words` or `PUT /v1/customizations/{customization_id}/words/{word_name}` method. The service limits the overall amount of data that you can add to a custom model to a maximum of 10 million total words from all corpora combined. Also, you can add no more than 30 thousand new custom words to a model; this includes words that the service extracts from corpora and words that you add directly.
    
    Parameters:
    
    addCorpusOptions - the AddCorpusOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - deleteCorpus
```
public ServiceCall<java.lang.Void> deleteCorpus(DeleteCorpusOptions deleteCorpusOptions)
```
    Deletes a corpus from a custom language model. Deletes an existing corpus from a custom language model. The service removes any out-of-vocabulary (OOV) words associated with the corpus from the custom model's words resource unless they were also added by another corpus or they have been modified in some way with the `POST /v1/customizations/{customization_id}/words` or `PUT /v1/customizations/{customization_id}/words/{word_name}` method. Removing a corpus does not affect the custom model until you train the model with the `POST /v1/customizations/{customization_id}/train` method. You must use credentials for the instance of the service that owns a model to delete its corpora.
    
    Parameters:
    
    deleteCorpusOptions - the DeleteCorpusOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - getCorpus
```
public ServiceCall<Corpus> getCorpus(GetCorpusOptions getCorpusOptions)
```
    Lists information about a corpus for a custom language model. Lists information about a corpus from a custom language model. The information includes the total number of words and out-of-vocabulary (OOV) words, name, and status of the corpus. You must use credentials for the instance of the service that owns a model to list its corpora.
    
    Parameters:
    
    getCorpusOptions - the GetCorpusOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Corpus
  - listCorpora
```
public ServiceCall<Corpora> listCorpora(ListCorporaOptions listCorporaOptions)
```
    Lists information about all corpora for a custom language model. Lists information about all corpora from a custom language model. The information includes the total number of words and out-of-vocabulary (OOV) words, name, and status of each corpus. You must use credentials for the instance of the service that owns a model to list its corpora.
    
    Parameters:
    
    listCorporaOptions - the ListCorporaOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Corpora
  - addWord
```
public ServiceCall<java.lang.Void> addWord(AddWordOptions addWordOptions)
```
    Adds a custom word to a custom language model. Adds a custom word to a custom language model. The service populates the words resource for a custom model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add additional words or to modify existing words in the words resource. You must use credentials for the instance of the service that owns a model to add or modify a custom word for the model. Adding or modifying a custom word does not affect the custom model until you train the model for the new data by using the `POST /v1/customizations/{customization_id}/train` method. Use the `word_name` path parameter to specify the custom word that is to be added or modified. Use the `CustomWord` object to provide one or both of the optional `sounds_like` and `display_as` fields for the word. * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound like `i triple e`. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation rules, see [Using the sounds_like field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#soundsLike). * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter when you want the word to appear different from its usual representation or from its spelling in corpora training data. For example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM`. For more information, see [Using the display_as field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#displayAs). If you add a custom word that already exists in the words resource for the custom model, the new definition overwrites the existing data for the word. If the service encounters an error, it does not add the word to the words resource. Use the `GET /v1/customizations/{customization_id}/words/{word_name}` method to review the word that you add.
    
    Parameters:
    
    addWordOptions - the AddWordOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - addWords
```
public ServiceCall<java.lang.Void> addWords(AddWordsOptions addWordsOptions)
```
    Adds one or more custom words to a custom language model. Adds one or more custom words to a custom language model. The service populates the words resource for a custom model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add additional words or to modify existing words in the words resource. You must use credentials for the instance of the service that owns a model to add or modify custom words for the model. Adding or modifying custom words does not affect the custom model until you train the model for the new data by using the `POST /v1/customizations/{customization_id}/train` method. You add custom words by providing a `Words` object, which is an array of `Word` objects, one per word. You must use the object's word parameter to identify the word that is to be added. You can also provide one or both of the optional `sounds_like` and `display_as` fields for each word. * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound like `i triple e`. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation rules, see [Using the sounds_like field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#soundsLike). * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter when you want the word to appear different from its usual representation or from its spelling in corpora training data. For example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM`. For more information, see [Using the display_as field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#displayAs). If you add a custom word that already exists in the words resource for the custom model, the new definition overwrites the existing data for the word. If the service encounters an error with the input data, it returns a failure code and does not add any of the words to the words resource. The call returns an HTTP 201 response code if the input data is valid. It then asynchronously processes the words to add them to the model's words resource. The time that it takes for the analysis to complete depends on the number of new words that you add but is generally faster than adding a corpus or training a model. You can monitor the status of the request by using the `GET /v1/customizations/{customization_id}` method to poll the model's status. Use a loop to check the status every 10 seconds. The method returns a `Customization` object that includes a `status` field. A status of `ready` means that the words have been added to the custom model. The service cannot accept requests to add new corpora or words or to train the model until the existing request completes. You can use the `GET /v1/customizations/{customization_id}/words` or `GET /v1/customizations/{customization_id}/words/{word_name}` method to review the words that you add. Words with an invalid `sounds_like` field include an `error` field that describes the problem. You can use other words methods to correct errors, eliminate typos, and modify how words are pronounced as needed.
    
    Parameters:
    
    addWordsOptions - the AddWordsOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - deleteWord
```
public ServiceCall<java.lang.Void> deleteWord(DeleteWordOptions deleteWordOptions)
```
    Deletes a custom word from a custom language model. Deletes a custom word from a custom language model. You can remove any word that you added to the custom model's words resource via any means. However, if the word also exists in the service's base vocabulary, the service removes only the custom pronunciation for the word; the word remains in the base vocabulary. Removing a custom word does not affect the custom model until you train the model with the `POST /v1/customizations/{customization_id}/train` method. You must use credentials for the instance of the service that owns a model to delete its words.
    
    Parameters:
    
    deleteWordOptions - the DeleteWordOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - getWord
```
public ServiceCall<Word> getWord(GetWordOptions getWordOptions)
```
    Lists a custom word from a custom language model. Lists information about a custom word from a custom language model. You must use credentials for the instance of the service that owns a model to query information about its words.
    
    Parameters:
    
    getWordOptions - the GetWordOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Word
  - listWords
```
public ServiceCall<Words> listWords(ListWordsOptions listWordsOptions)
```
    Lists all custom words from a custom language model. Lists information about custom words from a custom language model. You can list all words from the custom model's words resource, only custom words that were added or modified by the user, or only out-of-vocabulary (OOV) words that were extracted from corpora. You can also indicate the order in which the service is to return words; by default, words are listed in ascending alphabetical order. You must use credentials for the instance of the service that owns a model to query information about its words.
    
    Parameters:
    
    listWordsOptions - the ListWordsOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Words
  - createAcousticModel
```
public ServiceCall<AcousticModel> createAcousticModel(CreateAcousticModelOptions createAcousticModelOptions)
```
    Creates a custom acoustic model. Creates a new custom acoustic model for a specified base model. The custom acoustic model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to create it.
    
    Parameters:
    
    createAcousticModelOptions - the CreateAcousticModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of AcousticModel
  - deleteAcousticModel
```
public ServiceCall<java.lang.Void> deleteAcousticModel(DeleteAcousticModelOptions deleteAcousticModelOptions)
```
    Deletes a custom acoustic model. Deletes an existing custom acoustic model. The custom model cannot be deleted if another request, such as adding an audio resource to the model, is currently being processed. You must use credentials for the instance of the service that owns a model to delete it.
    
    Parameters:
    
    deleteAcousticModelOptions - the DeleteAcousticModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - getAcousticModel
```
public ServiceCall<AcousticModel> getAcousticModel(GetAcousticModelOptions getAcousticModelOptions)
```
    Lists information about a custom acoustic model. Lists information about a specified custom acoustic model. You must use credentials for the instance of the service that owns a model to list information about it.
    
    Parameters:
    
    getAcousticModelOptions - the GetAcousticModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of AcousticModel
  - listAcousticModels
```
public ServiceCall<AcousticModels> listAcousticModels(ListAcousticModelsOptions listAcousticModelsOptions)
```
    Lists information about all custom acoustic models. Lists information about all custom acoustic models that are owned by an instance of the service. Use the `language` parameter to see all custom acoustic models for the specified language; omit the parameter to see all custom acoustic models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.
    
    Parameters:
    
    listAcousticModelsOptions - the ListAcousticModelsOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of AcousticModels
  - listAcousticModels
```
public ServiceCall<AcousticModels> listAcousticModels()
```
    Lists information about all custom acoustic models. Lists information about all custom acoustic models that are owned by an instance of the service. Use the `language` parameter to see all custom acoustic models for the specified language; omit the parameter to see all custom acoustic models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.
    
    Returns:
    
    a ServiceCall with a response type of AcousticModels
  - resetAcousticModel
```
public ServiceCall<java.lang.Void> resetAcousticModel(ResetAcousticModelOptions resetAcousticModelOptions)
```
    Resets a custom acoustic model. Resets a custom acoustic model by removing all audio resources from the model. Resetting a custom acoustic model initializes the model to its state when it was first created. Metadata such as the name and language of the model are preserved, but the model's audio resources are removed and must be re-created. You must use credentials for the instance of the service that owns a model to reset it.
    
    Parameters:
    
    resetAcousticModelOptions - the ResetAcousticModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - trainAcousticModel
```
public ServiceCall<java.lang.Void> trainAcousticModel(TrainAcousticModelOptions trainAcousticModelOptions)
```
    Trains a custom acoustic model. Initiates the training of a custom acoustic model with new or changed audio resources. After adding or deleting audio resources for a custom acoustic model, use this method to begin the actual training of the model on the latest audio data. The custom acoustic model does not reflect its changed data until you train it. You must use credentials for the instance of the service that owns a model to train it. The training method is asynchronous. It can take on the order of minutes or hours to complete depending on the total amount of audio data on which the model is being trained and the current load on the service. Typically, training takes approximately two to four times the length of its audio data. The range of time depends on the model being trained and the nature of the audio, such as whether the audio is clean or noisy. The method returns an HTTP 200 response code to indicate that the training process has begun. You can monitor the status of the training by using the `GET /v1/acoustic_customizations/{customization_id}` method to poll the model's status. Use a loop to check the status once a minute. The method returns an `Customization` object that includes `status` and `progress` fields. A status of `available` indicates that the custom model is trained and ready to use. The service cannot accept subsequent training requests, or requests to add new audio resources, until the existing request completes. You can use the optional `custom_language_model_id` query parameter to specify the GUID of a separately created custom language model that is to be used during training. Specify a custom language model if you have verbatim transcriptions of the audio files that you have added to the custom model or you have either corpora (text files) or a list of words that are relevant to the contents of the audio files. For information about creating a separate custom language model, see [Creating a custom language model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html). Training can fail to start for the following reasons: * The service is currently handling another request for the custom model, such as another training request or a request to add audio resources to the model. * The custom model contains less than 10 minutes or more than 50 hours of audio data. * One or more of the custom model's audio resources is invalid.
    
    Parameters:
    
    trainAcousticModelOptions - the TrainAcousticModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - upgradeAcousticModel
```
public ServiceCall<java.lang.Void> upgradeAcousticModel(UpgradeAcousticModelOptions upgradeAcousticModelOptions)
```
    Upgrades a custom acoustic model. Initiates the upgrade of a custom acoustic model to the latest version of its base language model. The upgrade method is asynchronous. It can take on the order of minutes or hours to complete depending on the amount of data in the custom model and the current load on the service; typically, upgrade takes approximately twice the length of the total audio contained in the custom model. A custom model must be in the `ready` or `available` state to be upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the status of the upgrade by using the `GET /v1/acoustic_customizations/{customization_id}` method to poll the model's status. Use a loop to check the status once a minute. While it is being upgraded, the custom model has the status `upgrading`. When the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent requests for the model until the upgrade completes. If the custom acoustic model was trained with a separately created custom language model, you must use the `custom_language_model_id` query parameter to specify the GUID of that custom language model. The custom language model must be upgraded before the custom acoustic model can be upgraded. Omit the parameter if the custom acoustic model was not trained with a custom language model. For more information, see [Upgrading custom models](https://console.bluemix.net/docs/services/speech-to-text/custom-upgrade.html).
    
    Parameters:
    
    upgradeAcousticModelOptions - the UpgradeAcousticModelOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - addAudio
```
public ServiceCall<java.lang.Void> addAudio(AddAudioOptions addAudioOptions)
```
    Adds an audio resource to a custom acoustic model. Adds an audio resource to a custom acoustic model. Add audio content that reflects the acoustic characteristics of the audio that you plan to transcribe. You must use credentials for the instance of the service that owns a model to add an audio resource to it. Adding audio data does not affect the custom acoustic model until you train the model for the new data by using the `POST /v1/acoustic_customizations/{customization_id}/train` method. You can add individual audio files or an archive file that contains multiple audio files. Adding multiple audio files via a single archive file is significantly more efficient than adding each file individually. * You can add an individual audio file in any format that the service supports for speech recognition. Use the `Content-Type` header to specify the format of the audio file. * You can add an archive file (**.zip** or **.tar.gz** file) that contains audio files in any format that the service supports for speech recognition. All audio files added with the same archive file must have the same audio format. Use the `Content-Type` header to specify the archive type, `application/zip` or `application/gzip`. Use the `Contained-Content-Type` header to specify the format of the contained audio files; the default format is `audio/wav`. You can use this method to add any number of audio resources to a custom model by calling the method once for each audio or archive file. But the addition of one audio resource must be fully complete before you can add another. You must add a minimum of 10 minutes and a maximum of 50 hours of audio that includes speech, not just silence, to a custom acoustic model before you can train it. No audio resource, audio- or archive-type, can be larger than 100 MB. The method is asynchronous. It can take several seconds to complete depending on the duration of the audio and, in the case of an archive file, the total number of audio files being processed. The service returns a 201 response code if the audio is valid. It then asynchronously analyzes the contents of the audio file or files and automatically extracts information about the audio such as its length, sampling rate, and encoding. You cannot submit requests to add additional audio resources to a custom acoustic model, or to train the model, until the service's analysis of all audio files for the current request completes. To determine the status of the service's analysis of the audio, use the `GET /v1/acoustic_customizations/{customization_id}/audio/{audio_name}` method to poll the status of the audio. The method accepts the GUID of the custom model and the name of the audio resource, and it returns the status of the resource. Use a loop to check the status of the audio every few seconds until it becomes `ok`. **Note:** The sampling rate of an audio file must match the sampling rate of the base model for the custom model: for broadband models, at least 16 kHz; for narrowband models, at least 8 kHz. If the sampling rate of the audio is higher than the minimum required rate, the service down-samples the audio to the appropriate rate. If the sampling rate of the audio is lower than the minimum required rate, the service labels the audio file as `invalid`.
    
    Parameters:
    
    addAudioOptions - the AddAudioOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - deleteAudio
```
public ServiceCall<java.lang.Void> deleteAudio(DeleteAudioOptions deleteAudioOptions)
```
    Deletes an audio resource from a custom acoustic model. Deletes an existing audio resource from a custom acoustic model. Deleting an archive-type audio resource removes the entire archive of files; the current interface does not allow deletion of individual files from an archive resource. Removing an audio resource does not affect the custom model until you train the model on its updated data by using the `POST /v1/acoustic_customizations/{customization_id}/train` method. You must use credentials for the instance of the service that owns a model to delete its audio resources.
    
    Parameters:
    
    deleteAudioOptions - the DeleteAudioOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of Void
  - getAudio
```
public ServiceCall<AudioListing> getAudio(GetAudioOptions getAudioOptions)
```
    Lists information about an audio resource for a custom acoustic model. Lists information about an audio resource from a custom acoustic model. The method returns an `AudioListing` object whose fields depend on the type of audio resource you specify with the method's `audio_name` parameter: * **For an audio-type resource,** the object's fields match those of an `AudioResource` object: `duration`, `name`, `details`, and `status`. * **For an archive-type resource,** the object includes a `container` field whose fields match those of an `AudioResource` object. It also includes an `audio` field, which contains an array of `AudioResource` objects that provides information about the audio files that are contained in the archive. The information includes the status of the specified audio resource, which is important for checking the service's analysis of the resource in response to a request to add it to the custom model. You must use credentials for the instance of the service that owns a model to list its audio resources.
    
    Parameters:
    
    getAudioOptions - the GetAudioOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of AudioListing
  - listAudio
```
public ServiceCall<AudioResources> listAudio(ListAudioOptions listAudioOptions)
```
    Lists information about all audio resources for a custom acoustic model. Lists information about all audio resources from a custom acoustic model. The information includes the name of the resource and information about its audio data, such as its duration. It also includes the status of the audio resource, which is important for checking the service's analysis of the resource in response to a request to add it to the custom acoustic model. You must use credentials for the instance of the service that owns a model to list its audio resources.
    
    Parameters:
    
    listAudioOptions - the ListAudioOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a response type of AudioResources

Class SpeechToText

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

Constructor Summary

Method Summary

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

Methods inherited from class java.lang.Object

Constructor Detail

SpeechToText

SpeechToText

Method Detail

getModel

listModels

listModels

recognize

recognizeUsingWebSocket

checkJob

checkJobs

checkJobs

createJob

deleteJob

registerCallback

unregisterCallback

createLanguageModel

deleteLanguageModel

getLanguageModel

listLanguageModels

listLanguageModels

resetLanguageModel

trainLanguageModel

upgradeLanguageModel

addCorpus

deleteCorpus

getCorpus

listCorpora

addWord

addWords

deleteWord

getWord

listWords

createAcousticModel

deleteAcousticModel

getAcousticModel

listAcousticModels

listAcousticModels

resetAcousticModel

trainAcousticModel

upgradeAcousticModel

addAudio

deleteAudio

getAudio

listAudio