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

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
SpeechToText() Instantiates a new Speech to Text service.
SpeechToText(String username, String password) Instantiates a new Speech to Text service by username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<SpeechSession>	createSession() Creates a session to lock an engine to the session.
ServiceCall<SpeechSession>	createSession(SpeechModel model) Creates a session to lock an engine to the session.
ServiceCall<SpeechSession>	createSession(String model) Creates a session to lock an engine to the session.
ServiceCall<Void>	deleteSession(SpeechSession session) Deletes a SpeechSession.
ServiceCall<SpeechModel>	getModel(String modelName) Gets the speech model based on a given name.
ServiceCall<List<SpeechModel>>	getModels() Gets the models.
ServiceCall<SpeechSessionStatus>	getRecognizeStatus(SpeechSession session) Gets the session status.
ServiceCall<SpeechResults>	recognize(File audio) Recognizes an audio file and returns SpeechResults.
ServiceCall<SpeechResults>	recognize(File audio, RecognizeOptions options) Recognizes an audio file and returns SpeechResults. Here is an example of how to recognize an audio file:
void	recognizeUsingWebSocket(InputStream audio, RecognizeOptions options, RecognizeCallback callback) Recognizes an audio InputStream using a WebSocket. The RecognizeCallback 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:

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, 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 Speech to Text service.

SpeechToText

public SpeechToText(String username,
                    String password)

Instantiates a new Speech to Text service by username and password.

Parameters:

username - the username

password - the password

Method Detail

createSession

public ServiceCall<SpeechSession> createSession()

Creates 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 ServiceCall<SpeechSession> createSession(SpeechModel model)

Creates 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 ServiceCall<SpeechSession> createSession(String model)

Creates 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 ServiceCall<Void> deleteSession(SpeechSession session)

Deletes a SpeechSession.

Parameters:

session - the speech session to delete

Returns:

the service call

getModel

public ServiceCall<SpeechModel> getModel(String modelName)

Gets the speech model based on a given name.

Parameters:

modelName - the model name

Returns:

the SpeechModel

getModels

public ServiceCall<List<SpeechModel>> getModels()

Gets the models.

Returns:

the SpeechModels

getRecognizeStatus

public ServiceCall<SpeechSessionStatus> 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, RecognizeOptions) .

Parameters:

session - the speech session

Returns:

the model

recognize

public ServiceCall<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")).execute();
 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 ServiceCall<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);

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

 SpeechResults results = service.recognize(audio, options).execute();
 System.out.println(results);
 

Parameters:

audio - the audio file

options - the recognize options

Returns:

the SpeechResults

recognizeUsingWebSocket

public void recognizeUsingWebSocket(InputStream audio,
                                    RecognizeOptions options,
                                    RecognizeCallback callback)

Recognizes an audio InputStream using a WebSocket.
The RecognizeCallback 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().maxAlternatives(2).continuous(true);

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

 service.recognizeUsingWebSocket(audio, options, new BaseRecognizeCallback() {
   @Override
   public void onTranscript(SpeechResults speechResults) {
     System.out.println(speechResults);
   }
 });
 

Parameters:

audio - the audio input stream

options - the recognize options

callback - the callback