TextSearcher

パブリック最終クラスTextSearcher

文字列の類似検索を実行します。

API は、オプションではあるが強く推奨される TFLiteモデル メタデータを備えた TFLite モデルを想定しています。 。

API は、メタデータが設定された TFLite モデルを想定しています。メタデータには次の情報が含まれている必要があります。

  • Bert ベースの TFLite モデルの場合:
    • 「ids」、「mask」、「segment_ids」という名前を持つ kTfLiteString 型の 3 つの入力テンソル。
    • ワードピース/センテンスピーストークナイザーの input_process_units
    • kTfLiteFloat32 型の出力テンソルを 1 つだけ
  • Regex ベースの TFLite モデルの場合:
    • 1 入力テンソル。
    • RegexTokenizer トークナイザーの input_process_units
    • kTfLiteFloat32 型の出力テンソルを 1 つだけ
  • Universal Sentence Encoder ベースの TFLite モデルの場合:
    • 「inp_text」、「res_context」、「res_text」という名前の 3 つの入力テンソル
    • kTfLiteFloat32 型の名前「query_encoding」および「response_encoding」を持つ 2 つの出力テンソル

TODO(b/180502532): サンプル モデルへのポインターを追加します。

TODO(b/222671076): 単一のファイル形式 (モデルにパックされたインデックス ファイル) がサポートされたら、`createFromFile` などのオプションなしのファクトリ作成メソッドを追加します。

ネストされたクラス

クラスTextSearcher.TextSearcherOptions TextSearcher をセットアップするためのオプション。

パブリックメソッド

静的TextSearcher
createFromBufferAndOptions ( ByteBuffer modelBuffer、 TextSearcher.TextSearcherOptionsオプション)
モデル バッファーとTextSearcher.TextSearcherOptionsを使用してTextSearcherインスタンスを作成します。
静的TextSearcher
createFromBufferAndOptionsImpl ( ByteBuffer modelBuffer、 TextSearcher.TextSearcherOptionsオプション、intindexFd)
静的TextSearcher
createFromFileAndOptions (ファイルモデルファイル、 TextSearcher.TextSearcherOptionsオプション)
TextSearcherインスタンスを作成します。
静的TextSearcher
createFromFileAndOptions (コンテキスト コンテキスト、文字列モデルパス、 TextSearcher.TextSearcherOptionsオプション)
TextSearcher.TextSearcherOptionsからTextSearcherインスタンスを作成します。
リスト<最近隣>
検索(文字列テキスト)
指定された文字列入力に対して埋め込み抽出を実行し、続いてインデックス内の最近傍検索を実行します。

継承されたメソッド

パブリックメソッド

public static TextSearcher createFromBufferAndOptions ( ByteBuffer modelBuffer、 TextSearcher.TextSearcherOptionsオプション)

モデル バッファーとTextSearcher.TextSearcherOptionsを使用してTextSearcherインスタンスを作成します。

パラメーター
モデルバッファ検索モデルの直接ByteBufferまたはMappedByteBuffer
オプション
投げる
IllegalArgumentExceptionモデル バッファーが直接ByteBufferまたはMappedByteBufferではない場合
IO例外インデックスファイルのロード時にI/Oエラーが発生した場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合

public static TextSearcher createFromBufferAndOptionsImpl ( ByteBuffer modelBuffer、 TextSearcher.TextSearcherOptions options、intindexFd)

パラメーター
モデルバッファ
オプション
インデックスFD

public static TextSearcher createFromFileAndOptions (ファイルモデルファイル、 TextSearcher.TextSearcherOptionsオプション)

TextSearcherインスタンスを作成します。

パラメーター
モデルファイル検索モデルFileインスタンス
オプション
投げる
IO例外tflite モデルまたはインデックス ファイルのロード時に I/O エラーが発生した場合
IllegalArgumentException引数が無効な場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合

public static TextSearcher createFromFileAndOptions (コンテキスト コンテキスト、文字列モデルパス、 TextSearcher.TextSearcherOptionsオプション)

TextSearcher.TextSearcherOptionsからTextSearcherインスタンスを作成します。

パラメーター
コンテクスト
モデルパスアセット内のメタデータを含む検索モデルのパス
オプション
投げる
IO例外tflite モデルまたはインデックス ファイルのロード時に I/O エラーが発生した場合
IllegalArgumentException引数が無効な場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合

public List <NearestNeighbor>検索(文字列テキスト)

指定された文字列入力に対して埋め込み抽出を実行し、続いてインデックス内の最近傍検索を実行します。

パラメーター
文章モデルにテキストクエリを入力します