ai.olami.cloudService

Class SpeechRecognizer

java.lang.Object

ai.olami.cloudService.APIRequestBase

ai.olami.cloudService.SpeechRecognizer

public class SpeechRecognizer
extends APIRequestBase

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIO_BITS_PER_SAMPLE
static int	AUDIO_CHANNELS
static int	AUDIO_LENGTH_MILLISECONDS_PER_FRAME
static int	AUDIO_SAMPLE_RATE
static int	AUDIO_TYPE_PCM_RAW
static int	AUDIO_TYPE_PCM_WAVE

Constructor Summary

Constructors

Constructor and Description
SpeechRecognizer(APIConfiguration configuration) Speech Recognizer to issue Cloud Speech Recognition API requests.

Method Summary

Modifier and Type	Method and Description
int	appendAudioFramesData(byte[] audioFramesData) Append audio data contains N frames to wait the upload for speech recognition.
APIResponse	flushToUploadAudio(CookieSet identifier, boolean isFinalAudio) Flush all of appended audio data to upload and request for speech recognition.
int	getAppendedAudioSize() Get size of all appended audio data.
int	getAudioBufferMaxSize() Get the maximum size in bytes of the audio buffer to append audio frames data.
int	getAudioBufferMinSize() Get the minimum size in bytes of the audio buffer to append audio frames data.
int	getAudioFrameSize() Get audio frame size used by the speech recognizer.
int	getBufferedDataSize() Get size of the buffered data from the appended audio.
boolean	hasBufferedData() Check if there are still buffered data that has not been flushed yet.
void	releaseAppendedAudio() Release all of appended audio data.
APIResponse	requestRecognition(CookieSet identifier) Request to get speech recognition results by specified task identifier.
APIResponse	requestRecognitionWithAll(CookieSet identifier) Request to get speech recognition results by specified task identifier.
APIResponse	requestRecognitionWithAll(CookieSet identifier, NLIConfig nliConfig) Request to get speech recognition results by specified task identifier.
APIResponse	requestRecognitionWithNLI(CookieSet identifier) Request to get speech recognition results by specified task identifier.
APIResponse	requestRecognitionWithNLI(CookieSet identifier, NLIConfig nliConfig) Request to get speech recognition results by specified task identifier.
void	setAudioType(int audioType) Set and specify the type of the speech audio.
APIResponse	uploadAudio(CookieSet identifier, byte[] audioData, boolean isFinalAudio) Request to upload the specified audio for speech recognition.
APIResponse	uploadAudio(CookieSet identifier, byte[] audioData, int audioType, boolean isFinalAudio) Request to upload the specified audio for speech recognition.
APIResponse	uploadAudio(CookieSet identifier, String filePath, boolean isFinalAudio) Request to upload the specified audio for speech recognition.
APIResponse	uploadAudio(CookieSet identifier, String filePath, int audioType, boolean isFinalAudio) Request to upload the specified audio for speech recognition.

Methods inherited from class ai.olami.cloudService.APIRequestBase

getConfiguration, getEndUserIdentifier, getSdkType, getTimeout, setConfiguration, setEndUserIdentifier, setSdkType, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

AUDIO_TYPE_PCM_RAW

public static final int AUDIO_TYPE_PCM_RAW

See Also:

Constant Field Values

AUDIO_TYPE_PCM_WAVE

public static final int AUDIO_TYPE_PCM_WAVE

See Also:

Constant Field Values

AUDIO_LENGTH_MILLISECONDS_PER_FRAME

public static final int AUDIO_LENGTH_MILLISECONDS_PER_FRAME

See Also:

Constant Field Values

AUDIO_SAMPLE_RATE

public static final int AUDIO_SAMPLE_RATE

See Also:

Constant Field Values

AUDIO_BITS_PER_SAMPLE

public static final int AUDIO_BITS_PER_SAMPLE

See Also:

Constant Field Values

AUDIO_CHANNELS

public static final int AUDIO_CHANNELS

See Also:

Constant Field Values

Constructor Detail

SpeechRecognizer

public SpeechRecognizer(APIConfiguration configuration)

Speech Recognizer to issue Cloud Speech Recognition API requests.

Parameters:

configuration - - API configurations.

Method Detail

getAudioFrameSize

public int getAudioFrameSize()

Get audio frame size used by the speech recognizer.

Returns:

Frame size in bytes.

uploadAudio

public APIResponse uploadAudio(CookieSet identifier,
                               String filePath,
                               boolean isFinalAudio)
                        throws IOException,
                               NoSuchAlgorithmException

Request to upload the specified audio for speech recognition. You must to specify the audio type by setAudioType(int audioType) before using this method.

Parameters:

identifier - - Identifier CookieSet.

filePath - - The path of the audio file. Wave Header is required if it is a Wave audio.

isFinalAudio - - TRUE if this is the last audio of a speech input.

Returns:

API response with the audio uploading status.

Throws:

IOException - File handling or HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

uploadAudio

public APIResponse uploadAudio(CookieSet identifier,
                               String filePath,
                               int audioType,
                               boolean isFinalAudio)
                        throws IOException,
                               NoSuchAlgorithmException

Request to upload the specified audio for speech recognition.

Parameters:

identifier - - Identifier CookieSet.

filePath - - The path of the audio file. Wave Header is required if it is a Wave audio.

audioType - - Audio type: AUDIO_TYPE_PCM_RAW for PCM raw data. AUDIO_TYPE_PCM_WAVE for Wave audio.

isFinalAudio - - TRUE if this is the last audio of a speech input.

Returns:

API response with the audio uploading status.

Throws:

IOException - File handling or HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

uploadAudio

public APIResponse uploadAudio(CookieSet identifier,
                               byte[] audioData,
                               boolean isFinalAudio)
                        throws IOException,
                               NoSuchAlgorithmException

Request to upload the specified audio for speech recognition. You must to specify the audio type by setAudioType(int audioType) before using this method.

Parameters:

identifier - - Identifier CookieSet.

audioData - - The audio data. Wave Header is required if it is a Wave audio.

isFinalAudio - - TRUE if this is the last audio of a speech input.

Returns:

API response with the audio uploading status.

Throws:

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

uploadAudio

public APIResponse uploadAudio(CookieSet identifier,
                               byte[] audioData,
                               int audioType,
                               boolean isFinalAudio)
                        throws IOException,
                               NoSuchAlgorithmException

Request to upload the specified audio for speech recognition.

Parameters:

identifier - - Identifier CookieSet.

audioData - - The audio data. Wave Header is required if it is a Wave audio.

audioType - - Audio type: AUDIO_TYPE_PCM_RAW for PCM raw data. AUDIO_TYPE_PCM_WAVE for Wave audio.

isFinalAudio - - TRUE if this is the last audio of a speech input.

Returns:

API response with the audio uploading status.

Throws:

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

setAudioType

public void setAudioType(int audioType)

Set and specify the type of the speech audio.

Parameters:

audioType - - Audio type: AUDIO_TYPE_PCM_RAW for PCM raw data. AUDIO_TYPE_PCM_WAVE for Wave audio.

getAudioBufferMaxSize

public int getAudioBufferMaxSize()

Get the maximum size in bytes of the audio buffer to append audio frames data.

Returns:

The size in bytes.

getAudioBufferMinSize

public int getAudioBufferMinSize()

Get the minimum size in bytes of the audio buffer to append audio frames data.

Returns:

The size in bytes.

appendAudioFramesData

public int appendAudioFramesData(byte[] audioFramesData)

Append audio data contains N frames to wait the upload for speech recognition. The size of data in bytes must be a multiple of the size getAudioBufferMinSize() provides. The total size of all of appended data must be less than or equal to the size getAudioBufferMaxSize() provides.

Parameters:

audioFramesData - - The audio frames data. (Contains N frames)

Returns:

Total size of all of appended audio data.

flushToUploadAudio

public APIResponse flushToUploadAudio(CookieSet identifier,
                                      boolean isFinalAudio)
                               throws IOException,
                                      NoSuchAlgorithmException

Flush all of appended audio data to upload and request for speech recognition.

Parameters:

identifier - - Identifier CookieSet.

isFinalAudio - - TRUE if this is the last audio of a speech input.

Returns:

API response with the audio uploading status.

Throws:

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

releaseAppendedAudio

public void releaseAppendedAudio()

Release all of appended audio data.

getAppendedAudioSize

public int getAppendedAudioSize()

Get size of all appended audio data.

Returns:

Appended audio size in bytes.

getBufferedDataSize

public int getBufferedDataSize()

Get size of the buffered data from the appended audio.

Returns:

Size of the buffered data from the appended audio.

hasBufferedData

public boolean hasBufferedData()

Check if there are still buffered data that has not been flushed yet.

Returns:

TRUE if buffered data exists.

requestRecognition

public APIResponse requestRecognition(CookieSet identifier)
                               throws IllegalArgumentException,
                                      IOException,
                                      NoSuchAlgorithmException

Request to get speech recognition results by specified task identifier. Before you call this method, you must to upload audio by related methods first.

Parameters:

identifier - - Identifier CookieSet.

Returns:

API response with speech recognition results.

Throws:

IllegalArgumentException - Invalid contents of the CookieSet.

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

requestRecognitionWithNLI

public APIResponse requestRecognitionWithNLI(CookieSet identifier)
                                      throws IllegalArgumentException,
                                             IOException,
                                             NoSuchAlgorithmException

Request to get speech recognition results by specified task identifier. Before you call this method, you must to upload audio by related methods first.

Parameters:

identifier - - Identifier CookieSet.

Returns:

API response with speech recognition results and NLI results.

Throws:

IllegalArgumentException - Invalid contents of the CookieSet.

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

requestRecognitionWithNLI

public APIResponse requestRecognitionWithNLI(CookieSet identifier,
                                             NLIConfig nliConfig)
                                      throws IllegalArgumentException,
                                             IOException,
                                             NoSuchAlgorithmException

Request to get speech recognition results by specified task identifier. Before you call this method, you must to upload audio by related methods first.

Parameters:

identifier - - Identifier CookieSet.

nliConfig - - NLIConfig object.

Returns:

API response with speech recognition results and NLI results.

Throws:

IllegalArgumentException - Invalid contents of the CookieSet.

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

requestRecognitionWithAll

public APIResponse requestRecognitionWithAll(CookieSet identifier)
                                      throws IllegalArgumentException,
                                             IOException,
                                             NoSuchAlgorithmException

Request to get speech recognition results by specified task identifier. Before you call this method, you must to upload audio by related methods first.

Parameters:

identifier - - Identifier CookieSet.

Returns:

API response with all kinds of recognition results.

Throws:

IllegalArgumentException - Invalid contents of the CookieSet.

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.

requestRecognitionWithAll

public APIResponse requestRecognitionWithAll(CookieSet identifier,
                                             NLIConfig nliConfig)
                                      throws IllegalArgumentException,
                                             IOException,
                                             NoSuchAlgorithmException

Request to get speech recognition results by specified task identifier. Before you call this method, you must to upload audio by related methods first.

Parameters:

identifier - - Identifier CookieSet.

nliConfig - - NLIConfig object.

Returns:

API response with all kinds of recognition results.

Throws:

IllegalArgumentException - Invalid contents of the CookieSet.

IOException - HTTP connection failed, or other exceptions.

NoSuchAlgorithmException - Failed to create signature.