MLKitEntityExtraction Framework Reference

AI-generated Key Takeaways

• MLKEntityExtractionRemoteModel is an entity extraction model stored remotely and downloaded for on-device use.

• It's identified by a unique model identifier and managed using ModelManager.

• You can get an instance of the model and trigger a download using the provided methods.

• Model download notifications are posted for RemoteModel and can be verified using the ModelDownloadUserInfoKeyRemoteModel field.

MLKEntityExtractionRemoteModel

@interface MLKEntityExtractionRemoteModel : MLKRemoteModel

An entity extraction model that is stored remotely on the server and downloaded on the device.

• modelIdentifier

  The model identifier of this model.

  Declaration

  Objective-C

  @property (nonatomic, readonly) MLKEntityExtractionModelIdentifier _Nonnull modelIdentifier;

• +entityExtractorRemoteModelWithIdentifier:

  Gets an instance of EntityExtractorRemoteModel configured with the given model identifier. This model can be used to trigger a download by calling the download(_:) API from ModelManager.

  EntityExtractorRemoteModel uses ModelManager internally. When downloading an EntityExtractorRemoteModel, there will be a notification posted for a RemoteModel. To verify if such notifications belong to an EntityExtractorRemoteModel, check that the ModelDownloadUserInfoKeyRemoteModel field in the user info dictionary contains an object of type EntityExtractorRemoteModel .

  Declaration

  Objective-C

  + (nonnull MLKEntityExtractionRemoteModel *)
      entityExtractorRemoteModelWithIdentifier:
          (nonnull MLKEntityExtractionModelIdentifier)modelIdentifier;

  Parameters

  modelIdentifier

  The model identifier of the model.

  Return Value

  A EntityExtractorRemoteModel instance.

• -init

  Unavailable.

  Declaration

  Objective-C

  - (nonnull instancetype)init;