TextEmbedder

公開最終類別 TextEmbedder

執行文字的嵌入擷取作業。

這個 API 預期的 TFLite 模型為 (選用) TFLite 模型中繼資料

含有 int32 輸入張量的模型必須具備中繼資料,因為其中含有模型權杖化工具的輸入程序單位。具備字串輸入張量的模型不需要中繼資料。

  • 輸入張量
    • 形狀 [batch_size x bert_max_seq_len] 的三個輸入張量 (kTfLiteInt32),代表輸入 ID、遮罩 ID 和區隔 ID。這項輸入簽章需要模型中繼資料中的 BERT 權杖化工具程序單元。
    • 或是形狀 [batch_size x max_seq_len] 的一個輸入張量 (kTfLiteInt32),代表輸入 ID。這項輸入簽章需要模型中繼資料中的規則運算式權杖化工具程序單元。
    • 或者一個無形狀的輸入張量 (kTfLiteString),或形狀 [1] 包含輸入字串。
  • 至少一個輸出張量 (kTfLiteFloat32/kTfLiteUint8) 為 [1 x N],其中 N 是所產生嵌入中的維度數量。

巢狀類別

類別 TextEmbedder.TextEmbedderOptions 設定 TextEmbedder 的選項。 

公用方法

void
close()
關閉並清理 TextEmbedder
Static Double
cosineSimilarity(嵌入 u, 嵌入 v)
計算兩個 Embedding 物件之間的餘弦相似度的公用程式。
static TextEmbedder
createFromFile(背景資訊、String modelPath)
從模型檔案和預設的 TextEmbedder.TextEmbedderOptions 建立 TextEmbedder 例項。
static TextEmbedder
createFromFile(背景資訊、檔案 modelFile)
從模型檔案和預設的 TextEmbedder.TextEmbedderOptions 建立 TextEmbedder 例項。
static TextEmbedder
TextEmbedderResult
embed(String inputText)
對輸入文字執行嵌入擷取。

繼承的方法

公用方法

public void close ()

關閉並清理 TextEmbedder

public static Double cosineSimilarity (Embedding u, Embedding v)

計算兩個 Embedding 物件之間的餘弦相似度的公用程式。

參數
u
v
擲回
IllegalArgumentException 如果嵌入屬於不同類型 (浮動與量化)、有不同大小,或 L2 常態為 0,就會傳回結果。

public static TextEmbedder createFromFile (內容結構定義、String modelPath)

從模型檔案和預設的 TextEmbedder.TextEmbedderOptions 建立 TextEmbedder 例項。

參數
context Android ERROR(/Context)
modelPath 含有中繼資料的文字模型路徑
擲回
如果 TextEmbedder 建立期間發生錯誤。

public static TextEmbedder createFromFile (內容結構定義、檔案 modelFile)

從模型檔案和預設的 TextEmbedder.TextEmbedderOptions 建立 TextEmbedder 例項。

參數
context Android ERROR(/Context)
modelFile 文字模型 File 例項
擲回
IOException 在開啟 tflite 模型檔案時發生 I/O 錯誤時。
如果 TextEmbedder 建立期間發生錯誤。

public static TextEmbedder createFromOptions (內容結構定義、TextEmbedder.TextEmbedderOptions 選項)

參數
context Android ERROR(/Context)
選項 TextEmbedder.TextEmbedderOptions 執行個體。
擲回
如果 TextEmbedder 建立期間發生錯誤。

public TextEmbedderResult embed (String inputText)

對輸入文字執行嵌入擷取。

參數
inputText 用於處理的 String