RecognitionCandidate

  • RecognitionCandidate represents one of several recognition alternatives provided by a recognizer.

  • It includes methods to get the candidate's score and its textual representation.

  • The score can be used to filter candidates and may be null for models that don't support scores.
public class RecognitionCandidate extends Object

Individual recognition candidate.

A recognizer usually provides several recognition alternatives. This object represents one such alternative.

See RecognitionResult for more details.

Protected Constructor Summary

RecognitionCandidate()

Public Method Summary

boolean
equals(Object other)
Indicates whether some other object is "equal to" this one.
Float
getScore()
Returns this candidate's score.
String
getText()
Returns the textual representation of the recognition.
int
hashCode()
Returns a hash code value for the object.
String
toString()

Inherited Method Summary

Protected Constructors

protected RecognitionCandidate ()

Public Methods

public boolean equals (Object other)

Indicates whether some other object is "equal to" this one.

public Float getScore ()

Returns this candidate's score.

Values may be positive or negative. More likely candidates get lower values. This value is populated only for models that support scores. Otherwise a null value is returned.

Scores are meant to be used to reject candidates whose score is above a threshold. A particular threshold value for a given application will stay valid after a model update.

public String getText ()

Returns the textual representation of the recognition.

public int hashCode ()

Returns a hash code value for the object.

public String toString ()