MLKitEntityExtraction Framework Reference

AI-generated Key Takeaways

• MLKEntity represents an entity extracted from a text substring, providing access to various entity types.

• It includes properties for different specific entity types like date/time, flight number, IBAN, ISBN, money, payment card, and tracking number.

• Each entity property is readonly and can be nil if the specific entity type was not found in the text.

• Developers can access the entityType property to determine the type of the extracted entity.

• The init method is unavailable; presumably, MLKEntity instances are created through other means within the ML Kit framework.

MLKEntity

@interface MLKEntity : NSObject

An entity extracted from a substring of text.

• entityType

  The type of the extracted entity.

  Declaration

  Objective-C

  @property (nonatomic, readonly) MLKEntityExtractionEntityType _Nonnull entityType;

• dateTimeEntity

  The time reference entity containing a specific time or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKDateTimeEntity *dateTimeEntity;

• flightNumberEntity

  The flight number entity in IATA format or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKFlightNumberEntity *flightNumberEntity;

• IBANEntity

  The International Bank Account Number (IBAN) entity or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKIBANEntity *IBANEntity;

• ISBNEntity

  The International Standard Book Number (ISBN) entity or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKISBNEntity *ISBNEntity;

• moneyEntity

  The entity representing an amount of money or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKMoneyEntity *moneyEntity;

• paymentCardEntity

  The payment card entity or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKPaymentCardEntity *paymentCardEntity;

• trackingNumberEntity

  The tracking number entity for a shipment or nil if not extracted from the text.

  Declaration

  Objective-C

  @property (nonatomic, readonly, nullable) MLKTrackingNumberEntity *trackingNumberEntity;

• -init

  Unavailable.

  Declaration

  Objective-C

  - (nonnull instancetype)init;