MLKitEntityExtraction Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
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.
-
A class that extracts entities from the given input text.
Declaration
Swift
class
EntityExtractor
:
NSObject
-
Options for MLKEntityExtractor
.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003eThis page provides a list of globally available classes for entity extraction in ML Kit.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eEntityExtractor\u003c/code\u003e is the core class used to identify and extract entities like dates, addresses, and flight numbers from text.\u003c/p\u003e\n"],["\u003cp\u003eClasses like \u003ccode\u003eDateTimeEntity\u003c/code\u003e, \u003ccode\u003eFlightNumberEntity\u003c/code\u003e, and \u003ccode\u003eMoneyEntity\u003c/code\u003e represent specific types of extracted entities.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can customize the extraction process using parameters provided by \u003ccode\u003eEntityExtractionParams\u003c/code\u003e and \u003ccode\u003eEntityExtractorOptions\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eModelManager\u003c/code\u003e handles the management of remote and local models used for entity extraction.\u003c/p\u003e\n"]]],["The provided content details several classes for entity extraction in text. Key classes include `EntityExtractor` for extracting entities, `EntityExtractionParams` for customization, and `ModelManager` for managing models. `EntityExtractorRemoteModel` and `RemoteModel` handle remotely stored models. `EntityAnnotation` stores extracted entities. Specific entity classes like `DateTimeEntity`, `FlightNumberEntity`, `IBANEntity`, `ISBNEntity`, `MoneyEntity`, `MLKPaymentCardEntity` and `TrackingNumberEntity` represent different types of extracted data. `EntityExtractorOptions` defines extraction settings.\n"],null,["# MLKitEntityExtraction Framework Reference\n\nClasses\n=======\n\nThe following classes are available globally.\n- `\n ``\n ``\n `\n\n ### [DateTimeEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/DateTimeEntity)\n\n `\n ` \n A date and time entity extracted from text. \n\n #### Declaration\n\n Swift \n\n class DateTimeEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [Entity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/Entity)\n\n `\n ` \n An entity extracted from a substring of text. \n\n #### Declaration\n\n Swift \n\n class Entity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [EntityAnnotation](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/EntityAnnotation)\n\n `\n ` \n An object that contains the possible entities associated with a piece of the text. \n\n #### Declaration\n\n Swift \n\n class EntityAnnotation : NSObject\n\n- `\n ``\n ``\n `\n\n ### [EntityExtractionParams](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/EntityExtractionParams)\n\n `\n ` \n An object that contains various parameters that can be customized on each entity extraction\n call. \n\n #### Declaration\n\n Swift \n\n class EntityExtractionParams : NSObject\n\n- `\n ``\n ``\n `\n\n ### [EntityExtractorRemoteModel](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/EntityExtractorRemoteModel)\n\n `\n ` \n An entity extraction model that is stored remotely on the server and downloaded on the device. \n\n #### Declaration\n\n Swift \n\n class EntityExtractorRemoteModel : /ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/RemoteModel\n\n- `\n ``\n ``\n `\n\n ### [EntityExtractor](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/EntityExtractor)\n\n `\n ` \n A class that extracts entities from the given input text. \n\n #### Declaration\n\n Swift \n\n class EntityExtractor : NSObject\n\n- `\n ``\n ``\n `\n\n ### [EntityExtractorOptions](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/EntityExtractorOptions)\n\n `\n ` \n Options for`MLKEntityExtractor`. \n\n #### Declaration\n\n Swift \n\n class EntityExtractorOptions : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FlightNumberEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/FlightNumberEntity)\n\n `\n ` \n A flight number entity extracted from text. \n\n #### Declaration\n\n Swift \n\n class FlightNumberEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [IBANEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/IBANEntity)\n\n `\n ` \n An IBAN entity extracted from text. \n\n #### Declaration\n\n Swift \n\n class IBANEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [ISBNEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/ISBNEntity)\n\n `\n ` \n An ISBN entity extracted from text. \n\n #### Declaration\n\n Swift \n\n class ISBNEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [ModelManager](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/ModelManager)\n\n `\n ` \n Manages models that are used by MLKit features. \n\n #### Declaration\n\n Swift \n\n class ModelManager : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MoneyEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/MoneyEntity)\n\n `\n ` \n A money entity extracted from text. \n\n #### Declaration\n\n Swift \n\n class MoneyEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKPaymentCardEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/MLKPaymentCardEntity)\n\n `\n ` \n A payment card entity extracted from text. \n\n #### Declaration\n\n Swift \n\n class MLKPaymentCardEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [RemoteModel](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/RemoteModel)\n\n `\n ` \n A model that is stored remotely on the server and downloaded to the device. \n\n #### Declaration\n\n Swift \n\n class RemoteModel : NSObject\n\n- `\n ``\n ``\n `\n\n ### [TrackingNumberEntity](/ml-kit/reference/swift/mlkitentityextraction/api/reference/Classes/TrackingNumberEntity)\n\n `\n ` \n A tracking number extracted from text. \n\n #### Declaration\n\n Swift \n\n class TrackingNumberEntity : NSObject"]]
