لتحليل جزء من النص واستخراج الكيانات منه، استدعِ الطريقة annotate()
ومرِّر إليها سلسلة النص أو مثيلاً من EntityExtractionParams
يمكنه تحديد خيارات إضافية، مثل وقت مرجعي أو منطقة زمنية أو فلتر للحدّ من البحث عن مجموعة فرعية من أنواع الكيانات. تعرض واجهة برمجة التطبيقات قائمة بعناصر EntityAnnotation
تحتوي على معلومات حول كل كيان.
اسم حزمة تطوير البرامج (SDK) | entity-extraction |
---|---|
التنفيذ | يتم ربط مواد عرض أداة رصد المشاكل الأساسية بتطبيقك بشكل ثابت في وقت الإنشاء. |
تأثير حجم مواد العرض | يؤثر استخراج الكيانات في حجم التطبيق بما يصل إلى 5.6 ميغابايت تقريبًا. |
جرّبه الآن
- يمكنك تجربة التطبيق النموذجي للاطّلاع على مثال على كيفية استخدام واجهة برمجة التطبيقات هذه.
قبل البدء
- في ملف
build.gradle
على مستوى المشروع، تأكَّد من تضمين مستودع Maven من Google في كلّ من قسمَي buildscript وallprojects. أضِف التبعية لمكتبة استخراج الكيانات في ML Kit إلى ملف gradle على مستوى التطبيق في وحدتك، والذي يُطلق عليه عادةً اسم
app/build.gradle
:dependencies { // … implementation 'com.google.mlkit:entity-extraction:16.0.0-beta6' }
استخراج الكيانات
أنشئ عنصر EntityExtractor
، واضبطه باستخدام EntityExtractorOptions
Kotlin
val entityExtractor = EntityExtraction.getClient( EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build())
Java
EntityExtractor entityExtractor = EntityExtraction.getClient( new EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH) .build());
تقبل السمة EntityExtractorOptions
أيضًا قيمة Executor
يحدّدها المستخدم إذا كنت بحاجة إلى ذلك، وإلا سيتم استخدام القيمة التلقائية Executor
في ML Kit.
تأكَّد من تنزيل النموذج المطلوب على الجهاز.
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. });
بعد التأكّد من تنزيل النموذج، مرِّر سلسلة أو EntityExtractionParams
إلى annotate()
.
لا تتّصل بالرقم annotate()
إلا بعد التأكّد من توفّر الطراز.
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
وReferenceTimeZone
إلا في عناصر DateTime. وفي حال عدم ضبط هذه القيم بشكل صريح، سيتم تلقائيًا استخدام القيم من جهاز المستخدم.
كرِّر نتائج التعليقات التوضيحية لاسترداد معلومات حول الكيانات التي تم التعرّف عليها.
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); } } }
استدعِ الطريقة close()
عندما لا تعود بحاجة إلى الكائن EntityExtractor
. إذا كنت تستخدم EntityExtractor
في Fragment أو AppCompatActivity، يمكنك استدعاء LifecycleOwner.getLifecycle() في Fragment أو AppCompatActivity، ثم Lifecycle.addObserver. على سبيل المثال:
Kotlin
val options = … val extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
Java
EntityExtractorOptions options = … EntityExtractor extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
إدارة نماذج استخراج الكيانات بشكل صريح
عند استخدام واجهة برمجة التطبيقات لاستخراج الكيانات كما هو موضّح أعلاه، ينزّل ML Kit تلقائيًا النماذج الخاصة باللغة إلى الجهاز حسب الحاجة (عند استدعاء downloadModelIfNeeded()
). يمكنك أيضًا إدارة النماذج التي تريد إتاحتها على الجهاز بشكلٍ صريح باستخدام واجهة برمجة التطبيقات لإدارة النماذج في ML Kit. قد يكون ذلك مفيدًا إذا كنت تريد تنزيل النماذج مسبقًا. تتيح لك واجهة برمجة التطبيقات أيضًا حذف النماذج التي لم تعُد مطلوبة.
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. } });