このページは Cloud Translation API によって翻訳されました。

ML Kit を使用してデジタルインクを認識する（iOS）

ML Kit のデジタルインク認識を使用すると、数百もの言語でデジタル表示面の手書き文字を認識できるほか、スケッチを分類することもできます。

試してみる

サンプルアプリを試して、この API の使用例を確認してください。

始める前に

Podfile に次の ML Kit ライブラリを含めます。
```
pod 'GoogleMLKit/DigitalInkRecognition', '7.0.0'
```
プロジェクトの Pod をインストールまたは更新した後に、.xcworkspace を使用して Xcode プロジェクトを開きます。ML Kit は Xcode バージョン 13.2.1 以降でサポートされています。

これで、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.");
                                }];
}

テキスト認識の精度を高めるためのヒント

テキスト認識の精度は、言語によって異なる場合があります。精度は文章のスタイルにも依存します。デジタルインク認識はさまざまな書き込みスタイルに対応するようにトレーニングされていますが、結果はユーザーによって異なる場合があります。

テキスト認識の精度を高める方法は次のとおりです。これらの手法は、絵文字、自動描画、図形の描画分類には適用されません。

書き込み領域

多くのアプリには、ユーザー入力用の明確な書き込み領域があります。記号の意味は、記号を含む書き込み領域のサイズに対する記号のサイズによって部分的に決まります。たとえば、小文字または大文字の「o」または「c」、カンマとスラッシュの違いなどです。

認識ツールに書き込み領域の幅と高さを指定すると、精度が向上します。ただし、認識ツールは、書き込み領域に 1 行のテキストのみが含まれていることを前提としています。物理的な書き込み領域が 2 行以上書けるほど十分な大きさの場合は、1 行のテキストの高さを推定できる高さの WritingArea を渡すと、より良い結果が得られます。認識ツールに渡す WritingArea オブジェクトは、画面上の物理的な書き込み領域と完全に一致している必要はありません。このように WritingArea の高さを変更すると、言語によっては効果が異なります。

書き込み領域を指定する場合は、ストロークの座標と同じ単位で幅と高さを指定します。x 座標と y 座標の引数には単位の指定は必要ありません。API はすべての単位を正規化するため、重要なのはストロークの相対サイズと位置のみです。システムに適したスケールで座標を渡すことができます。

前のコンテキスト

前コンテキストは、認識しようとしている Ink のストロークの直前に続くテキストです。認識ツールに前のコンテキストを伝えることで、認識を支援できます。

たとえば、筆記体では「n」と「u」がよく間違えられます。ユーザーがすでに単語の一部「arg」を入力している場合、ユーザーは「ument」または「nment」と認識されるストロークを続けて入力する可能性があります。前コンテキスト「arg」を指定すると、単語「argument」の方が「argnment」よりも可能性が高いため、あいまいさが解消されます。

前コンテキストは、認識ツールが単語の切れ目や単語間のスペースを特定する際にも役立ちます。スペース文字は入力できますが、描画することはできません。認識ツールは、1 つの単語が終了して次の単語が始まるタイミングをどのように判断するのでしょうか。ユーザーがすでに「hello」と書いていて、続けて「world」と書いた場合、認識ツールは前後の文脈なしで「world」という文字列を返します。ただし、前コンテキスト「hello」を指定すると、モデルは先頭にスペースが付いた「world」という文字列を返します。これは、「helloword」よりも「hello world」の方が意味があるためです。

できるだけ長い前コンテキスト文字列を指定します。最大 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 に個別に送信し、独自のロジックを使用して結果を以前の認識と統合することをおすすめします。

曖昧な形状に対処する

認識ツールに提供されたシェイプの意味があいまいな場合があります。たとえば、角が非常に丸い長方形は、長方形または楕円形のいずれかとして認識される可能性があります。

このような不明なケースは、認識スコアが利用可能な場合は、そのスコアを使用して処理できます。スコアを提供するのは形状分類子のみです。モデルの信頼度が高い場合、上位の結果のスコアは 2 番目に良い結果のスコアよりもはるかに高くなります。不確実性が高い場合、上位 2 つの結果のスコアは近くなります。また、形状分類子は Ink 全体を単一の形状として解釈します。たとえば、Ink に長方形と楕円が隣接して含まれている場合、単一の認識候補で 2 つの形状を表すことができないため、認識ツールはどちらか（またはまったく異なるもの）を結果として返すことがあります。

ML Kit を使用してデジタルインクを認識する（iOS）

試してみる

始める前に

Ink オブジェクトを作成する

Swift

Objective-C

DigitalInkRecognizer のインスタンスを取得する

Swift

Objective-C

Ink オブジェクトを認識する

Swift

Objective-C

モデルのダウンロードの管理

モデルがすでにダウンロードされているかどうかを確認する

Swift

Objective-C

ダウンロードしたモデルを削除する

Swift

Objective-C

テキスト認識の精度を高めるためのヒント

書き込み領域

前のコンテキスト

Swift

Objective-C

ストロークの順序

曖昧な形状に対処する

`Ink` オブジェクトを作成する

`DigitalInkRecognizer` のインスタンスを取得する

`Ink` オブジェクトを認識する