Aby przeanalizować fragment tekstu i wyodrębnić zawarte w nim encje, wywołaj metodę annotate()
i przekaż do niej ciąg tekstowy lub wystąpienie obiektu EntityExtractionParams
, które mogą określać dodatkowe opcje, takie jak czas odniesienia, strefa czasowa lub filtr ograniczający wyszukiwanie do 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 czasie kompilacji. |
Wpływ rozmiaru komponentu | Wyodrębnianie encji ma wpływ na rozmiar aplikacji wynoszący około 5,6 MB. |
Wypróbuj
- Przetestuj 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 zarówno w sekcji buildscript, jak i allprojects. Dodaj zależność z biblioteki wyodrębniania encji ML Kit do pliku Gradle na poziomie aplikacji, który zwykle nosi nazwę
app/build.gradle
:dependencies { // … implementation 'com.google.mlkit:entity-extraction:16.0.0-beta5' }
Wyodrębnij encje
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.
Upewnij się, że 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 annotate()
.
Nie dzwoń do firmy annotate()
, dopóki nie dowiesz 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. } });
Elementy PreferredLocale
, ReferenceTime
i ReferenceTimeZone
będą miały wpływ tylko na elementy DateTime. Jeśli nie zostaną one ustawione bezpośrednio, domyślnie będą używane wartości z urządzenia użytkownika.
Włącz pętlę wyników adnotacji, aby pobrać informacje o rozpoznanych jednostkach.
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 obiekt EntityExtractor
nie jest już potrzebny. Jeśli używasz właściwości EntityExtractor
w elemencie Fragment lub AppCompatActivity, możesz wywołać metodę LifecycleOwner.getLifecycle() z elementem Fragment 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 wyodrębniania encji
Jeśli używasz interfejsu API wyodrębniania encji w sposób opisany powyżej, ML Kit automatycznie pobiera modele językowe na urządzenie zgodnie z wymaganiami (podczas wywołania downloadModelIfNeeded()
). Możesz też bezpośrednio zarządzać modelami, które mają być dostępne na urządzeniu, używając interfejsu API zarządzania modelami ML Kit. Jest to 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. } });