टेक्स्ट के किसी हिस्से का विश्लेषण करने और उसमें मौजूद इकाइयों को एक्सट्रैक्ट करने के लिए,
annotate()
तरीका इस्तेमाल करके उसे टेक्स्ट स्ट्रिंग या
EntityExtractionParams
की मदद से, अतिरिक्त विकल्प तय किए जा सकते हैं. जैसे,
किसी इकाई के किसी सबसेट की खोज को सीमित करने के लिए, रेफ़रंस समय, टाइमज़ोन या फ़िल्टर का इस्तेमाल करें
प्रकार. एपीआई ऐसे EntityAnnotation
ऑब्जेक्ट की सूची दिखाता है जिनमें शामिल है
हर इकाई के बारे में जानकारी.
SDK टूल का नाम | इकाई-एक्सट्रैक्शन |
---|---|
लागू करना | बेस डिटेक्टर की ऐसेट, बिल्ड के दौरान आपके ऐप्लिकेशन के साथ स्टैटिक रूप से लिंक होती हैं. |
ऐसेट के साइज़ से असर | इकाई एक्सट्रैक्शन से ऐप्लिकेशन के साइज़ का असर ~5.6 एमबी तक हो सकता है. |
इसे आज़माएं
- सैंपल वाले ऐप्लिकेशन को इस्तेमाल करके देखें, इस एपीआई के इस्तेमाल का एक उदाहरण देखें.
शुरू करने से पहले
- प्रोजेक्ट-लेवल की
build.gradle
फ़ाइल में, पक्का करें कि बिल्डस्क्रिप्ट और सभी प्रोजेक्ट, दोनों सेक्शन में Google का Maven रिपॉज़िटरी शामिल हो. अपने मॉड्यूल की ऐप्लिकेशन-लेवल की Gradle फ़ाइल में, ML Kit इकाई की एक्सट्रैक्शन लाइब्रेरी के लिए डिपेंडेंसी जोड़ें. आम तौर पर, इसका नाम
app/build.gradle
होता है:dependencies { // … implementation 'com.google.mlkit:entity-extraction:16.0.0-beta5' }
इकाइयां निकालें
EntityExtractor
ऑब्जेक्ट बनाएं और उसे EntityExtractorOptions
के साथ कॉन्फ़िगर करें
Kotlin
val entityExtractor = EntityExtraction.getClient( EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build())
Java
EntityExtractor entityExtractor = EntityExtraction.getClient( new EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build());
ज़रूरत पड़ने पर, EntityExtractorOptions
उपयोगकर्ता के तय किए गए Executor
को भी स्वीकार करता है. ऐसा न करने पर, एमएल किट में डिफ़ॉल्ट Executor
का इस्तेमाल किया जाएगा
पक्का करें कि डिवाइस पर ज़रूरी मॉडल डाउनलोड कर लिया गया है.
Kotlin
entityExtractor .downloadModelIfNeeded() .addOnSuccessListener { _ -> /* Model downloading succeeded, you can call extraction API here. */ } .addOnFailureListener { _ -> /* Model downloading failed. */ }
Java
entityExtractor .downloadModelIfNeeded() .addOnSuccessListener( aVoid -> { // Model downloading succeeded, you can call the extraction API here. }) .addOnFailureListener( exception -> { // Model downloading failed. });
मॉडल के डाउनलोड होने की पुष्टि करने के बाद, annotate()
को कोई स्ट्रिंग या EntityExtractionParams
भेजें.
जब तक आपको यह पता न हो कि मॉडल उपलब्ध है, तब तक annotate()
को कॉल न करें.
Kotlin
val params = EntityExtractionParams.Builder("My flight is LX373, please pick me up at 8am tomorrow.") .setEntityTypesFilter((/* optional entity type filter */) .setPreferredLocale(/* optional preferred locale */) .setReferenceTime(/* optional reference date-time */) .setReferenceTimeZone(/* optional reference timezone */) .build() entityExtractor .annotate(params) .addOnSuccessListener { // Annotation process was successful, you can parse the EntityAnnotations list here. } .addOnFailureListener { // Check failure message here. }
Java
EntityExtractionParams params = new EntityExtractionParams .Builder("My flight is LX373, please pick me up at 8am tomorrow.") .setEntityTypesFilter(/* optional entity type filter */) .setPreferredLocale(/* optional preferred locale */) .setReferenceTime(/* optional reference date-time */) .setReferenceTimeZone(/* optional reference timezone */) .build(); entityExtractor .annotate(params) .addOnSuccessListener(new OnSuccessListener<List<EntityAnnotation>>() { @Override public void onSuccess(List<EntityAnnotation> entityAnnotations) { // Annotation process was successful, you can parse the EntityAnnotations list here. } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Check failure message here. } });
PreferredLocale
, ReferenceTime
, और ReferenceTimeZone
का इस्तेमाल करने पर सिर्फ़
तारीख समय की इकाइयां. अगर इन्हें साफ़ तौर पर सेट नहीं किया गया है, तो ये डिफ़ॉल्ट रूप से वैल्यू पर सेट होती हैं
उपयोगकर्ता के डिवाइस से
मान्य हैं.
Kotlin
for (entityAnnotation in entityAnnotations) { val entities: List<Entity> = entityAnnotation.entities Log.d(TAG, "Range: ${entityAnnotation.start} - ${entityAnnotation.end}") for (entity in entities) { when (entity) { is DateTimeEntity -> { Log.d(TAG, "Granularity: ${entity.dateTimeGranularity}") Log.d(TAG, "TimeStamp: ${entity.timestampMillis}") } is FlightNumberEntity -> { Log.d(TAG, "Airline Code: ${entity.airlineCode}") Log.d(TAG, "Flight number: ${entity.flightNumber}") } is MoneyEntity -> { Log.d(TAG, "Currency: ${entity.unnormalizedCurrency}") Log.d(TAG, "Integer part: ${entity.integerPart}") Log.d(TAG, "Fractional Part: ${entity.fractionalPart}") } else -> { Log.d(TAG, " $entity") } } } }
Java
List<EntityAnnotation> entityAnnotations = /* Get from EntityExtractor */; for (EntityAnnotation entityAnnotation : entityAnnotations) { List<Entity> entities = entityAnnotation.getEntities(); Log.d(TAG, String.format("Range: [%d, %d)", entityAnnotation.getStart(), entityAnnotation.getEnd())); for (Entity entity : entities) { switch (entity.getType()) { case Entity.TYPE_DATE_TIME: DateTimeEntity dateTimeEntity = entity.asDateTimeEntity(); Log.d(TAG, "Granularity: " + dateTimeEntity.getDateTimeGranularity()); Log.d(TAG, "Timestamp: " + dateTimeEntity.getTimestampMillis()); case Entity.TYPE_FLIGHT_NUMBER: FlightNumberEntity flightNumberEntity = entity.asFlightNumberEntity(); Log.d(TAG, "Airline Code: " + flightNumberEntity.getAirlineCode()); Log.d(TAG, "Flight number: " + flightNumberEntity.getFlightNumber()); case Entity.TYPE_MONEY: MoneyEntity moneyEntity = entity.asMoneyEntity(); Log.d(TAG, "Currency: " + moneyEntity.getUnnormalizedCurrency()); Log.d(TAG, "Integer Part: " + moneyEntity.getIntegerPart()); Log.d(TAG, "Fractional Part: " + moneyEntity.getFractionalPart()); case Entity.TYPE_UNKNOWN: default: Log.d(TAG, "Entity: " + entity); } } }
जब आपको EntityExtractor
ऑब्जेक्ट की ज़रूरत न हो, तब close()
तरीके को कॉल करें. अगर फ़्रैगमेंट या AppCompatActivity में EntityExtractor
का इस्तेमाल किया जा रहा है, तो आप फ़्रैगमेंट या AppCompatActivity पर LifecycleOwner.getLifecycle() को कॉल कर सकते हैं. इसके बाद, Lifecycle.addObserver को कॉल कर सकते हैं. उदाहरण के लिए:
Kotlin
val options = … val extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
Java
EntityExtractorOptions options = … EntityExtractor extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
इकाई एक्सट्रैक्शन मॉडल को साफ़ तौर पर मैनेज करना
जब ऊपर बताए गए तरीके से इकाई एक्सट्रैक्ट करने के एपीआई का इस्तेमाल किया जाता है, तो एमएल किट ज़रूरत के हिसाब से डिवाइस पर अपने-आप भाषा के हिसाब से बने मॉडल डाउनलोड करता है. ऐसा तब होता है, जब downloadModelIfNeeded()
को कॉल किया जाता है. ML Kit के मॉडल मैनेजमेंट एपीआई का इस्तेमाल करके, उन मॉडल को भी खास तौर पर मैनेज किया जा सकता है जिन्हें आपको डिवाइस पर उपलब्ध कराना है. यह तब काम आ सकता है, जब आपको मॉडल समय से पहले डाउनलोड करना हो. यह एपीआई आपको ऐसे मॉडल मिटाने भी देता है जिनकी अब ज़रूरत नहीं है.
Kotlin
val modelManager = RemoteModelManager.getInstance() // Get entity extraction models stored on the device. modelManager.getDownloadedModels(EntityExtractionRemoteModel::class.java) .addOnSuccessListener { // ... } .addOnFailureListener({ // Error. }) // Delete the German model if it's on the device. val germanModel = EntityExtractionRemoteModel.Builder(EntityExtractorOptions.GERMAN).build() modelManager.deleteDownloadedModel(germanModel) .addOnSuccessListener({ // Model deleted. }) .addOnFailureListener({ // Error. }) // Download the French model. val frenchModel = EntityExtractionRemoteModel.Builder(EntityExtractorOptions.FRENCH).build() val conditions = DownloadConditions.Builder() .requireWifi() .build() modelManager.download(frenchModel, conditions) .addOnSuccessListener({ // Model downloaded. }) .addOnFailureListener({ // Error. })
Java
// Get entity extraction models stored on the device. modelManager.getDownloadedModels(EntityExtractionRemoteModel.class) .addOnSuccessListener(new OnSuccessListener<Set<EntityExtractionRemoteModel>>() { @Override public void onSuccess(Set<EntityExtractionRemoteModel> models) { // ... } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Error. } }); // Delete the German model if it's on the device. EntityExtractionRemoteModel germanModel = new EntityExtractionRemoteModel.Builder(EntityExtractorOptions.GERMAN).build(); modelManager.deleteDownloadedModel(germanModel) .addOnSuccessListener(new OnSuccessListener<Void>() { @Override public void onSuccess(Void v) { // Model deleted. } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Error. } }); // Download the French model. EntityExtractionRemoteModel frenchModel = new EntityExtractionRemoteModel.Builder(EntityExtractorOptions.FRENCH).build(); DownloadConditions conditions = new DownloadConditions.Builder() .requireWifi() .build(); modelManager.download(frenchModel, conditions) .addOnSuccessListener(new OnSuccessListener<Void>() { @Override public void onSuccess(Void v) { // Model downloaded. } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Error. } });