MLKitEntityExtraction Framework Reference

  • MLKEntity represents an extracted entity from a text substring, with properties indicating the entity's type and specific details.

  • Entities can be of various types, including date/time, flight number, IBAN, ISBN, money, payment card, and tracking number.

  • Each entity type has a corresponding property in MLKEntity that returns an object of a specific class containing the entity's details or nil if not found.

  • MLKEntity is an NSObject subclass and provides access to extracted entities for further processing or analysis within your application.

Entity

class Entity : NSObject

An entity extracted from a substring of text.

  • The type of the extracted entity.

    Declaration

    Swift

    var entityType: EntityType { get }

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

    Declaration

    Swift

    var dateTimeEntity: MLKDateTimeEntity? { get }

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

    Declaration

    Swift

    var flightNumberEntity: MLKFlightNumberEntity? { get }

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

    Declaration

    Swift

    var ibanEntity: MLKIBANEntity? { get }

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

    Declaration

    Swift

    var isbnEntity: MLKISBNEntity? { get }

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

    Declaration

    Swift

    var moneyEntity: MLKMoneyEntity? { get }

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

    Declaration

    Swift

    var paymentCardEntity: MLKPaymentCardEntity? { get }

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

    Declaration

    Swift

    var trackingNumberEntity: MLKTrackingNumberEntity? { get }

  • Unavailable.