TextEmbedder

מחלקה סופית ציבורית TextEmbedder

מבצע חילוץ הטמעה בטקסט.

ה-API הזה מצפה למודל TFLite עם המטא-נתונים של מודל TFLite (אופציונלי).

חובה למלא מטא-נתונים במודלים עם גורמי קלט מסוג int32, כי הם מכילים את יחידת תהליך הקלט של האסימון של המודל. אין צורך במטא-נתונים במודלים עם מחרוזות קלט של מחרוזות.

  • רכיבי tensor לקלט
    • שלושה גורמי קלט (kTfLiteInt32) בצורה [batch_size x bert_max_seq_len] שמייצגים את מזהי הקלט, את מזהי המסכות ואת מזהי הפלחים. לחתימת הקלט הזו נדרשת יחידת תהליך של Bert Tokenizer במטא-נתונים של המודל.
    • או טנזור אחד של קלט (kTfLiteInt32) בצורה [batch_size x max_seq_len] שמייצג את מזהי הקלט. חתימת הקלט הזו מחייבת יחידת תהליך של אסימון ביטוי רגולרי במטא-נתונים של המודל.
    • או טנזור קלט אחד (kTfLiteString) ללא צורה או בעל צורה [1] שמכילה את מחרוזת הקלט.
  • לפחות tensor פלט אחד (kTfLiteFloat32/kTfLiteUint8) עם צורה [1 x N] כאשר N הוא מספר הממדים בהטמעות שנוצרו.

מחלקות מקננות

מחלקה TextEmbedder.TextEmbedderOptions האפשרויות להגדרת TextEmbedder. 

שיטות ציבוריות

void
close()
סוגר ומנקה את TextEmbedder.
סטטי כפול
cosineSimilarity(הטמעה u, הטמעה v)
פונקציית עזר לחישוב דמיון קוסינוס בין שני אובייקטים מסוג Embedding.
סטטי TextEmbedder
createFromFile(Context context, String modelPath)
יצירת מכונת TextEmbedder מקובץ מודל וברירת המחדל TextEmbedder.TextEmbedderOptions.
סטטי TextEmbedder
createFromFile(הקשר Context, File modelFile)
יצירת מכונת TextEmbedder מקובץ מודל וברירת המחדל TextEmbedder.TextEmbedderOptions.
סטטי TextEmbedder
createFromOptions(הקשר הקשר, TextEmbedder.TextEmbedderOptions אפשרויות)
יצירת מכונה של TextEmbedder מ-TextEmbedder.TextEmbedderOptions.
TextEmbedderResult
embed(String inputText)
מבצע חילוץ הטמעה בטקסט הקלט.

שיטות שעברו בירושה

שיטות ציבוריות

public void סגירה ()

סוגר ומנקה את TextEmbedder.

public סטטי כפול cosineSimilarity (הטמעה u, הטמעה v)

פונקציית עזר לחישוב דמיון קוסינוס בין שני אובייקטים מסוג Embedding.

פרמטרים
u
v
קליעות
IllegalArgumentException אם ההטמעות הן מסוגים שונים (float לעומת קוונטי), יש להן גדלים שונים או שיש להן נורמה L2 של 0.

Public סטטי TextEmbedder createFromFile (הקשר הקשר, String modelPath)

יצירת מכונת TextEmbedder מקובץ מודל וברירת המחדל TextEmbedder.TextEmbedderOptions.

פרמטרים
context ERROR(/Context) של Android.
modelPath אל מודל הטקסט עם המטא-נתונים בנכסים.
קליעות
אם יש שגיאה במהלך היצירה של TextEmbedder.

Public סטטי TextEmbedder createFromFile (הקשר הקשר, קובץ modelFile)

יצירת מכונת TextEmbedder מקובץ מודל וברירת המחדל TextEmbedder.TextEmbedderOptions.

פרמטרים
context ERROR(/Context) של Android.
modelFile במופע של מודל הטקסט File.
קליעות
IOException אם מתרחשת שגיאת קלט/פלט בזמן פתיחה של קובץ מודל ה-tflite.
אם יש שגיאה במהלך היצירה של TextEmbedder.

ציבורי סטטי TextEmbedder createFromOptions (הקשר הקשר, TextEmbedder.TextEmbedderOptions אפשרויות)

יצירת מכונה של TextEmbedder מ-TextEmbedder.TextEmbedderOptions.

פרמטרים
context ERROR(/Context) של Android.
אפשרויות מופע של TextEmbedder.TextEmbedderOptions.
קליעות
אם יש שגיאה במהלך היצירה של TextEmbedder.

Public TextEmbedderResult הטמעה (StringinputText)

מבצע חילוץ הטמעה בטקסט הקלט.

פרמטרים
inputText String לעיבוד.