com.ibm.watson.developer_cloud.speech_to_text.v1

Class SpeechToText

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.

Version:

v1

See Also:

Speech to Text

Field Summary

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

VERSION

Constructor Summary

Constructors

Constructor and Description
SpeechToText() Instantiates a new speech to text.

Method Summary

Modifier and Type	Method and Description
SpeechSession	createSession() Create a session to lock an engine to the session.
SpeechSession	createSession(SpeechModel model) Create a session to lock an engine to the session.
SpeechSession	createSession(String model) Create a session to lock an engine to the session.
void	deleteSession(SpeechSession session) Delete a session.
SpeechModel	getModel(String name) Gets the speech model.
List<SpeechModel>	getModels() Gets the models.
SessionStatus	getRecognizeStatus(SpeechSession session) Gets the session status.
SpeechResults	recognize(File audio) Recognizes an audio file and returns SpeechResults.
SpeechResults	recognize(File audio, RecognizeOptions options) Recognizes an audio file and returns SpeechResults. Here is an example of how to recognize an audio file:
SpeechResults	recognize(File audio, String contentType) Deprecated. Deprecated in 2.6.0 Use recognize(File, RecognizeOptions)
SpeechResults	recognize(File audio, String contentType, RecognizeOptions options) Deprecated. Deprecated in 2.6.0 Use recognize(File, RecognizeOptions)
void	recognizeUsingWebSockets(InputStream audio, RecognizeOptions options, RecognizeDelegate delegate) Recognizes an audio InputStream using WebSockets.

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

configureHttpClient, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, 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 speech to text.

Method Detail

createSession

public SpeechSession createSession()

Create a session to lock an engine to the session. You can use the session for multiple recognition requests, so that each request is processed with the same speech-to-text engine. Use the cookie that is returned from this operation in the Set-Cookie header for each request that uses this session. The session expires after 15 minutes of inactivity.

Returns:

the SpeechSession

createSession

public SpeechSession createSession(SpeechModel model)

Create a session to lock an engine to the session. You can use the session for multiple recognition requests, so that each request is processed with the same speech-to-text engine. Use the cookie that is returned from this operation in the Set-Cookie header for each request that uses this session. The session expires after 15 minutes of inactivity.

Parameters:

model - the model

Returns:

the SpeechSession

createSession

public SpeechSession createSession(String model)

Create a session to lock an engine to the session. You can use the session for multiple recognition requests, so that each request is processed with the same speech-to-text engine. Use the cookie that is returned from this operation in the Set-Cookie header for each request that uses this session. The session expires after 15 minutes of inactivity.

Parameters:

model - the model

Returns:

the SpeechSession

deleteSession

public void deleteSession(SpeechSession session)

Delete a session.

Parameters:

session - the speech session

getModel

public SpeechModel getModel(String name)

Gets the speech model.

Parameters:

name - the name

Returns:

the model

getModels

public List<SpeechModel> getModels()

Gets the models.

Returns:

the models

getRecognizeStatus

public SessionStatus getRecognizeStatus(SpeechSession session)

Gets the session status. Concurrent recognition tasks during the same session are not allowed. This method offers a way to check whether the session can accept another recognition task. The returned state must be "initialized" to call recognize(File, String, RecognizeOptions) .

Parameters:

session - the speech session

Returns:

the model

recognize

public SpeechResults recognize(File audio)

Recognizes an audio file and returns SpeechResults. It will try to recognize the audio format based on the file extension.
Here is an example of how to recognize an audio file:

 SpeechToText service = new SpeechToText();
 service.setUsernameAndPassword("USERNAME", "PASSWORD");
 service.setEndPoint("SERVICE_URL");
 
 SpeechResults results = service.recognize(new File("sample1.wav"));
 System.out.println(results);
 

Parameters:

audio - the audio file

Returns:

the SpeechResults

Throws:

IllegalArgumentException - if the file extension doesn't match a valid audio type

recognize

public SpeechResults recognize(File audio,
                               RecognizeOptions options)

Recognizes an audio file and returns SpeechResults.

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);
 
 SpeechResults results = service.recognize(new File("sample1.wav"), options);
 System.out.println(results);
 

Parameters:

audio - the audio

options - the options

Returns:

the speech results

recognize

public SpeechResults recognize(File audio,
                               String contentType)

Deprecated. Deprecated in 2.6.0
Use recognize(File, RecognizeOptions)

Recognizes an audio file and returns SpeechResults.

Parameters:

audio - the audio file

contentType - the media type of the audio.

Returns:

the SpeechResults

recognize

public SpeechResults recognize(File audio,
                               String contentType,
                               RecognizeOptions options)

Deprecated. Deprecated in 2.6.0
Use recognize(File, RecognizeOptions)

Recognizes an audio file and returns SpeechResults.

Parameters:

audio - the audio file

contentType - the media type of the audio. If you use the audio/l16 MIME type, specify the rate and channels.

options - the RecognizeOptions

Returns:

the SpeechResults

recognizeUsingWebSockets

public void recognizeUsingWebSockets(InputStream audio,
                                     RecognizeOptions options,
                                     RecognizeDelegate delegate)

Recognizes an audio InputStream using WebSockets. The RecognizeDelegate instance will be called every time the service sends SpeechResults.

Here is an example of how to recognize an audio file using WebSockets and get interim results:

 SpeechToText service = new SpeechToText();
 service.setUsernameAndPassword("USERNAME", "PASSWORD");
 service.setEndPoint("SERVICE_URL");
 
 RecognizeOptions options = new RecognizeOptions().continuous(true).interimResults(true);
 
 service.recognizeWS(new FileInputStream("sample1.wav"), options, new BaseRecognizeDelegate() {
   @Override
   public void onMessage(SpeechResults speechResults) {
     System.out.println(speechResults);
   }
 });
 

Parameters:

audio - the audio input stream

options - the recognize options

delegate - the delegate