Aby przeanalizować fragment tekstu i wyodrębnić zawarte w nim elementy, wywołaj metodę annotate()
i przekaż mu ciąg tekstowy lub wystąpienie elementu EntityExtractionParams
, które mogą określać dodatkowe opcje, takie jak czas odwołania, strefa czasowa lub filtr ograniczający wyszukiwanie podzbioru typów encji. Interfejs API zwraca listę obiektów EntityAnnotation
zawierających informacje o każdej encji.
Nazwa pakietu SDK | wyodrębnianie encji |
---|---|
Implementacja | Zasoby podstawowego wzorca do wykrywania treści są statycznie połączone z aplikacją w momencie kompilacji. |
Wpływ rozmiaru zasobu | Ekstrakcja encji ma wpływ na rozmiar aplikacji nawet o 5,6 MB. |
Wypróbuj
- Zapoznaj się z przykładową aplikacją, aby zobaczyć przykład użycia tego interfejsu API.
Zanim zaczniesz
- W pliku
build.gradle
na poziomie projektu sprawdź, czy repozytorium Google Maven jest uwzględnione w sekcjach buildscript i allprojects. Dodaj zależność z biblioteką wyodrębniania encji ML Kit do pliku Gradle na poziomie aplikacji modułu, który zwykle nosi nazwę
app/build.gradle
:dependencies { // … implementation 'com.google.mlkit:entity-extraction:16.0.0-beta5' }
Wyodrębnianie encji
Utwórz obiekt EntityExtractor
i skonfiguruj go za pomocą EntityExtractorOptions
Kotlin
val entityExtractor = EntityExtraction.getClient( EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build())
Java
EntityExtractor entityExtractor = EntityExtraction.getClient( new EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build());
W razie potrzeby EntityExtractorOptions
akceptuje też zdefiniowany przez użytkownika Executor
. W przeciwnym razie będzie używał domyślnej wartości Executor
w ML Kit
Sprawdź, czy wymagany model został pobrany na urządzenie.
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. });
Po potwierdzeniu, że model został pobrany, przekaż ciąg znaków lub EntityExtractionParams
do usługi annotate()
.
Nie dzwoń do operatora annotate()
, dopóki nie upewnisz się, że model jest dostępny.
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
i ReferenceTimeZone
będą miały wpływ tylko na elementy DateTime. Jeśli nie zostaną one ustawione, domyślnie będą używane wartości z urządzenia użytkownika.
Zapętlaj wyniki adnotacji, aby pobrać informacje o rozpoznanych encjach.
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); } } }
Wywołaj metodę close()
, gdy nie potrzebujesz już obiektu EntityExtractor
. Jeśli używasz dyrektywy EntityExtractor
we fragmencie kodu lub AppCompatActivity, możesz wywołać funkcję LifecycleOwner.getLifecycle() we fragmencie lub AppCompatActivity, a następnie Lifecycle.addObserver. Na przykład:
Kotlin
val options = … val extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
Java
EntityExtractorOptions options = … EntityExtractor extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
Bezpośrednie zarządzanie modelami ekstrakcji encji
Jeśli korzystasz z interfejsu API ekstrakcji encji w opisany powyżej sposób, ML Kit automatycznie pobiera na urządzenie modele językowe zgodnie z wymaganiami (gdy wywołujesz funkcję downloadModelIfNeeded()
). Możesz też bezpośrednio zarządzać modelami, które mają być dostępne na urządzeniu, za pomocą interfejsu ML Kit API do zarządzania modelami. Może to być przydatne, jeśli chcesz pobrać modele z wyprzedzeniem. Interfejs API umożliwia też usuwanie modeli, które nie są już wymagane.
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. } });