在 iOS 上使用 ML Kit 辨識數位墨水

有了 ML Kit 的數位墨水辨識功能,您就能識別數位平面上數百種語言的手寫文字,以及分類素描。

立即試用

事前準備

  1. 在 Podfile 中加入下列 ML Kit 程式庫:

    pod 'GoogleMLKit/DigitalInkRecognition', '7.0.0'
    
    
  2. 安裝或更新專案的 Pod 後,請使用其 .xcworkspace 開啟 Xcode 專案。Xcode 13.2.1 以上版本支援 ML Kit。

您現在可以開始在 Ink 物件中辨識文字。

建構 Ink 物件

建構 Ink 物件的主要方式是在觸控螢幕上繪製圖形。在 iOS 上,您可以使用 UIImageView觸控事件處理常式,在畫面上繪製筆劃,並儲存筆劃的點,以建構 Ink 物件。以下程式碼片段展示了這個一般模式。如需更完整的示例,請參閱快速入門應用程式,該應用程式會將觸控事件處理、螢幕繪圖和筆觸資料管理分開。

Swift

@IBOutlet weak var mainImageView: UIImageView!
var kMillisecondsPerTimeInterval = 1000.0
var lastPoint = CGPoint.zero
private var strokes: [Stroke] = []
private var points: [StrokePoint] = []

func drawLine(from fromPoint: CGPoint, to toPoint: CGPoint) {
  UIGraphicsBeginImageContext(view.frame.size)
  guard let context = UIGraphicsGetCurrentContext() else {
    return
  }
  mainImageView.image?.draw(in: view.bounds)
  context.move(to: fromPoint)
  context.addLine(to: toPoint)
  context.setLineCap(.round)
  context.setBlendMode(.normal)
  context.setLineWidth(10.0)
  context.setStrokeColor(UIColor.white.cgColor)
  context.strokePath()
  mainImageView.image = UIGraphicsGetImageFromCurrentImageContext()
  mainImageView.alpha = 1.0
  UIGraphicsEndImageContext()
}

override func touchesBegan(_ touches: Set, with event: UIEvent?) {
  guard let touch = touches.first else {
    return
  }
  lastPoint = touch.location(in: mainImageView)
  let t = touch.timestamp
  points = [StrokePoint.init(x: Float(lastPoint.x),
                             y: Float(lastPoint.y),
                             t: Int(t * kMillisecondsPerTimeInterval))]
  drawLine(from:lastPoint, to:lastPoint)
}

override func touchesMoved(_ touches: Set, with event: UIEvent?) {
  guard let touch = touches.first else {
    return
  }
  let currentPoint = touch.location(in: mainImageView)
  let t = touch.timestamp
  points.append(StrokePoint.init(x: Float(currentPoint.x),
                                 y: Float(currentPoint.y),
                                 t: Int(t * kMillisecondsPerTimeInterval)))
  drawLine(from: lastPoint, to: currentPoint)
  lastPoint = currentPoint
}

override func touchesEnded(_ touches: Set, with event: UIEvent?) {
  guard let touch = touches.first else {
    return
  }
  let currentPoint = touch.location(in: mainImageView)
  let t = touch.timestamp
  points.append(StrokePoint.init(x: Float(currentPoint.x),
                                 y: Float(currentPoint.y),
                                 t: Int(t * kMillisecondsPerTimeInterval)))
  drawLine(from: lastPoint, to: currentPoint)
  lastPoint = currentPoint
  strokes.append(Stroke.init(points: points))
  self.points = []
  doRecognition()
}

Objective-C

// Interface
@property (weak, nonatomic) IBOutlet UIImageView *mainImageView;
@property(nonatomic) CGPoint lastPoint;
@property(nonatomic) NSMutableArray *strokes;
@property(nonatomic) NSMutableArray *points;

// Implementations
static const double kMillisecondsPerTimeInterval = 1000.0;

- (void)drawLineFrom:(CGPoint)fromPoint to:(CGPoint)toPoint {
  UIGraphicsBeginImageContext(self.mainImageView.frame.size);
  [self.mainImageView.image drawInRect:CGRectMake(0, 0, self.mainImageView.frame.size.width,
                                                  self.mainImageView.frame.size.height)];
  CGContextMoveToPoint(UIGraphicsGetCurrentContext(), fromPoint.x, fromPoint.y);
  CGContextAddLineToPoint(UIGraphicsGetCurrentContext(), toPoint.x, toPoint.y);
  CGContextSetLineCap(UIGraphicsGetCurrentContext(), kCGLineCapRound);
  CGContextSetLineWidth(UIGraphicsGetCurrentContext(), 10.0);
  CGContextSetRGBStrokeColor(UIGraphicsGetCurrentContext(), 1, 1, 1, 1);
  CGContextSetBlendMode(UIGraphicsGetCurrentContext(), kCGBlendModeNormal);
  CGContextStrokePath(UIGraphicsGetCurrentContext());
  CGContextFlush(UIGraphicsGetCurrentContext());
  self.mainImageView.image = UIGraphicsGetImageFromCurrentImageContext();
  UIGraphicsEndImageContext();
}

- (void)touchesBegan:(NSSet *)touches withEvent:(nullable UIEvent *)event {
  UITouch *touch = [touches anyObject];
  self.lastPoint = [touch locationInView:self.mainImageView];
  NSTimeInterval time = [touch timestamp];
  self.points = [NSMutableArray array];
  [self.points addObject:[[MLKStrokePoint alloc] initWithX:self.lastPoint.x
                                                         y:self.lastPoint.y
                                                         t:time * kMillisecondsPerTimeInterval]];
  [self drawLineFrom:self.lastPoint to:self.lastPoint];
}

- (void)touchesMoved:(NSSet *)touches withEvent:(nullable UIEvent *)event {
  UITouch *touch = [touches anyObject];
  CGPoint currentPoint = [touch locationInView:self.mainImageView];
  NSTimeInterval time = [touch timestamp];
  [self.points addObject:[[MLKStrokePoint alloc] initWithX:currentPoint.x
                                                         y:currentPoint.y
                                                         t:time * kMillisecondsPerTimeInterval]];
  [self drawLineFrom:self.lastPoint to:currentPoint];
  self.lastPoint = currentPoint;
}

- (void)touchesEnded:(NSSet *)touches withEvent:(nullable UIEvent *)event {
  UITouch *touch = [touches anyObject];
  CGPoint currentPoint = [touch locationInView:self.mainImageView];
  NSTimeInterval time = [touch timestamp];
  [self.points addObject:[[MLKStrokePoint alloc] initWithX:currentPoint.x
                                                         y:currentPoint.y
                                                         t:time * kMillisecondsPerTimeInterval]];
  [self drawLineFrom:self.lastPoint to:currentPoint];
  self.lastPoint = currentPoint;
  if (self.strokes == nil) {
    self.strokes = [NSMutableArray array];
  }
  [self.strokes addObject:[[MLKStroke alloc] initWithPoints:self.points]];
  self.points = nil;
  [self doRecognition];
}

請注意,程式碼片段包含範例函式,可將筆劃繪製至 UIImageView,並視應用程式需求進行調整。建議您在繪製線段時使用圓形字尾,這樣長度為零的線段就會繪製為圓點 (想想小寫字母 i 上的圓點)。每筆筆劃寫入後,系統會呼叫 doRecognition() 函式,並在下方定義。

取得 DigitalInkRecognizer 的例項

如要執行辨識作業,我們需要將 Ink 物件傳遞至 DigitalInkRecognizer 例項。如要取得 DigitalInkRecognizer 例項,我們必須先下載所需語言的辨識器模型,然後將模型載入 RAM。您可以使用下列程式碼片段完成這項操作,為了簡單起見,我們將其放置在 viewDidLoad() 方法中,並使用硬式編碼的語言名稱。請參閱快速入門應用程式,瞭解如何向使用者顯示可用語言清單,以及下載所選語言。

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  let languageTag = "en-US"
  let identifier = DigitalInkRecognitionModelIdentifier(forLanguageTag: languageTag)
  if identifier == nil {
    // no model was found or the language tag couldn't be parsed, handle error.
  }
  let model = DigitalInkRecognitionModel.init(modelIdentifier: identifier!)
  let modelManager = ModelManager.modelManager()
  let conditions = ModelDownloadConditions.init(allowsCellularAccess: true,
                                         allowsBackgroundDownloading: true)
  modelManager.download(model, conditions: conditions)
  // Get a recognizer for the language
  let options: DigitalInkRecognizerOptions = DigitalInkRecognizerOptions.init(model: model)
  recognizer = DigitalInkRecognizer.digitalInkRecognizer(options: options)
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  NSString *languagetag = @"en-US";
  MLKDigitalInkRecognitionModelIdentifier *identifier =
      [MLKDigitalInkRecognitionModelIdentifier modelIdentifierForLanguageTag:languagetag];
  if (identifier == nil) {
    // no model was found or the language tag couldn't be parsed, handle error.
  }
  MLKDigitalInkRecognitionModel *model = [[MLKDigitalInkRecognitionModel alloc]
                                          initWithModelIdentifier:identifier];
  MLKModelManager *modelManager = [MLKModelManager modelManager];
  [modelManager downloadModel:model conditions:[[MLKModelDownloadConditions alloc]
                                                initWithAllowsCellularAccess:YES
                                                allowsBackgroundDownloading:YES]];
  MLKDigitalInkRecognizerOptions *options =
      [[MLKDigitalInkRecognizerOptions alloc] initWithModel:model];
  self.recognizer = [MLKDigitalInkRecognizer digitalInkRecognizerWithOptions:options];
}

快速入門應用程式包含額外的程式碼,說明如何同時處理多個下載作業,以及如何透過處理完成通知來判斷哪個下載作業成功。

辨識 Ink 物件

接下來,我們會討論 doRecognition() 函式,為簡單起見,我們會從 touchesEnded() 呼叫這個函式。在其他應用程式中,您可能只想在逾時後或使用者按下按鈕觸發辨識功能時,才叫用辨識功能。

Swift

func doRecognition() {
  let ink = Ink.init(strokes: strokes)
  recognizer.recognize(
    ink: ink,
    completion: {
      [unowned self]
      (result: DigitalInkRecognitionResult?, error: Error?) in
      var alertTitle = ""
      var alertText = ""
      if let result = result, let candidate = result.candidates.first {
        alertTitle = "I recognized this:"
        alertText = candidate.text
      } else {
        alertTitle = "I hit an error:"
        alertText = error!.localizedDescription
      }
      let alert = UIAlertController(title: alertTitle,
                                  message: alertText,
                           preferredStyle: UIAlertController.Style.alert)
      alert.addAction(UIAlertAction(title: "OK",
                                    style: UIAlertAction.Style.default,
                                  handler: nil))
      self.present(alert, animated: true, completion: nil)
    }
  )
}

Objective-C

- (void)doRecognition {
  MLKInk *ink = [[MLKInk alloc] initWithStrokes:self.strokes];
  __weak typeof(self) weakSelf = self;
  [self.recognizer
      recognizeInk:ink
        completion:^(MLKDigitalInkRecognitionResult *_Nullable result,
                     NSError *_Nullable error) {
    typeof(weakSelf) strongSelf = weakSelf;
    if (strongSelf == nil) {
      return;
    }
    NSString *alertTitle = nil;
    NSString *alertText = nil;
    if (result.candidates.count > 0) {
      alertTitle = @"I recognized this:";
      alertText = result.candidates[0].text;
    } else {
      alertTitle = @"I hit an error:";
      alertText = [error localizedDescription];
    }
    UIAlertController *alert =
        [UIAlertController alertControllerWithTitle:alertTitle
                                            message:alertText
                                     preferredStyle:UIAlertControllerStyleAlert];
    [alert addAction:[UIAlertAction actionWithTitle:@"OK"
                                              style:UIAlertActionStyleDefault
                                            handler:nil]];
    [strongSelf presentViewController:alert animated:YES completion:nil];
  }];
}

管理模型下載作業

我們已經瞭解如何下載辨識模型。下列程式碼片段說明如何檢查模型是否已下載,或在不再需要模型時刪除模型以回復儲存空間。

檢查模型是否已下載

Swift

let model : DigitalInkRecognitionModel = ...
let modelManager = ModelManager.modelManager()
modelManager.isModelDownloaded(model)

Objective-C

MLKDigitalInkRecognitionModel *model = ...;
MLKModelManager *modelManager = [MLKModelManager modelManager];
[modelManager isModelDownloaded:model];

刪除已下載的模型

Swift

let model : DigitalInkRecognitionModel = ...
let modelManager = ModelManager.modelManager()

if modelManager.isModelDownloaded(model) {
  modelManager.deleteDownloadedModel(
    model!,
    completion: {
      error in
      if error != nil {
        // Handle error
        return
      }
      NSLog(@"Model deleted.");
    })
}

Objective-C

MLKDigitalInkRecognitionModel *model = ...;
MLKModelManager *modelManager = [MLKModelManager modelManager];

if ([self.modelManager isModelDownloaded:model]) {
  [self.modelManager deleteDownloadedModel:model
                                completion:^(NSError *_Nullable error) {
                                  if (error) {
                                    // Handle error.
                                    return;
                                  }
                                  NSLog(@"Model deleted.");
                                }];
}

提升文字辨識準確度的提示

文字辨識的準確度可能因語言而異。準確度也取決於寫作風格。雖然數位墨水辨識功能經過訓練,可處理多種書寫風格,但結果可能因使用者而異。

以下提供一些提升文字辨識器準確度的方法。請注意,這些技巧不適用於表情符號、Autodraw 和圖形的繪圖分類器。

書寫區

許多應用程式都有明確的輸入區域,供使用者輸入內容。符號的含義部分取決於符號的大小相對於包含符號的書寫區域的大小。例如,小寫或大寫字母「o」或「c」之間的差異,以及逗號和正斜線的差異。

告知辨識器書寫區域的寬度和高度,有助於提高辨識準確度。不過,辨識器會假設書寫區域只包含一行文字。如果實體書寫區域足夠大,可讓使用者書寫兩行以上的文字,您可以傳入高度為單行文字高度最佳估計值的 WritingArea,以便取得更好的結果。您傳遞給辨識器的 WritingArea 物件不必與螢幕上的實際書寫區域完全對應。以這種方式變更 WritingArea 高度,在某些語言中比其他語言更有效。

指定書寫區域時,請使用與筆劃座標相同的單位指定其寬度和高度。x、y 座標引數沒有單位要求 - API 會將所有單位標準化,因此唯一重要的是筆劃的相對大小和位置。您可以自由傳入座標,並使用系統適用的任何比例。

預先設定的內容

前置文字是指您嘗試辨識的 Ink 中,筆劃前方的文字。您可以告知辨識器先前的上下文,協助辨識器。

舉例來說,草寫字母「n」和「u」經常會互相混淆。如果使用者已輸入部分字詞「arg」,則可能會繼續輸入可辨識為「ument」或「nment」的筆劃。指定前置文字「arg」可解決歧義,因為「argument」一詞比「argnment」更有可能出現。

前置文字也可協助辨識器識別斷字,也就是字詞之間的空格。您可以輸入空格字元,但無法繪製空格,因此辨識器如何判斷一個字詞結束,下一個字詞開始?如果使用者已寫下「hello」,並繼續寫下「world」,在沒有預先提供的上下文情況下,辨識器會傳回「world」字串。不過,如果您指定前置上下文「hello」,模型會傳回字串「world」,並在開頭加上空格,因為「hello world」比「hello word」更有意義。

請提供盡可能長的上下文前置字串,最多 20 個半形字元 (含空格)。如果字串較長,辨識器只會使用最後 20 個字元。

以下程式碼範例說明如何定義書寫區域,並使用 RecognitionContext 物件指定預先設定的內容。

Swift

let ink: Ink = ...;
let recognizer: DigitalInkRecognizer =  ...;
let preContext: String = ...;
let writingArea = WritingArea.init(width: ..., height: ...);

let context: DigitalInkRecognitionContext.init(
    preContext: preContext,
    writingArea: writingArea);

recognizer.recognizeHandwriting(
  from: ink,
  context: context,
  completion: {
    (result: DigitalInkRecognitionResult?, error: Error?) in
    if let result = result, let candidate = result.candidates.first {
      NSLog("Recognized \(candidate.text)")
    } else {
      NSLog("Recognition error \(error)")
    }
  })

Objective-C

MLKInk *ink = ...;
MLKDigitalInkRecognizer *recognizer = ...;
NSString *preContext = ...;
MLKWritingArea *writingArea = [MLKWritingArea initWithWidth:...
                                              height:...];

MLKDigitalInkRecognitionContext *context = [MLKDigitalInkRecognitionContext
       initWithPreContext:preContext
       writingArea:writingArea];

[recognizer recognizeHandwritingFromInk:ink
            context:context
            completion:^(MLKDigitalInkRecognitionResult
                         *_Nullable result, NSError *_Nullable error) {
                               NSLog(@"Recognition result %@",
                                     result.candidates[0].text);
                         }];

筆劃排序

辨識準確度會受到筆劃順序的影響。辨識器會預期筆劃會以人們自然書寫的順序出現,例如英文是從左至右書寫。任何不符合此模式的情況 (例如以最後一個字詞開始撰寫英文句子),都會導致結果不夠準確。

另一個例子是當 Ink 中間的字詞遭到移除,並替換成其他字詞時。修訂內容可能位於句子中間,但修訂筆劃位於筆劃序列的結尾。在這種情況下,建議您將新寫入的字詞分別傳送至 API,並使用自己的邏輯將結果與先前的辨識結果合併。

處理不確定形狀

在某些情況下,向辨識器提供的形狀意義不明確。舉例來說,圓角邊緣的矩形可能會被視為矩形或橢圓形。

在這種不確定的情況下,您可以使用辨識分數 (如有) 處理。只有形狀分類器會提供分數。如果模型非常有信心,則最高分數的得分會比次佳分數高出許多。如果不確定,前兩個結果的分數會很接近。另外,請注意,形狀分類器會將整個 Ink 解讀為單一形狀。舉例來說,如果 Ink 包含矩形和橢圓形,且兩者相鄰,則辨識器可能會傳回其中一個 (或完全不同的結果),因為單一辨識候選項目無法代表兩個形狀。