MLKitDigitalInkRecognition Framework Reference

AI-generated Key Takeaways

• MLKDigitalInkRecognitionCandidate represents a single recognition alternative provided by the recognizer.

• Each candidate contains textual representation (text) and a score indicating its likelihood (score).

• Lower scores indicate higher likelihood, and scores can be used to filter out less likely candidates.

• The score property might not be populated for all models, only those that support it.

• Developers cannot directly instantiate MLKDigitalInkRecognitionCandidate; it's created internally by the API.

MLKDigitalInkRecognitionCandidate

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

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull text;

• 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

  Objective-C

  @property (nonatomic, readonly, nullable) NSNumber *score;

• -init

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

  Declaration

  Objective-C

  - (nonnull instancetype)init;