MLKitDigitalInkRecognition Framework Reference

AI-generated Key Takeaways

• DigitalInkRecognitionCandidate objects represent individual recognition alternatives provided by a recognizer.

• Each candidate includes recognized text and, optionally, a score indicating its likelihood.

• Lower scores generally indicate more likely candidates, allowing for filtering based on thresholds.

• These objects are created internally by the API and are accessed through DigitalInkRecognitionResult.

DigitalInkRecognitionCandidate

class DigitalInkRecognitionCandidate : NSObject

Individual recognition candidate.

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

See DigitalInkRecognitionResult for more details.

• text

  The textual representation of this candidate.

  Declaration

  Swift

  var text: String { get }

• score

  Score of the candidate. Values may be positive or negative. More likely candidates get lower values. This value is populated only for models that support it.

  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.

  Declaration

  Swift

  var score: NSNumber? { get }

• -init

  Unavailable. This object is only created internally by the API.