TextClassifier

public final class TextClassifier

テキストに対して分類を実行します。

この API は、必須(後述)の入力テンソル、出力テンソル、オプション(ただし推奨)のラベル項目を出力分類テンソルごとに TENSOR_AXIS_LABELS 型の AssociatedFiles として含む、(オプションの)TFLite Model Metadata を持つ TFLite モデルを想定しています。

int32 入力テンソルを使用するモデルには、モデルのトークナイザの入力プロセス単位が含まれているため、メタデータが必要です。文字列入力テンソルを使用するモデルにメタデータは必要ありません。

  • 入力テンソル
    • 入力 ID、マスク ID、セグメント ID を表す、形状 [batch_size x bert_max_seq_len] の 3 つの入力テンソル(kTfLiteInt32)。この入力署名には、モデル メタデータに BERT Tokenizer プロセス ユニットが必要です。
    • または、入力 ID を表す形 [batch_size x max_seq_len] の 1 つの入力テンソル(kTfLiteInt32)。この入力署名には、モデル メタデータに Regex Tokenizer プロセス ユニットが必要です。
    • または、シェイプレス、または入力文字列を含む形状 [1] の 1 つの入力テンソル(kTfLiteString)。
  • 次の条件を満たす 1 つ以上の出力テンソル(kTfLiteFloat32/kBool):
    • N クラスとシェイプ [1 x N]
    • オプション(ただし推奨)のラベルマップを、TENSOR_AXIS_LABELS タイプの AssociatedFile-s として指定し、1 行に 1 つのラベルを含めます。最初のそのような AssociatedFile(存在する場合)が、結果の class_name フィールドに入力されます。display_name フィールドは、作成時に使用された TextClassifierOptionsdisplay_names_locale フィールド(デフォルトでは「en」)とロケールが一致する AssociatedFile(存在する場合)から入力されます(デフォルトでは英語)。これらのいずれも使用できない場合は、結果の index フィールドのみが入力されます。

ネストされたクラス

クラス TextClassifier.TextClassifierOptions TextClassifier の設定オプション。 

パブリック メソッド

TextClassifierResult
classifyString inputText)
入力テキストに対して分類を実行します。
void
close()
TextClassifier を閉じてクリーンアップします。
static TextClassifier
createFromFile(コンテキスト コンテキスト、String modelPath)
モデルファイルとデフォルトの TextClassifier.TextClassifierOptions から TextClassifier インスタンスを作成します。
static TextClassifier
createFromFile(コンテキスト コンテキスト、File modelFile)
モデルファイルとデフォルトの TextClassifier.TextClassifierOptions から TextClassifier インスタンスを作成します。
static TextClassifier
createFromOptions(コンテキスト コンテキスト、TextClassifier.TextClassifierOptions オプション)
TextClassifier.TextClassifierOptions から TextClassifier インスタンスを作成します。

継承されるメソッド

パブリック メソッド

public TextClassifierResult classify (String inputText)

入力テキストに対して分類を実行します。

パラメータ
inputText 処理する String

public void close ()

TextClassifier を閉じてクリーンアップします。

public static TextClassifier createFromFile (コンテキスト コンテキスト、String modelPath)

モデルファイルとデフォルトの TextClassifier.TextClassifierOptions から TextClassifier インスタンスを作成します。

パラメータ
コンテキスト Android ERROR(/Context)
modelPath アセットにメタデータを含むテキストモデルへのパス。
例外
TextClassifier の作成中にエラーが発生した場合。

public static TextClassifier createFromFile (コンテキスト コンテキスト、File modelFile)

モデルファイルとデフォルトの TextClassifier.TextClassifierOptions から TextClassifier インスタンスを作成します。

パラメータ
コンテキスト Android ERROR(/Context)
modelFile テキストモデルの File インスタンス。
例外
IOException tflite モデルファイルを開くときに I/O エラーが発生した場合
TextClassifier の作成中にエラーが発生した場合。

public static TextClassifier createFromOptions (コンテキスト コンテキスト、TextClassifier.TextClassifierOptions オプション)

TextClassifier.TextClassifierOptions から TextClassifier インスタンスを作成します。

パラメータ
コンテキスト Android ERROR(/Context)
オプション TextClassifier.TextClassifierOptions インスタンス。
例外
TextClassifier の作成中にエラーが発生した場合。