MLKitEntityExtraction Framework Reference

AI-generated Key Takeaways

• This documentation outlines the globally available classes for ML Kit Entity Extraction on iOS.

• The classes provide functionality for identifying and extracting various entities from text, such as dates, flight numbers, and payment card information.

• Developers can customize entity extraction using parameters and options provided by dedicated classes.

• The API includes classes for managing remote models used for entity extraction.

• Each class has a detailed description, declaration, and often links to further documentation for a deeper understanding.

Classes

The following classes are available globally.

• MLKDateTimeEntity

  A date and time entity extracted from text.

  Declaration

  Objective-C

  
  @interface MLKDateTimeEntity : NSObject

• MLKEntity

  An entity extracted from a substring of text.

  Declaration

  Objective-C

  
  @interface MLKEntity : NSObject

• MLKEntityAnnotation

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

  Declaration

  Objective-C

  
  @interface MLKEntityAnnotation : NSObject

• MLKEntityExtractionParams

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

  Declaration

  Objective-C

  
  @interface MLKEntityExtractionParams : NSObject

• MLKEntityExtractionRemoteModel

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

  Declaration

  Objective-C

  
  @interface MLKEntityExtractionRemoteModel : MLKRemoteModel

• MLKEntityExtractor

  A class that extracts entities from the given input text.

  Declaration

  Objective-C

  
  @interface MLKEntityExtractor : NSObject

• MLKEntityExtractorOptions

  Options forMLKEntityExtractor.

  Declaration

  Objective-C

  
  @interface MLKEntityExtractorOptions : NSObject

• MLKFlightNumberEntity

  A flight number entity extracted from text.

  Declaration

  Objective-C

  
  @interface MLKFlightNumberEntity : NSObject

• MLKIBANEntity

  An IBAN entity extracted from text.

  Declaration

  Objective-C

  
  @interface MLKIBANEntity : NSObject

• MLKISBNEntity

  An ISBN entity extracted from text.

  Declaration

  Objective-C

  
  @interface MLKISBNEntity : NSObject

• MLKModelManager

  Manages models that are used by MLKit features.

  Declaration

  Objective-C

  
  @interface MLKModelManager : NSObject

• MLKMoneyEntity

  A money entity extracted from text.

  Declaration

  Objective-C

  
  @interface MLKMoneyEntity : NSObject

• MLKPaymentCardEntity

  A payment card entity extracted from text.

  Declaration

  Objective-C

  @interface MLKPaymentCardEntity : NSObject

• MLKRemoteModel

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

  Declaration

  Objective-C

  
  @interface MLKRemoteModel : NSObject

• MLKTrackingNumberEntity

  A tracking number extracted from text.

  Declaration

  Objective-C

  
  @interface MLKTrackingNumberEntity : NSObject