Entitäten mit ML Kit unter Android extrahieren

Diese API wird in der Betaversion angeboten und unterliegt keinem SLA und keiner Richtlinie zur Einstellung von Produkten und Diensten. Es können Änderungen an dieser API vorgenommen werden, die die Abwärtskompatibilität beeinträchtigen.

Wenn Sie einen Text analysieren und die darin enthaltenen Entitäten extrahieren möchten, rufen Sie die Methode annotate() auf und übergeben Sie entweder den Textstring oder eine Instanz von EntityExtractionParams. Damit können Sie zusätzliche Optionen wie eine Referenzzeit, eine Zeitzone oder einen Filter angeben, um die Suche auf eine Teilmenge von Entitätstypen zu beschränken. Die API gibt eine Liste von EntityAnnotation-Objekten mit Informationen zu jeder Entität zurück.

Diese API unterstützt dynamische Modell-Downloads auf Anfrage. Weitere Informationen finden Sie in diesem Leitfaden.

SDK-Name	entity-extraction
Implementierung	Assets für den Basisdetektor werden zur Build-Zeit statisch mit Ihrer App verknüpft.
Auswirkungen auf die Asset-Größe	Die Entitätsextraktion kann die App-Größe um bis zu 5,6 MB erhöhen.

Jetzt ausprobieren

• Probieren Sie die Beispiel-App aus, um ein Anwendungsbeispiel für diese API zu sehen.

Hinweis

Diese API erfordert Android API-Level 23 oder höher. Die Build -Datei Ihrer App muss einen minSdkVersion-Wert von 23 oder höher verwenden.

1. In der Datei build.gradle auf Projektebene muss das Maven-Repository von Google in den Abschnitten „buildscript“ und „allprojects“ enthalten sein.

2. Fügen Sie die Abhängigkeit für die ML Kit-Bibliothek zur Entitätsextraktion der Gradle-Datei auf Anwendungsebene Ihres Moduls hinzu. Diese Datei heißt in der Regel app/build.gradle:

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

Entitäten extrahieren

Erstellen Sie ein EntityExtractor-Objekt und konfigurieren Sie es mit EntityExtractorOptions

Kotlin

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

Java

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

EntityExtractorOptions akzeptiert auch einen benutzerdefinierten Executor. Andernfalls wird der Standard-Executor in ML Kit verwendet.

Prüfen Sie, ob das erforderliche Modell auf das Gerät heruntergeladen wurde.

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

Nachdem Sie bestätigt haben, dass das Modell heruntergeladen wurde, übergeben Sie einen String oder EntityExtractionParams an annotate(). Rufen Sie annotate() erst auf, wenn Sie wissen, dass das Modell verfügbar ist.

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 und ReferenceTimeZone wirken sich nur auf DateTime-Entitäten aus. Wenn diese nicht explizit festgelegt sind, werden standardmäßig die Werte vom Gerät des Nutzers verwendet.

Durchlaufen Sie die Annotationsergebnisse, um Informationen zu den erkannten Entitäten abzurufen.

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

Rufen Sie die Methode close() auf, wenn Sie das EntityExtractor-Objekt nicht mehr benötigen. Wenn Sie EntityExtractor in einem Fragment oder einer AppCompatActivity verwenden, können Sie LifecycleOwner.getLifecycle() für das Fragment oder die AppCompatActivity und dann Lifecycle.addObserver aufrufen. Beispiel:

Kotlin

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

Java

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

Entitätsextraktionsmodelle explizit verwalten

Wenn Sie die API zur Entitätsextraktion wie oben beschrieben verwenden, lädt ML Kit bei Bedarf automatisch sprachspezifische Modelle auf das Gerät herunter (wenn Sie downloadModelIfNeeded() aufrufen). Sie können die Modelle, die auf dem Gerät verfügbar sein sollen, auch explizit mit der Modellverwaltungs-API von ML Kit verwalten. Das kann nützlich sein, wenn Sie Modelle im Voraus herunterladen möchten. Mit der API können Sie auch Modelle löschen, die nicht mehr benötigt werden.

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