MLKitDigitalInkRecognition Framework Reference

  • DigitalInkRecognitionResult stores the output of an ink recognition process, offering multiple interpretations of the user's input.

  • Recognition results are presented as a ranked list of DigitalInkRecognitionCandidate objects, with the most likely interpretation appearing first.

  • The number of candidates provided depends on the configuration of the DigitalInkRecognitionModel and DigitalInkRecognizerOptions used during recognition.

  • If the recognizer cannot interpret the ink input, the candidates list will be empty.

  • DigitalInkRecognitionResult objects are generated by the DigitalInkRecognizer and should not be manually instantiated.

DigitalInkRecognitionResult

class DigitalInkRecognitionResult : NSObject

Object representing the output of an ink recognition.

A recognizer usually provides several recognition alternatives, because the user intent is not always clear. For example, if the user writes a vertical line and then a circle, the recognition alternatives could include “10”, “IO”, and “lo”.

Alternatives are named “candidates”. This object represents a set of candidates as a list of DigitalInkRecognitionCandidate.

Use DigitalInkRecognizer to perform the recognition itself. If nothing could be recognized, the property candidates will be an empty array.

  • List of recognition alternatives.

    Candidates are ordered from most likely to least likely. When scores are provided, they are in increasing order.

    The number of candidates depends on the options used when initializing the recognizer. See DigitalInkRecognitionModel and DigitalInkRecognizerOptions for details.

    Declaration

    Swift

    var candidates: [MLKDigitalInkRecognitionCandidate] { get }

  • This object is only meant to be instantiated by a DigitalInkRecognizer object.