Android पर एमएल किट वाली इकाइयां निकालना

किसी टेक्स्ट का विश्लेषण करने और उसमें मौजूद इकाइयों को निकालने के लिए, annotate() तरीका इस्तेमाल करें. इसके बाद, उसे टेक्स्ट स्ट्रिंग या EntityExtractionParams का कोई इंस्टेंस पास करें. इससे, रेफ़रंस समय, टाइमज़ोन या इकाई टाइप के सबसेट के लिए खोज को सीमित करने वाले फ़िल्टर जैसे अन्य विकल्पों की जानकारी मिल सकती है. एपीआई, EntityAnnotation ऑब्जेक्ट की सूची दिखाता है. इसमें हर इकाई के बारे में जानकारी होती है.

SDK टूल का नामentity-extraction
लागू करनाबेस डिटेक्टर के लिए ऐसेट, बिल्ड के समय आपके ऐप्लिकेशन से स्टैटिक तौर पर लिंक होती हैं.
ऐसेट के साइज़ का असरइकाई निकालने की सुविधा से, ऐप्लिकेशन के साइज़ पर ~5.6 एमबी तक का असर पड़ता है.

इसे आज़माएं

शुरू करने से पहले

  1. प्रोजेक्ट-लेवल की build.gradle फ़ाइल में, पक्का करें कि Google की मेवन रिपॉज़िटरी, buildscript और allprojects सेक्शन, दोनों में शामिल हो.
  2. अपने मॉड्यूल की ऐप्लिकेशन-लेवल की 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 भी इस्तेमाल किया जा सकता है. ऐसा न करने पर, यह ML Kit में डिफ़ॉल्ट 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);

इकाई निकालने वाले मॉडल को साफ़ तौर पर मैनेज करना

ऊपर बताए गए तरीके से इकाई निकालने वाले एपीआई का इस्तेमाल करने पर, ML Kit 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.
          }
        });