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

Author:

German Attanasio Ruiz (germanatt@us.ibm.com)

See Also:

Speech to Text

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUDIO
static String	CONTENT_TYPE
static String	CONTINUOUS
static String	INACTIVITY_TIMEOUT
static String	MAX_ALTERNATIVES
static String	MODEL
static String	SESSION_ID
static String	TIMESTAMPS
static String	WORD_CONFIDENCE

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(String model) Create a session to lock an engine to the session.
void	deleteSession(SpeechSession session) Delete a session.
SpeechModel	getModel(SpeechModel watsonModel) Gets the model.
SpeechModel	getModel(String name) Gets the speech model.
List<SpeechModel>	getModels() Gets the models.
SessionStatus	getRecognizeStatus(SpeechSession session) Get the recognize status.
SessionStatus	getRecognizeStatus(String sessionId) Gets the session status.
SpeechResults	recognize(File audio, String contentType) Recognize.
SpeechResults	recognize(Map<String,Object> params) Recognize.

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

execute, executeWithoutResponse, getApiKey, getDefaultContentType, getDefaultRequestParams, getEndPoint, getGson, getHttpClient, getThreadSafeClient, setApiKey, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MODEL

public static final String MODEL

See Also:

Constant Field Values

INACTIVITY_TIMEOUT

public static final String INACTIVITY_TIMEOUT

See Also:

Constant Field Values

TIMESTAMPS

public static final String TIMESTAMPS

See Also:

Constant Field Values

MAX_ALTERNATIVES

public static final String MAX_ALTERNATIVES

See Also:

Constant Field Values

WORD_CONFIDENCE

public static final String WORD_CONFIDENCE

See Also:

Constant Field Values

CONTINUOUS

public static final String CONTINUOUS

See Also:

Constant Field Values

SESSION_ID

public static final String SESSION_ID

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

AUDIO

public static final String AUDIO

See Also:

Constant Field Values

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(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(SpeechModel watsonModel)

Gets the model.

Parameters:

watsonModel - the watson model

Returns:

the model

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)

Get the recognize status.

Parameters:

session - the session

Returns:

the recognize status

See Also:

getRecognizeStatus(String)

getRecognizeStatus

public SessionStatus getRecognizeStatus(String sessionId)

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).

Parameters:

sessionId - the session id

Returns:

the model

recognize

public SpeechResults recognize(File audio,
                               String contentType)

Recognize.

Parameters:

audio - the audio file

contentType - the content type

Returns:

the speech results

recognize

public SpeechResults recognize(Map<String,Object> params)

Recognize.

Parameters:

params - the parameters to use for the recognition. for example: "word_confidence", "continuous", "max_alternatives", "timestamps", "inactivity_timeout", "model", "session_id", content_type

Returns:

the speech results