MLKitDigitalInkRecognition Framework Reference

  • MLKDigitalInkRecognitionResult represents the output of an ink recognition process, potentially containing multiple interpretations (candidates) of the user's input.

  • Candidates are ranked by likelihood, with the most probable interpretation listed first within the candidates property.

  • The number of candidates returned depends on the configuration of the DigitalInkRecognizer and its associated options.

  • This object is created internally by a DigitalInkRecognizer and should not be manually instantiated.

MLKDigitalInkRecognitionResult


@interface MLKDigitalInkRecognitionResult : 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

    Objective-C

    @property (nonatomic, readonly) NSArray<MLKDigitalInkRecognitionCandidate *> *_Nonnull candidates;

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

    Declaration

    Objective-C

    - (nonnull instancetype)init;