TextSearcher

TextSearcher ระดับสุดท้ายสาธารณะ

ดำเนินการค้นหาความคล้ายคลึงกับสตริงข้อความ

API คาดว่าจะมีโมเดล TFLite พร้อมด้วย ข้อมูลเมตาของโมเดล TFLite ที่ไม่บังคับ แต่แนะนำอย่างยิ่ง .

API คาดว่าจะมีโมเดล TFLite ที่มีข้อมูลเมตาที่เติมไว้ ข้อมูลเมตาควรมีข้อมูลต่อไปนี้:

  • สำหรับรุ่น TFLite ที่ใช้ Bert:
    • เทนเซอร์อินพุต 3 ตัวประเภท kTfLiteString ที่มีชื่อ "ids", "mask" และ "segment_ids"
    • input_process_units สำหรับ Tokenizer ของ Wordpiece/Sentencepiece
    • เทนเซอร์เอาต์พุตประเภท kTfLiteFloat32 หนึ่งตัวเท่านั้น
  • สำหรับโมเดล TFLite ที่ใช้ Regex:
    • 1 เทนเซอร์อินพุต
    • input_process_units สำหรับ RegexTokenizer Tokenizer
    • เทนเซอร์เอาต์พุตประเภท kTfLiteFloat32 หนึ่งตัวเท่านั้น
  • สำหรับรุ่น TFLite ที่ใช้ Universal Sentence Encoder:
    • เทนเซอร์อินพุต 3 ตัวที่มีชื่อ "inp_text", "res_context" และ "res_text"
    • เทนเซอร์เอาต์พุต 2 ตัวที่มีชื่อ "query_encoding" และ "response_encoding" ประเภท kTfLiteFloat32

TODO(b/180502532): เพิ่มตัวชี้ไปที่โมเดลตัวอย่าง

TODO(b/222671076): เพิ่มวิธีการสร้างจากโรงงานโดยไม่มีตัวเลือก เช่น `createFromFile` เมื่อรองรับรูปแบบไฟล์เดียว (ไฟล์ดัชนีที่บรรจุในโมเดล)

คลาสที่ซ้อนกัน

ระดับ TextSearcher.TextSearcherOptions ตัวเลือกสำหรับการตั้งค่า TextSearcher

วิธีการสาธารณะ

TextSearcher แบบคงที่
createFromBufferAndOptions (ตัวเลือก ByteBuffer modelBuffer, TextSearcher.TextSearcherOptions )
สร้างอินสแตนซ์ TextSearcher ด้วยบัฟเฟอร์โมเดลและ TextSearcher.TextSearcherOptions
TextSearcher แบบคงที่
createFromBufferAndOptionsImpl ( ByteBuffer modelBuffer, ตัวเลือก TextSearcher.TextSearcherOptions , int indexFd)
TextSearcher แบบคงที่
createFromFileAndOptions ( ตัวเลือก ไฟล์ modelFile, TextSearcher.TextSearcherOptions )
สร้างอินสแตนซ์ TextSearcher
TextSearcher แบบคงที่
createFromFileAndOptions (บริบทบริบท ตัวเลือก modelPath สตริง ตัวเลือก TextSearcher.TextSearcherOptions )
สร้างอินสแตนซ์ TextSearcher จาก TextSearcher.TextSearcherOptions
รายการ < เพื่อนบ้านที่ใกล้ที่สุด >
ค้นหา (ข้อความ สตริง )
ดำเนินการแยกการฝังบนอินพุตสตริงที่ให้มา ตามด้วยการค้นหาเพื่อนบ้านที่ใกล้ที่สุดในดัชนี

วิธีการสืบทอด

วิธีการสาธารณะ

TextSearcher แบบคงที่สาธารณะ createFromBufferAndOptions (ตัวเลือก ByteBuffer modelBuffer, TextSearcher.TextSearcherOptions )

สร้างอินสแตนซ์ TextSearcher ด้วยบัฟเฟอร์โมเดลและ TextSearcher.TextSearcherOptions

พารามิเตอร์
modelBuffer ByteBuffer โดยตรงหรือ MappedByteBuffer ของโมเดลการค้นหา
ตัวเลือก
ขว้าง
ข้อยกเว้นอาร์กิวเมนต์ที่ผิดกฎหมาย หากบัฟเฟอร์โมเดลไม่ใช่ ByteBuffer โดยตรงหรือ MappedByteBuffer
IOข้อยกเว้น หากมีข้อผิดพลาด I/O เกิดขึ้นเมื่อโหลดไฟล์ดัชนี
IllegalStateException หากมีข้อผิดพลาดภายใน
RuntimeException หากมีข้อผิดพลาดที่ไม่ได้ระบุเป็นอย่างอื่น

TextSearcher แบบคงที่สาธารณะ createFromBufferAndOptionsImpl ( ByteBuffer modelBuffer, ตัวเลือก TextSearcher.TextSearcherOptions , int indexFd)

พารามิเตอร์
modelBuffer
ตัวเลือก
ดัชนีFd

TextSearcher แบบคงที่สาธารณะ createFromFileAndOptions (ตัวเลือก ไฟล์ modelFile, TextSearcher.TextSearcherOptions )

สร้างอินสแตนซ์ TextSearcher

พารามิเตอร์
modelFile อินสแตนซ์ File โมเดลการค้นหา
ตัวเลือก
ขว้าง
IOข้อยกเว้น หากมีข้อผิดพลาด I/O เกิดขึ้นเมื่อโหลดโมเดล tflite หรือไฟล์ดัชนี
ข้อยกเว้นอาร์กิวเมนต์ที่ผิดกฎหมาย ถ้าอาร์กิวเมนต์ไม่ถูกต้อง
IllegalStateException หากมีข้อผิดพลาดภายใน
RuntimeException หากมีข้อผิดพลาดที่ไม่ได้ระบุเป็นอย่างอื่น

TextSearcher แบบคงที่สาธารณะ createFromFileAndOptions (บริบทบริบท, สตริง modelPath, ตัวเลือก TextSearcher.TextSearcherOptions )

สร้างอินสแตนซ์ TextSearcher จาก TextSearcher.TextSearcherOptions

พารามิเตอร์
บริบท
โมเดลพาธ เส้นทางของโมเดลการค้นหาพร้อมข้อมูลเมตาในเนื้อหา
ตัวเลือก
ขว้าง
IOข้อยกเว้น หากมีข้อผิดพลาด I/O เกิดขึ้นเมื่อโหลดโมเดล tflite หรือไฟล์ดัชนี
ข้อยกเว้นอาร์กิวเมนต์ที่ผิดกฎหมาย ถ้าอาร์กิวเมนต์ไม่ถูกต้อง
IllegalStateException หากมีข้อผิดพลาดภายใน
RuntimeException หากมีข้อผิดพลาดที่ไม่ได้ระบุเป็นอย่างอื่น

รายการ สาธารณะ < NearestNeighbor > ค้นหา (ข้อความ สตริง )

ดำเนินการแยกการฝังบนอินพุตสตริงที่ให้มา ตามด้วยการค้นหาเพื่อนบ้านที่ใกล้ที่สุดในดัชนี

พารามิเตอร์
ข้อความ ป้อนข้อความค้นหาให้กับโมเดล