แยกเอนทิตีด้วย ML Kit บน Android

หากต้องการวิเคราะห์ข้อความและแยกเอนทิตีในข้อความนั้น ให้เรียกใช้เมธอด annotate() แล้วส่งผ่านสตริงข้อความหรืออินสแตนซ์ของ EntityExtractionParams ซึ่งสามารถระบุตัวเลือกเพิ่มเติม เช่น เวลาอ้างอิง เขตเวลา หรือตัวกรองเพื่อจำกัดการค้นหาส่วนย่อยของประเภทเอนทิตี API จะแสดงผลรายการของออบเจ็กต์ EntityAnnotation ที่มีข้อมูลเกี่ยวกับเอนทิตีแต่ละรายการ

ลองเลย

• ลองใช้แอปตัวอย่างเพื่อดูตัวอย่างการใช้งาน API นี้

ก่อนเริ่มต้น

1. ในไฟล์ build.gradle ระดับโปรเจ็กต์ ให้ตรวจสอบว่าที่เก็บ Maven ของ Google รวมอยู่ในทั้งส่วน Buildscript และโปรเจ็กต์ทั้งหมด

2. เพิ่มทรัพยากร Dependency สำหรับไลบรารีการแยกเอนทิตีของ ML Kit ไปยังไฟล์ Gradle ระดับแอปของโมดูล ซึ่งปกติจะใช้ชื่อว่า app/build.gradle ดังนี้

   dependencies {
   // …
   
   implementation 'com.google.mlkit:entity-extraction:16.0.0-beta5'
   }
   

แยกเอนทิตี

สร้างออบเจ็กต์ EntityExtractor และกำหนดค่าด้วย EntityExtractorOptions

val entityExtractor =
   EntityExtraction.getClient(
       EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH)
           .build())

EntityExtractor entityExtractor =
        EntityExtraction.getClient(
            new EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH)
                .build());

EntityExtractorOptions ยังยอมรับ Executor ที่ผู้ใช้กำหนดด้วยหากต้องการ มิเช่นนั้นจะใช้ Executor เริ่มต้นใน ML Kit

ตรวจสอบว่าได้ดาวน์โหลดรุ่นที่จำเป็นลงในอุปกรณ์แล้ว

entityExtractor
  .downloadModelIfNeeded()
  .addOnSuccessListener { _ ->
    /* Model downloading succeeded, you can call extraction API here. */
  }
  .addOnFailureListener { _ -> /* Model downloading failed. */ }

entityExtractor
    .downloadModelIfNeeded()
    .addOnSuccessListener(
        aVoid -> {
          // Model downloading succeeded, you can call the extraction API here. 
        })
    .addOnFailureListener(
        exception -> {
          // Model downloading failed.
        });

หลังจากยืนยันว่าดาวน์โหลดโมเดลแล้ว ให้ส่งสตริงหรือ EntityExtractionParams ไปยัง annotate() อย่าเรียกใช้ annotate() จนกว่าคุณจะทราบว่าโมเดลพร้อมใช้งาน

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

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 จะส่งผลต่อเอนทิตี DateTime เท่านั้น หากไม่ได้ตั้งค่าไว้อย่างชัดแจ้ง ค่าเริ่มต้นจะเป็นค่าจากอุปกรณ์ของผู้ใช้

วนซ้ำผลลัพธ์ของคำอธิบายประกอบเพื่อดึงข้อมูลเกี่ยวกับเอนทิตีที่รู้จัก

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")
      }
    }
  }
}

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 เช่น

val options = …
val extractor = EntityExtraction.getClient(options);
getLifecycle().addObserver(extractor);

EntityExtractorOptions options = …
EntityExtractor extractor = EntityExtraction.getClient(options);
getLifecycle().addObserver(extractor);

จัดการโมเดลการแยกเอนทิตีอย่างชัดแจ้ง

เมื่อคุณใช้ API การดึงข้อมูลเอนทิตีตามที่อธิบายไว้ข้างต้น ML Kit จะดาวน์โหลดโมเดลภาษาเฉพาะลงในอุปกรณ์ตามที่จำเป็นโดยอัตโนมัติ (เมื่อเรียกใช้ downloadModelIfNeeded()) นอกจากนี้ คุณยังจัดการโมเดลที่ต้องการให้อยู่ในอุปกรณ์ได้อย่างชัดเจนโดยใช้ API การจัดการโมเดลของ ML Kit ได้ด้วย ซึ่งจะเป็นประโยชน์หากคุณต้องการดาวน์โหลดโมเดลล่วงหน้า นอกจากนี้ API ยังช่วยให้คุณลบโมเดลที่ไม่จำเป็นอีกต่อไปได้ด้วย

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

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