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
Objective-C
@interface
MLKDateTimeEntity
:
NSObject
-
An entity extracted from a substring of text.
Declaration
Objective-C
@interface
MLKEntity
:
NSObject
-
An object that contains the possible entities associated with a piece of the text.
Declaration
Objective-C
@interface
MLKEntityAnnotation
:
NSObject
-
An object that contains various parameters that can be customized on each entity extraction
call.
Declaration
Objective-C
@interface
MLKEntityExtractionParams
:
NSObject
-
An entity extraction model that is stored remotely on the server and downloaded on the device.
Declaration
Objective-C
@interface
MLKEntityExtractionRemoteModel
:
MLKRemoteModel
-
A class that extracts entities from the given input text.
Declaration
Objective-C
@interface
MLKEntityExtractor
:
NSObject
-
Declaration
Objective-C
@interface
MLKEntityExtractorOptions
:
NSObject
-
A flight number entity extracted from text.
Declaration
Objective-C
@interface
MLKFlightNumberEntity
:
NSObject
-
An IBAN entity extracted from text.
Declaration
Objective-C
@interface
MLKIBANEntity
:
NSObject
-
An ISBN entity extracted from text.
Declaration
Objective-C
@interface
MLKISBNEntity
:
NSObject
-
Manages models that are used by MLKit features.
Declaration
Objective-C
@interface
MLKModelManager
:
NSObject
-
A money entity extracted from text.
Declaration
Objective-C
@interface
MLKMoneyEntity
:
NSObject
-
A payment card entity extracted from text.
Declaration
Objective-C
@interface
MLKPaymentCardEntity
:
NSObject
-
A model that is stored remotely on the server and downloaded to the device.
Declaration
Objective-C
@interface
MLKRemoteModel
:
NSObject
-
A tracking number extracted from text.
Declaration
Objective-C
@interface
MLKTrackingNumberEntity
:
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 documentation outlines the globally available classes for ML Kit Entity Extraction on iOS.\u003c/p\u003e\n"],["\u003cp\u003eThe classes provide functionality for identifying and extracting various entities from text, such as dates, flight numbers, and payment card information.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can customize entity extraction using parameters and options provided by dedicated classes.\u003c/p\u003e\n"],["\u003cp\u003eThe API includes classes for managing remote models used for entity extraction.\u003c/p\u003e\n"],["\u003cp\u003eEach class has a detailed description, declaration, and often links to further documentation for a deeper understanding.\u003c/p\u003e\n"]]],[],null,["# MLKitEntityExtraction Framework Reference\n\nClasses\n=======\n\nThe following classes are available globally.\n- `\n ``\n ``\n `\n\n ### [MLKDateTimeEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKDateTimeEntity)\n\n `\n ` \n A date and time entity extracted from text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKDateTimeEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntity)\n\n `\n ` \n An entity extracted from a substring of text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKEntityAnnotation](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntityAnnotation)\n\n `\n ` \n An object that contains the possible entities associated with a piece of the text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKEntityAnnotation : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKEntityExtractionParams](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntityExtractionParams)\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 Objective-C \n\n\n @interface MLKEntityExtractionParams : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKEntityExtractionRemoteModel](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntityExtractionRemoteModel)\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 Objective-C \n\n\n @interface MLKEntityExtractionRemoteModel : /ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKRemoteModel\n\n- `\n ``\n ``\n `\n\n ### [MLKEntityExtractor](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntityExtractor)\n\n `\n ` \n A class that extracts entities from the given input text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKEntityExtractor : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKEntityExtractorOptions](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntityExtractorOptions)\n\n `\n ` \n Options for[MLKEntityExtractor](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKEntityExtractor). \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKEntityExtractorOptions : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKFlightNumberEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKFlightNumberEntity)\n\n `\n ` \n A flight number entity extracted from text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKFlightNumberEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKIBANEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKIBANEntity)\n\n `\n ` \n An IBAN entity extracted from text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKIBANEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKISBNEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKISBNEntity)\n\n `\n ` \n An ISBN entity extracted from text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKISBNEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKModelManager](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKModelManager)\n\n `\n ` \n Manages models that are used by MLKit features. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKModelManager : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKMoneyEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKMoneyEntity)\n\n `\n ` \n A money entity extracted from text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKMoneyEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKPaymentCardEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKPaymentCardEntity)\n\n `\n ` \n A payment card entity extracted from text. \n\n #### Declaration\n\n Objective-C \n\n @interface MLKPaymentCardEntity : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKRemoteModel](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKRemoteModel)\n\n `\n ` \n A model that is stored remotely on the server and downloaded to the device. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKRemoteModel : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKTrackingNumberEntity](/ml-kit/reference/ios/mlkitentityextraction/api/reference/Classes/MLKTrackingNumberEntity)\n\n `\n ` \n A tracking number extracted from text. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKTrackingNumberEntity : NSObject"]]