TextEmbedder

public final class TextEmbedder

テキストに対してエンベディング抽出を実行します。

この API は、TFLite モデル メタデータ（オプション）を持つ 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 x N] の少なくとも 1 つの出力テンソル（kTfLiteFloat32/kTfLiteUint8）。ここで、N は生成されたエンベディングの次元数です。

ネストされたクラス

クラス TextEmbedder.TextEmbedderOptions TextEmbedder の設定オプション。 

パブリック メソッド

void
close()
TextEmbedder を閉じてクリーンアップします。
static double
cosineSimilarity（Embedding u、Embedding v）
2 つの Embedding オブジェクト間のコサイン類似度を計算するユーティリティ関数。
static TextEmbedder
createFromFile（コンテキスト コンテキスト、String modelPath）
モデルファイルとデフォルトの TextEmbedder.TextEmbedderOptions から TextEmbedder インスタンスを作成します。
static TextEmbedder
createFromFile（コンテキスト コンテキスト、File modelFile）
モデルファイルとデフォルトの TextEmbedder.TextEmbedderOptions から TextEmbedder インスタンスを作成します。
static TextEmbedder
createFromOptions（コンテキスト コンテキスト、TextEmbedder.TextEmbedderOptions オプション）
TextEmbedder.TextEmbedderOptions から TextEmbedder インスタンスを作成します。
TextEmbedderResult
embed(String inputText)
入力テキストに対してエンベディング抽出を実行します。

継承されるメソッド

パブリック メソッド

public void close ()

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

public static double cosineSimilarity （Embedding u、Embedding v）

2 つの Embedding オブジェクト間のコサイン類似度を計算するユーティリティ関数。

パラメータ
u
v
例外
IllegalArgumentException エンベディングのタイプ（浮動小数点数と量子化タイプ）、サイズ、L2 ノルムが 0 の場合。

public static TextEmbedder createFromFile （コンテキスト コンテキスト、文字列 modelPath）

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

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

public static TextEmbedder createFromFile （コンテキスト コンテキスト、File modelFile）

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

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

public static TextEmbedder createFromOptions （コンテキスト コンテキスト、TextEmbedder.TextEmbedderOptions オプション）

TextEmbedder.TextEmbedderOptions から TextEmbedder インスタンスを作成します。

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

public TextEmbedderResult embed (String inputText)

入力テキストに対してエンベディング抽出を実行します。

パラメータ
inputText 処理する String。