org.jvoicexml

Interface RecognitionResult

public interface RecognitionResult

Result of the recognition process.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
float	getConfidence() Retrieves the whole utterance confidence level for this interpretation from 0.0 - 1.0.
java.lang.String	getMark() Retrieves the name of the mark, that has been reached while playing back an SSML formatted document.
org.jvoicexml.xml.srgs.ModeType	getMode() Retrieves the mode in which user input was provided: dtmf or voice.
java.lang.Object	getSemanticInterpretation(DataModel model) Retrieves the semantic interpretation of the utterance.
java.lang.String	getUtterance() Retrieves the result as a single string.
java.lang.String[]	getWords() Retrieves an array of the distinct words in getUtterance().
float[]	getWordsConfidence() Retrieves the vector with the confidence level of each word for this interpretation from 0.0 - 1.0.
boolean	isAccepted() Checks if this result is accepted.
void	setMark(java.lang.String mark) Sets the mark reached that is reached while playing back an SSML formatted document.

Method Detail

getSemanticInterpretation

java.lang.Object getSemanticInterpretation(DataModel model)
                                    throws SemanticError

Retrieves the semantic interpretation of the utterance.

Parameters:

model - the employed data model

Returns:

the semantic interpretation of the utterance

Throws:

SemanticError - error creating the semantic interpretation

Since:

0.7

getUtterance

java.lang.String getUtterance()

Retrieves the result as a single string.

Returns:

Result, obtained from the recognizer, null if no result is given or the result is not accepted.

getWords

java.lang.String[] getWords()

Retrieves an array of the distinct words in getUtterance().

The length of the returned array must match the size of the array returned by getWordsConfidence().

Returns:

String[].

getConfidence

float getConfidence()

Retrieves the whole utterance confidence level for this interpretation from 0.0 - 1.0.

A confidence level of 0.0 denotes the lowest confidence and a level of 1.0 denotes the highest confidence.

Returns:

confidence level.

Since:

0.6

getWordsConfidence

float[] getWordsConfidence()

Retrieves the vector with the confidence level of each word for this interpretation from 0.0 - 1.0.

A confidence level of 0.0 denotes the lowest confidence and a level of 1.0 denotes the highest confidence.

The length of the returned array must match the size of the array returned by getWords().

Returns:

confidence level of each word.

Since:

0.6

getMode

org.jvoicexml.xml.srgs.ModeType getMode()

Retrieves the mode in which user input was provided: dtmf or voice.

Returns:

mode.

Since:

0.6

isAccepted

boolean isAccepted()

Checks if this result is accepted.

Returns:

true if the result is accepted.

setMark

void setMark(java.lang.String mark)

Sets the mark reached that is reached while playing back an SSML formatted document.

Parameters:

mark - Name of the mark.

getMark

java.lang.String getMark()

Retrieves the name of the mark, that has been reached while playing back an SSML formatted document.

Returns:

name of the mark.