MLKitEntityExtraction Framework Reference

  • This page provides a list of globally available classes for entity extraction in ML Kit.

  • EntityExtractor is the core class used to identify and extract entities like dates, addresses, and flight numbers from text.

  • Classes like DateTimeEntity, FlightNumberEntity, and MoneyEntity represent specific types of extracted entities.

  • Developers can customize the extraction process using parameters provided by EntityExtractionParams and EntityExtractorOptions.

  • ModelManager handles the management of remote and local models used for entity extraction.

Classes

The following classes are available globally.

  • A date and time entity extracted from text.

    Declaration

    Swift

    class DateTimeEntity : NSObject

  • An entity extracted from a substring of text.

    Declaration

    Swift

    class Entity : NSObject

  • An object that contains the possible entities associated with a piece of the text.

    Declaration

    Swift

    class EntityAnnotation : NSObject

  • An object that contains various parameters that can be customized on each entity extraction call.

    Declaration

    Swift

    class EntityExtractionParams : NSObject

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

    Declaration

    Swift

    class EntityExtractorRemoteModel : RemoteModel

  • A class that extracts entities from the given input text.

    Declaration

    Swift

    class EntityExtractor : NSObject

  • Options forMLKEntityExtractor.

    Declaration

    Swift

    class EntityExtractorOptions : NSObject

  • A flight number entity extracted from text.

    Declaration

    Swift

    class FlightNumberEntity : NSObject

  • An IBAN entity extracted from text.

    Declaration

    Swift

    class IBANEntity : NSObject

  • An ISBN entity extracted from text.

    Declaration

    Swift

    class ISBNEntity : NSObject

  • Manages models that are used by MLKit features.

    Declaration

    Swift

    class ModelManager : NSObject

  • A money entity extracted from text.

    Declaration

    Swift

    class MoneyEntity : NSObject

  • A payment card entity extracted from text.

    Declaration

    Swift

    class MLKPaymentCardEntity : NSObject

  • A model that is stored remotely on the server and downloaded to the device.

    Declaration

    Swift

    class RemoteModel : NSObject

  • A tracking number extracted from text.

    Declaration

    Swift

    class TrackingNumberEntity : NSObject