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
. Dadurch können zusätzliche Optionen wie eine Referenzzeit, eine Zeitzone oder ein Filter angegeben werden, um die Suche nach einer Teilmenge von Entitätstypen einzuschränken. Die API gibt eine Liste von EntityAnnotation
-Objekten mit Informationen zu jeder Entität zurück.
SDK-Name | Entitätsextraktion |
---|---|
Implementierung | Assets für Basisdetektoren sind beim Build statisch mit Ihrer Anwendung verknüpft. |
Auswirkungen auf die Asset-Größe | Die Entitätsextraktion kann sich auf die App-Größe von ca.5,6 MB auswirken. |
Ausprobieren
- Probieren Sie die Beispiel-App aus, um ein Beispiel für die Verwendung dieser API zu sehen.
Hinweis
- Achten Sie in der Datei
build.gradle
auf Projektebene darauf, dass das Maven-Repository von Google sowohl im Buildscript- als auch im Abschnitt „allprojects“ enthalten ist. Fügen Sie der Gradle-Datei Ihres Moduls auf App-Ebene, die normalerweise den Namen
app/build.gradle
hat, die Abhängigkeit für die ML Kit-Entitätsextraktionsbibliothek hinzu:dependencies { // … implementation 'com.google.mlkit:entity-extraction:16.0.0-beta5' }
Entitäten extrahieren
EntityExtractor
-Objekt erstellen und mit EntityExtractorOptions
konfigurieren
Kotlin
val entityExtractor = EntityExtraction.getClient( EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build())
Java
EntityExtractor entityExtractor = EntityExtraction.getClient( new EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build());
EntityExtractorOptions
akzeptiert bei Bedarf auch benutzerdefinierte Executor
. Andernfalls wird die Standard-Executor
im 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 dann 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 Datum/Uhrzeit-Entitäten aus. Wenn diese nicht explizit festgelegt sind, werden standardmäßig die Werte des Nutzergeräts verwendet.
Führen Sie eine Schleife über die Annotationsergebnisse aus, 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 Objekt EntityExtractor
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 Entity Extraction API wie oben beschrieben verwenden, lädt ML Kit automatisch sprachspezifische Modelle nach Bedarf 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 verwalten, indem Sie die Model Management API von ML Kit verwenden. Dies 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. } });