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

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

立即體驗

事前準備

  1. 在專案層級的 build.gradle 檔案中,請務必在 buildscriptallprojects 區段中加入 Google 的 Maven 存放區。
  2. 將 ML Kit Android 程式庫的依附元件新增至模組的應用程式層級的 Gradle 檔案 (通常為 app/build.gradle):
dependencies {
  // ...
  implementation 'com.google.mlkit:digital-ink-recognition:18.1.0'
}

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

建構 Ink 物件

建構 Ink 物件的主要方法是在觸控螢幕上繪製。在 Android 上,您可以使用畫布來達成此目的。您的觸控事件處理常式應呼叫下列程式碼片段顯示的 addNewTouchEvent() 方法,以在使用者繪製到 Ink 物件中的筆劃內儲存點。

以下程式碼片段將展示這種一般模式。如需更完整的範例,請參閱 ML Kit 快速入門導覽課程範例

Kotlin

var inkBuilder = Ink.builder()
lateinit var strokeBuilder: Ink.Stroke.Builder

// Call this each time there is a new event.
fun addNewTouchEvent(event: MotionEvent) {
  val action = event.actionMasked
  val x = event.x
  val y = event.y
  var t = System.currentTimeMillis()

  // If your setup does not provide timing information, you can omit the
  // third paramater (t) in the calls to Ink.Point.create
  when (action) {
    MotionEvent.ACTION_DOWN -> {
      strokeBuilder = Ink.Stroke.builder()
      strokeBuilder.addPoint(Ink.Point.create(x, y, t))
    }
    MotionEvent.ACTION_MOVE -> strokeBuilder!!.addPoint(Ink.Point.create(x, y, t))
    MotionEvent.ACTION_UP -> {
      strokeBuilder.addPoint(Ink.Point.create(x, y, t))
      inkBuilder.addStroke(strokeBuilder.build())
    }
    else -> {
      // Action not relevant for ink construction
    }
  }
}

...

// This is what to send to the recognizer.
val ink = inkBuilder.build()

Java

Ink.Builder inkBuilder = Ink.builder();
Ink.Stroke.Builder strokeBuilder;

// Call this each time there is a new event.
public void addNewTouchEvent(MotionEvent event) {
  float x = event.getX();
  float y = event.getY();
  long t = System.currentTimeMillis();

  // If your setup does not provide timing information, you can omit the
  // third paramater (t) in the calls to Ink.Point.create
  int action = event.getActionMasked();
  switch (action) {
    case MotionEvent.ACTION_DOWN:
      strokeBuilder = Ink.Stroke.builder();
      strokeBuilder.addPoint(Ink.Point.create(x, y, t));
      break;
    case MotionEvent.ACTION_MOVE:
      strokeBuilder.addPoint(Ink.Point.create(x, y, t));
      break;
    case MotionEvent.ACTION_UP:
      strokeBuilder.addPoint(Ink.Point.create(x, y, t));
      inkBuilder.addStroke(strokeBuilder.build());
      strokeBuilder = null;
      break;
  }
}

...

// This is what to send to the recognizer.
Ink ink = inkBuilder.build();

取得 DigitalInkRecognizer 執行個體

如要執行辨識作業,請將 Ink 例項傳送至 DigitalInkRecognizer 物件。以下程式碼顯示如何從 BCP-47 標記將這類辨識工具例項化。

Kotlin

// Specify the recognition model for a language
var modelIdentifier: DigitalInkRecognitionModelIdentifier
try {
  modelIdentifier = DigitalInkRecognitionModelIdentifier.fromLanguageTag("en-US")
} catch (e: MlKitException) {
  // language tag failed to parse, handle error.
}
if (modelIdentifier == null) {
  // no model was found, handle error.
}
var model: DigitalInkRecognitionModel =
    DigitalInkRecognitionModel.builder(modelIdentifier).build()


// Get a recognizer for the language
var recognizer: DigitalInkRecognizer =
    DigitalInkRecognition.getClient(
        DigitalInkRecognizerOptions.builder(model).build())

Java

// Specify the recognition model for a language
DigitalInkRecognitionModelIdentifier modelIdentifier;
try {
  modelIdentifier =
    DigitalInkRecognitionModelIdentifier.fromLanguageTag("en-US");
} catch (MlKitException e) {
  // language tag failed to parse, handle error.
}
if (modelIdentifier == null) {
  // no model was found, handle error.
}

DigitalInkRecognitionModel model =
    DigitalInkRecognitionModel.builder(modelIdentifier).build();

// Get a recognizer for the language
DigitalInkRecognizer recognizer =
    DigitalInkRecognition.getClient(
        DigitalInkRecognizerOptions.builder(model).build());

處理 Ink 物件

Kotlin

recognizer.recognize(ink)
    .addOnSuccessListener { result: RecognitionResult ->
      // `result` contains the recognizer's answers as a RecognitionResult.
      // Logs the text from the top candidate.
      Log.i(TAG, result.candidates[0].text)
    }
    .addOnFailureListener { e: Exception ->
      Log.e(TAG, "Error during recognition: $e")
    }

Java

recognizer.recognize(ink)
    .addOnSuccessListener(
        // `result` contains the recognizer's answers as a RecognitionResult.
        // Logs the text from the top candidate.
        result -> Log.i(TAG, result.getCandidates().get(0).getText()))
    .addOnFailureListener(
        e -> Log.e(TAG, "Error during recognition: " + e));

上述程式碼範例假設已下載辨識模型,如下一節所述。

管理模型下載作業

雖然數位墨水辨識 API 支援數百種語言,但每種語言都需要先下載部分資料才能進行辨識。每種語言需要約 20 MB 的儲存空間。這項作業是由 RemoteModelManager 物件處理。

下載新模型

Kotlin

import com.google.mlkit.common.model.DownloadConditions
import com.google.mlkit.common.model.RemoteModelManager

var model: DigitalInkRecognitionModel =  ...
val remoteModelManager = RemoteModelManager.getInstance()

remoteModelManager.download(model, DownloadConditions.Builder().build())
    .addOnSuccessListener {
      Log.i(TAG, "Model downloaded")
    }
    .addOnFailureListener { e: Exception ->
      Log.e(TAG, "Error while downloading a model: $e")
    }

Java

import com.google.mlkit.common.model.DownloadConditions;
import com.google.mlkit.common.model.RemoteModelManager;

DigitalInkRecognitionModel model = ...;
RemoteModelManager remoteModelManager = RemoteModelManager.getInstance();

remoteModelManager
    .download(model, new DownloadConditions.Builder().build())
    .addOnSuccessListener(aVoid -> Log.i(TAG, "Model downloaded"))
    .addOnFailureListener(
        e -> Log.e(TAG, "Error while downloading a model: " + e));

檢查模型是否已下載

Kotlin

var model: DigitalInkRecognitionModel =  ...
remoteModelManager.isModelDownloaded(model)

Java

DigitalInkRecognitionModel model = ...;
remoteModelManager.isModelDownloaded(model);

刪除已下載的模型

從裝置的儲存空間中移除模型即可釋出空間。

Kotlin

var model: DigitalInkRecognitionModel =  ...
remoteModelManager.deleteDownloadedModel(model)
    .addOnSuccessListener {
      Log.i(TAG, "Model successfully deleted")
    }
    .addOnFailureListener { e: Exception ->
      Log.e(TAG, "Error while deleting a model: $e")
    }

Java

DigitalInkRecognitionModel model = ...;
remoteModelManager.deleteDownloadedModel(model)
                  .addOnSuccessListener(
                      aVoid -> Log.i(TAG, "Model successfully deleted"))
                  .addOnFailureListener(
                      e -> Log.e(TAG, "Error while deleting a model: " + e));

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

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

歡迎參考下列幾種方法,提昇文字辨識工具的準確度。請注意,這些技巧不適用於表情符號、自動繪圖和形狀的繪圖分類器。

書寫區域

許多應用程式都有定義使用者輸入內容的寫入區域,部分符號的意義有一部分取決於其大小 (相對於包含符號的撰寫區域大小)。例如,小寫或大寫英文字母「o」或「c」,以及逗號與正斜線之間的差異。

告知辨識工具書寫區域的寬度和高度可提高準確度。然而,辨識器會假設寫入區域僅包含單行文字。如果實體寫入區域夠大,讓使用者可以撰寫兩行或更多行,則以最適合單行文字高度預估高度的 WriterArea 傳入,可能會獲得比較好的結果。您傳遞至辨識工具的 WriteArea 物件不需要與螢幕上的實體寫入區域完全相符。在部分語言中,以這種方式變更「寫入區域」高度的效果會更好。

指定書寫區域時,請在與筆劃座標相同的單位中指定寬度和高度。x,y 座標引數沒有任何單位要求 - API 會將所有單位正規化,因此唯一的重點是筆劃的相對大小和位置。您可以依照系統適合的比例,將座標傳入座標。

事前情境

「前置情境」是指在您嘗試辨識的 Ink 中,緊接在筆劃之前的文字。您可以將預先上下文告知辨識工具,協助辨識工具。

例如,草寫字母「n」和「u」通常被誤認為另一個字。如果使用者已輸入部分字詞「arg」,則可能會繼續做出能辨識為「ument」或「nment」的筆劃。指定預先結構定義「arg」可解決模稜兩可的情況,因為「引數」這個字詞可能比「argnment」來得高。

前後脈絡也可協助辨識工具辨識字詞換行,以及字詞之間的空格。輸入空格字元後就無法繪製,這樣辨識器要如何判斷一個字詞結束和下一個字詞開始的時間?如果使用者已編寫「hello」,並持續使用書寫的字詞「world」,則在沒有預先上下文的情況下,辨識器會傳回「world」字串。不過,如果您指定預先上下文「hello」,模型將傳回一個包含空格的字串「 world」,因為「hello world」比「helloword」更有意義。

您應提供最長的預先內容字串,最多 20 個半形字元 (包含空格)。如果字串較長,辨識工具只會使用最後 20 個字元。

以下程式碼範例說明如何定義寫入區域,並使用 RecognitionContext 物件指定預先背景資訊。

Kotlin

var preContext : String = ...;
var width : Float = ...;
var height : Float = ...;
val recognitionContext : RecognitionContext =
    RecognitionContext.builder()
        .setPreContext(preContext)
        .setWritingArea(WritingArea(width, height))
        .build()

recognizer.recognize(ink, recognitionContext)

Java

String preContext = ...;
float width = ...;
float height = ...;
RecognitionContext recognitionContext =
    RecognitionContext.builder()
                      .setPreContext(preContext)
                      .setWritingArea(new WritingArea(width, height))
                      .build();

recognizer.recognize(ink, recognitionContext);

筆劃順序

辨識準確度與筆劃順序相關。辨識器預期筆觸順序會按人們寫作的順序自然,例如由左至右顯示英文。任何從這個模式區分的大小寫 (例如,撰寫以最後一個字詞開頭的英文句子),都會產生較不準確的結果。

另一個例子是,移除 Ink 中間的字詞,並替換為其他字詞。修訂版本可能位於句子中間,但修訂版本筆觸位於筆劃順序的結尾處。在這種情況下,我們建議您將新寫入的字詞單獨傳送至 API,並使用自己的邏輯將結果與先前的辨識合併。

處理模稜兩可的形狀

在某些情況下,提供給辨識器的形狀意義不明確。舉例來說,帶有圓角的矩形可能會以矩形或橢圓形的形式呈現。

如果有這類不明確的案例,您可以使用辨識分數來處理這些不明確的案例。只有形狀分類器會提供分數。如果模型非常有信心,則最高結果的分數會遠高於第二位。如果不確定性,前兩個結果的分數將會接近。此外,請注意,形狀分類器會將整個 Ink 解讀為單一形狀。舉例來說,如果 Ink 含有一個矩形和相鄰的橢圓形,辨識器可能會傳回其中一個 (或完全不同的) 做為結果,因為單一辨識候選項目不能代表兩個形狀。