MLKitEntityExtraction Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Constants
The following constants are available globally.
-
Identifies a physical address.
-
Identifies a time reference that includes a specific time. May be absolute such as “01/01/2000
5:30pm” or relative like “tomorrow”.
-
Identifies an e-mail address.
-
Identifies a flight number in IATA format.
-
Identifies an International Bank Account Number (IBAN).
-
Identifies an International Standard Book Number (ISBN).
-
Identifies an amount of money.
-
Identifies a payment card.
-
Identifies a phone number.
-
Identifies a shipment tracking number.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
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 page lists available constants for Entity Extraction in ML Kit.\u003c/p\u003e\n"],["\u003cp\u003eConstants are categorized for identifying entity types like addresses, dates, emails, and more.\u003c/p\u003e\n"],["\u003cp\u003eIt also includes constants representing different language models supported for extraction.\u003c/p\u003e\n"],["\u003cp\u003eThese constants are used within the ML Kit Entity Extraction API for Swift.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize these constants for specifying entity types and language models when working with the API.\u003c/p\u003e\n"]]],["This document outlines globally available constants for entity extraction within a Swift framework. It defines constants for identifying various entity types, such as `address`, `dateTime`, `email`, `flightNumber`, `IBAN`, `ISBN`, `money`, `paymentCard`, `phone`, `trackingNumber`, and `URL`. Additionally, it specifies constants for supported language models, including `arabic`, `chinese`, `dutch`, `english`, `french`, `german`, `italian`, `japanese`, `korean`, `polish`, `portuguese`, `russian`, `spanish`, `thai`, and `turkish`. Each constant is defined with a static declaration.\n"],null,["# MLKitEntityExtraction Framework Reference\n\nConstants\n=========\n\nThe following constants are available globally.\n- `\n ``\n ``\n `\n\n ### [address](#/c:@MLKEntityExtractionEntityTypeAddress)\n\n `\n ` \n Identifies a physical address. \n\n #### Declaration\n\n Swift \n\n static let address: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [dateTime](#/c:@MLKEntityExtractionEntityTypeDateTime)\n\n `\n ` \n Identifies a time reference that includes a specific time. May be absolute such as \"01/01/2000\n 5:30pm\" or relative like \"tomorrow\". \n\n #### Declaration\n\n Swift \n\n static let dateTime: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [email](#/c:@MLKEntityExtractionEntityTypeEmail)\n\n `\n ` \n Identifies an e-mail address. \n\n #### Declaration\n\n Swift \n\n static let email: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [flightNumber](#/c:@MLKEntityExtractionEntityTypeFlightNumber)\n\n `\n ` \n Identifies a flight number in IATA format. \n\n #### Declaration\n\n Swift \n\n static let flightNumber: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [IBAN](#/c:@MLKEntityExtractionEntityTypeIBAN)\n\n `\n ` \n Identifies an International Bank Account Number (IBAN). \n\n #### Declaration\n\n Swift \n\n static let IBAN: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [ISBN](#/c:@MLKEntityExtractionEntityTypeISBN)\n\n `\n ` \n Identifies an International Standard Book Number (ISBN). \n\n #### Declaration\n\n Swift \n\n static let ISBN: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [money](#/c:@MLKEntityExtractionEntityTypeMoney)\n\n `\n ` \n Identifies an amount of money. \n\n #### Declaration\n\n Swift \n\n static let money: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [paymentCard](#/c:@MLKEntityExtractionEntityTypePaymentCard)\n\n `\n ` \n Identifies a payment card. \n\n #### Declaration\n\n Swift \n\n static let paymentCard: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [phone](#/c:@MLKEntityExtractionEntityTypePhone)\n\n `\n ` \n Identifies a phone number. \n\n #### Declaration\n\n Swift \n\n static let phone: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [trackingNumber](#/c:@MLKEntityExtractionEntityTypeTrackingNumber)\n\n `\n ` \n Identifies a shipment tracking number. \n\n #### Declaration\n\n Swift \n\n static let trackingNumber: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [URL](#/c:@MLKEntityExtractionEntityTypeURL)\n\n `\n ` \n Identifies a URL. \n\n #### Declaration\n\n Swift \n\n static let URL: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntity.h@T@MLKEntityExtractionEntityType\n\n- `\n ``\n ``\n `\n\n ### [arabic](#/c:@MLKEntityExtractionModelIdentifierArabic)\n\n `\n ` \n Arabic. \n\n #### Declaration\n\n Swift \n\n static let arabic: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [chinese](#/c:@MLKEntityExtractionModelIdentifierChinese)\n\n `\n ` \n Chinese. \n\n #### Declaration\n\n Swift \n\n static let chinese: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [dutch](#/c:@MLKEntityExtractionModelIdentifierDutch)\n\n `\n ` \n Dutch. \n\n #### Declaration\n\n Swift \n\n static let dutch: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [english](#/c:@MLKEntityExtractionModelIdentifierEnglish)\n\n `\n ` \n English. \n\n #### Declaration\n\n Swift \n\n static let english: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [french](#/c:@MLKEntityExtractionModelIdentifierFrench)\n\n `\n ` \n French. \n\n #### Declaration\n\n Swift \n\n static let french: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [german](#/c:@MLKEntityExtractionModelIdentifierGerman)\n\n `\n ` \n German. \n\n #### Declaration\n\n Swift \n\n static let german: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [italian](#/c:@MLKEntityExtractionModelIdentifierItalian)\n\n `\n ` \n Italian. \n\n #### Declaration\n\n Swift \n\n static let italian: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [japanese](#/c:@MLKEntityExtractionModelIdentifierJapanese)\n\n `\n ` \n Japanese. \n\n #### Declaration\n\n Swift \n\n static let japanese: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [korean](#/c:@MLKEntityExtractionModelIdentifierKorean)\n\n `\n ` \n Korean. \n\n #### Declaration\n\n Swift \n\n static let korean: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [polish](#/c:@MLKEntityExtractionModelIdentifierPolish)\n\n `\n ` \n Polish. \n\n #### Declaration\n\n Swift \n\n static let polish: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [portuguese](#/c:@MLKEntityExtractionModelIdentifierPortuguese)\n\n `\n ` \n Portuguese. \n\n #### Declaration\n\n Swift \n\n static let portuguese: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [russian](#/c:@MLKEntityExtractionModelIdentifierRussian)\n\n `\n ` \n Russian. \n\n #### Declaration\n\n Swift \n\n static let russian: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [spanish](#/c:@MLKEntityExtractionModelIdentifierSpanish)\n\n `\n ` \n Spanish. \n\n #### Declaration\n\n Swift \n\n static let spanish: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [thai](#/c:@MLKEntityExtractionModelIdentifierThai)\n\n `\n ` \n Thai. \n\n #### Declaration\n\n Swift \n\n static let thai: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier\n\n- `\n ``\n ``\n `\n\n ### [turkish](#/c:@MLKEntityExtractionModelIdentifierTurkish)\n\n `\n ` \n Turkish. \n\n #### Declaration\n\n Swift \n\n static let turkish: /ml-kit/reference/swift/mlkitentityextraction/api/reference/Type-Definitions#/c:MLKEntityExtractionModelIdentifier.h@T@MLKEntityExtractionModelIdentifier"]]