Để phân tích một đoạn văn bản và trích xuất các thực thể trong đó, hãy gọi phương thức annotate() và truyền vào đó chuỗi văn bản hoặc một thực thể của EntityExtractionParams. Phương thức này có thể chỉ định các lựa chọn bổ sung như thời gian tham chiếu, múi giờ hoặc bộ lọc để giới hạn hoạt động tìm kiếm một tập hợp con các loại thực thể. API trả về một danh sách các đối tượng EntityAnnotation chứa thông tin về từng thực thể.
| Tên SDK | trích xuất thực thể |
|---|---|
| Triển khai | Các thành phần của trình phát hiện cơ sở được liên kết tĩnh với ứng dụng của bạn tại thời điểm xây dựng. |
| Tác động của quy mô tài sản | Việc trích xuất thực thể có ảnh hưởng đến kích thước ứng dụng lên đến ~5,6 MB. |
Dùng thử
- Hãy thử ứng dụng mẫu để xem ví dụ về cách sử dụng API này.
Trước khi bắt đầu
- Trong tệp
build.gradlecấp dự án, hãy đảm bảo rằng kho lưu trữ Maven của Google có trong cả phần buildscript và allprojects. Thêm phần phụ thuộc của thư viện trích xuất thực thể Bộ công cụ học máy vào tệp gradle cấp ứng dụng của mô-đun, thường có tên là
app/build.gradle:dependencies { // … implementation 'com.google.mlkit:entity-extraction:16.0.0-beta5' }
Trích xuất thực thể
Tạo một đối tượng EntityExtractor và định cấu hình đối tượng đó bằng EntityExtractorOptions
Kotlin
val entityExtractor =
EntityExtraction.getClient(
EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH)
.build())
Java
EntityExtractor entityExtractor =
EntityExtraction.getClient(
new EntityExtractorOptions.Builder(EntityExtractorOptions.ENGLISH)
.build());
EntityExtractorOptions cũng chấp nhận Executor do người dùng xác định nếu bạn cần, nếu không thì sẽ sử dụng Executor mặc định trong Bộ công cụ học máy
Đảm bảo bạn đã tải mô hình được yêu cầu xuống thiết bị.
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.
});
Sau khi bạn xác nhận rằng mô hình đã được tải xuống, hãy truyền một chuỗi hoặc EntityExtractionParams vào annotate().
Không gọi annotate() cho đến khi bạn biết có mô hình.
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 và ReferenceTimeZone sẽ chỉ ảnh hưởng đến các thực thể DateTime. Nếu bạn không đặt rõ ràng các giá trị này, thì giá trị mặc định sẽ là các giá trị trên thiết bị của người dùng.
Lặp lại kết quả chú giải để truy xuất thông tin về các thực thể đã nhận dạng.
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);
}
}
}
Gọi phương thức close() khi bạn không cần đối tượng EntityExtractor nữa. Nếu đang sử dụng EntityExtractor trong Fragment hoặc AppCompatActivity, bạn có thể gọi LifecycleOwner.getLifecycle() trên Fragment hoặc AppCompatActivity, sau đó gọi Lifecycle.addObserver. Ví dụ:
Kotlin
val options = … val extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
Java
EntityExtractorOptions options = … EntityExtractor extractor = EntityExtraction.getClient(options); getLifecycle().addObserver(extractor);
Quản lý rõ ràng các mô hình trích xuất thực thể
Khi bạn sử dụng API trích xuất thực thể như mô tả ở trên, Bộ công cụ học máy sẽ tự động tải các mô hình dành riêng cho ngôn ngữ xuống thiết bị theo yêu cầu (khi bạn gọi downloadModelIfNeeded()). Bạn cũng có thể quản lý một cách rõ ràng những mô hình mình muốn có trên thiết bị bằng cách sử dụng API quản lý mô hình của Bộ công cụ học máy. Điều này có thể hữu ích nếu bạn muốn tải các mô hình xuống trước. API này cũng cho phép bạn xoá các mô hình không còn cần thiết nữa.
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.
}
});