استخراج الكيانات باستخدام حزمة تعلّم الآلة على Android

لتحليل جزء من النص واستخراج الكيانات فيه، استدعِ طريقة annotate() ومرِّرها إما السلسلة النصية أو مثيل لـ EntityExtractionParams الذي يمكنه تحديد خيارات إضافية، مثل وقت مرجعي أو منطقة زمنية أو فلتر لتقييد البحث عن مجموعة فرعية من أنواع الكيانات. تعرض واجهة برمجة التطبيقات قائمة من كائنات EntityAnnotation التي تحتوي على معلومات حول كل كيان.

اسم حزمة تطوير البرامج (SDK)استخراج الكيانات
التنفيذوتكون مواد العرض لأداة الرصد الأساسية مرتبطة بشكل ثابت بتطبيقك في وقت الإصدار.
تأثير حجم مادة العرضيصل حجم التطبيق لاستخراج الكيانات إلى 5.6 ميغابايت تقريبًا.

التجربة الآن

  • جرّب نموذج التطبيق للاطّلاع على مثال لاستخدام واجهة برمجة التطبيقات هذه.

قبل البدء

  1. في ملف build.gradle على مستوى المشروع، تأكَّد من تضمين مستودع Maven من Google في قسمَي Buildscript وallprojects.

  2. أضِف التبعية لمكتبة استخراج كيانات ML Kit إلى ملف Gradle على مستوى التطبيق في الوحدة، والذي يُسمّى عادةً 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.
        });

بعد التأكّد من تنزيل النموذج، مرِّر سلسلة أو EntityExtractionParams إلى annotate(). لا تتصل بـ "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);
    }
  }
}

يمكنك استدعاء الإجراء close() إذا لم تعُد بحاجة إلى الكائن EntityExtractor. إذا كنت تستخدم EntityExtractor في Fragment أو AppCompatActivity، يمكنك استدعاء LifecycleOwner.getLifecycle() وذلك في Fragment أو AppCompatActivity، ثم على 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()). ويمكنك أيضًا إدارة النماذج التي تريد توفيرها على الجهاز بشكل واضح باستخدام واجهة برمجة التطبيقات لإدارة النماذج في أدوات تعلّم الآلة. ويمكن أن يكون هذا مفيدًا إذا كنت تريد تنزيل النماذج مسبقًا. تسمح لك واجهة برمجة التطبيقات أيضًا بحذف النماذج التي لم تعُد مطلوبة.

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.
          }
        });