--- description: Unofficial Capacitor plugin for the Google ML Kit SDK to detect addresses, date-times, phone numbers, and more in text on Android and iOS. title: Capacitor ML Kit Entity Extraction Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/mlkit/entity-extraction.png --- [Skip to content ](#capacitor-ml-kit-entity-extraction-plugin) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Terms & Privacy ](#terms-privacy) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ Face Detection ](/docs/sdks/capacitor/mlkit/face-detection/) * [ Face Mesh Detection ](/docs/sdks/capacitor/mlkit/face-mesh-detection/) * [ GenAI Image Description ](/docs/sdks/capacitor/mlkit/genai-image-description/) * [ GenAI Prompt ](/docs/sdks/capacitor/mlkit/genai-prompt/) * [ GenAI Proofreading ](/docs/sdks/capacitor/mlkit/genai-proofreading/) * [ GenAI Rewriting ](/docs/sdks/capacitor/mlkit/genai-rewriting/) * [ GenAI Speech Recognition ](/docs/sdks/capacitor/mlkit/genai-speech-recognition/) * [ GenAI Summarization ](/docs/sdks/capacitor/mlkit/genai-summarization/) * [ Image Labeling ](/docs/sdks/capacitor/mlkit/image-labeling/) * [ Language Identification ](/docs/sdks/capacitor/mlkit/language-identification/) * [ Object Detection ](/docs/sdks/capacitor/mlkit/object-detection/) * [ Pose Detection ](/docs/sdks/capacitor/mlkit/pose-detection/) * [ Selfie Segmentation ](/docs/sdks/capacitor/mlkit/selfie-segmentation/) * [ Smart Reply ](/docs/sdks/capacitor/mlkit/smart-reply/) * [ Subject Segmentation ](/docs/sdks/capacitor/mlkit/subject-segmentation/) * [ Text Recognition ](/docs/sdks/capacitor/mlkit/text-recognition/) * [ Translation ](/docs/sdks/capacitor/mlkit/translation/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Terms & Privacy ](#terms-privacy) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor ML Kit Entity Extraction Plugin[ΒΆ](#capacitor-ml-kit-entity-extraction-plugin "Permanent link") Unofficial Capacitor plugin for [ML Kit Entity Extraction](https://developers.google.com/ml-kit/language/entity-extraction).[1](#fn:1) > \[!WARNING\] The ML Kit Entity Extraction API is currently in **beta**. The API surface and behavior may change in a backwards-incompatible way in future releases. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Use Cases[ΒΆ](#use-cases "Permanent link") The Entity Extraction plugin detects structured data such as addresses, date-times, and phone numbers in raw text directly on the device, for example: * **Messaging apps**: Turn detected phone numbers, addresses, or date-times into tappable actions. * **Email clients**: Recognize tracking numbers, flight numbers, or IBANs and offer quick actions. * **Calendar apps**: Suggest events from date-times mentioned in a message. * **Finance apps**: Detect payment cards, IBANs, or money amounts in pasted text. ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/entity-extraction` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capacitor-mlkit/entity-extraction [](#%5F%5Fcodelineno-2-2)npx cap sync ` **Attention**: This plugin **only supports CocoaPods** for iOS dependency management. Swift Package Manager (SPM) is not supported for the ML Kit SDK, see [this comment](https://github.com/googlesamples/mlkit/issues/180#issuecomment-1298964099). ### Android[ΒΆ](#android "Permanent link") #### Variables[ΒΆ](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$mlkitEntityExtractionVersion` version of `com.google.mlkit:entity-extraction` (default: `16.0.0-beta6`) This can be useful if you encounter dependency conflicts with other plugins in your project. ### iOS[ΒΆ](#ios "Permanent link") #### Minimum Deployment Target[ΒΆ](#minimum-deployment-target "Permanent link") Make sure to set the deployment target in your `ios/App/Podfile` to at least `15.5`: `[](#%5F%5Fcodelineno-3-1)platform :ios, '15.5' ` ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Demo[ΒΆ](#demo "Permanent link") A working example can be found here: [robingenz/capacitor-mlkit-plugin-demo](https://github.com/robingenz/capacitor-mlkit-plugin-demo) ## Usage[ΒΆ](#usage "Permanent link") Before you can extract entities, you must download the model for the language you want to use. The model is downloaded once and then reused for all subsequent extractions. The following example shows how to download the English model and extract a date-time entity from a text. A `referenceTime` is provided so that relative date-times such as "tomorrow" can be resolved. `` [](#%5F%5Fcodelineno-4-1)import { [](#%5F%5Fcodelineno-4-2) EntityExtraction, [](#%5F%5Fcodelineno-4-3) EntityType, [](#%5F%5Fcodelineno-4-4) ErrorCode, [](#%5F%5Fcodelineno-4-5) Language, [](#%5F%5Fcodelineno-4-6)} from '@capacitor-mlkit/entity-extraction'; [](#%5F%5Fcodelineno-4-7) [](#%5F%5Fcodelineno-4-8)const downloadModel = async () => { [](#%5F%5Fcodelineno-4-9) await EntityExtraction.downloadModel({ [](#%5F%5Fcodelineno-4-10) language: Language.English, [](#%5F%5Fcodelineno-4-11) }); [](#%5F%5Fcodelineno-4-12)}; [](#%5F%5Fcodelineno-4-13) [](#%5F%5Fcodelineno-4-14)const getDownloadedModels = async () => { [](#%5F%5Fcodelineno-4-15) const { languages } = await EntityExtraction.getDownloadedModels(); [](#%5F%5Fcodelineno-4-16) return languages; [](#%5F%5Fcodelineno-4-17)}; [](#%5F%5Fcodelineno-4-18) [](#%5F%5Fcodelineno-4-19)const extractEntities = async () => { [](#%5F%5Fcodelineno-4-20) try { [](#%5F%5Fcodelineno-4-21) const { annotations } = await EntityExtraction.extractEntities({ [](#%5F%5Fcodelineno-4-22) text: 'Let\'s meet tomorrow at 5pm.', [](#%5F%5Fcodelineno-4-23) language: Language.English, [](#%5F%5Fcodelineno-4-24) referenceTime: Date.now(), [](#%5F%5Fcodelineno-4-25) referenceTimeZone: 'America/New_York', [](#%5F%5Fcodelineno-4-26) }); [](#%5F%5Fcodelineno-4-27) for (const annotation of annotations) { [](#%5F%5Fcodelineno-4-28) for (const entity of annotation.entities) { [](#%5F%5Fcodelineno-4-29) if (entity.type === EntityType.DateTime) { [](#%5F%5Fcodelineno-4-30) console.log(annotation.text, entity.timestamp); [](#%5F%5Fcodelineno-4-31) } [](#%5F%5Fcodelineno-4-32) } [](#%5F%5Fcodelineno-4-33) } [](#%5F%5Fcodelineno-4-34) } catch (error) { [](#%5F%5Fcodelineno-4-35) if (error.code === ErrorCode.ModelNotDownloaded) { [](#%5F%5Fcodelineno-4-36) // The model must be downloaded first using `downloadModel(...)`. [](#%5F%5Fcodelineno-4-37) } [](#%5F%5Fcodelineno-4-38) } [](#%5F%5Fcodelineno-4-39)}; [](#%5F%5Fcodelineno-4-40) [](#%5F%5Fcodelineno-4-41)const deleteDownloadedModel = async () => { [](#%5F%5Fcodelineno-4-42) await EntityExtraction.deleteDownloadedModel({ [](#%5F%5Fcodelineno-4-43) language: Language.English, [](#%5F%5Fcodelineno-4-44) }); [](#%5F%5Fcodelineno-4-45)}; `` ## API[ΒΆ](#api "Permanent link") * [deleteDownloadedModel(...)](#deletedownloadedmodel) * [downloadModel(...)](#downloadmodel) * [extractEntities(...)](#extractentities) * [getDownloadedModels()](#getdownloadedmodels) * [Interfaces](#interfaces) * [Enums](#enums) ### deleteDownloadedModel(...)[ΒΆ](#deletedownloadedmodel "Permanent link") `[](#%5F%5Fcodelineno-5-1)deleteDownloadedModel(options: DeleteDownloadedModelOptions) => Promise ` Delete the model for the given language. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------------------------------- | | **options** | [DeleteDownloadedModelOptions](#deletedownloadedmodeloptions) | **Since:** 8.2.0 --- ### downloadModel(...)[ΒΆ](#downloadmodel "Permanent link") `[](#%5F%5Fcodelineno-6-1)downloadModel(options: DownloadModelOptions) => Promise ` Download the model for the given language. The model must be downloaded before entities can be extracted for a language. Only available on Android and iOS. | Param | Type | | ----------- | --------------------------------------------- | | **options** | [DownloadModelOptions](#downloadmodeloptions) | **Since:** 8.2.0 --- ### extractEntities(...)[ΒΆ](#extractentities "Permanent link") `[](#%5F%5Fcodelineno-7-1)extractEntities(options: ExtractEntitiesOptions) => Promise ` Extract entities (e.g. addresses, date-times or phone numbers) from the given text. The model for the given language must be downloaded first using the `downloadModel(...)` method. If the model is not downloaded, the method rejects with the `MODEL_NOT_DOWNLOADED` error code. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------------------- | | **options** | [ExtractEntitiesOptions](#extractentitiesoptions) | **Returns:** `Promise<[ExtractEntitiesResult](#extractentitiesresult)>` **Since:** 8.2.0 --- ### getDownloadedModels()[ΒΆ](#getdownloadedmodels "Permanent link") `[](#%5F%5Fcodelineno-8-1)getDownloadedModels() => Promise ` Get the languages for which a model has been downloaded. Only available on Android and iOS. **Returns:** `Promise<[GetDownloadedModelsResult](#getdownloadedmodelsresult)>` **Since:** 8.2.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### DeleteDownloadedModelOptions[ΒΆ](#deletedownloadedmodeloptions "Permanent link") | Prop | Type | Description | Since | | ------------ | --------------------- | ------------------------------------------- | ----- | | **language** | [Language](#language) | The language for which to delete the model. | 8.2.0 | #### DownloadModelOptions[ΒΆ](#downloadmodeloptions "Permanent link") | Prop | Type | Description | Since | | ------------ | --------------------- | --------------------------------------------- | ----- | | **language** | [Language](#language) | The language for which to download the model. | 8.2.0 | #### ExtractEntitiesResult[ΒΆ](#extractentitiesresult "Permanent link") | Prop | Type | Description | Since | | --------------- | -------------------- | -------------------------- | ----- | | **annotations** | EntityAnnotation\[\] | The extracted annotations. | 8.2.0 | #### EntityAnnotation[ΒΆ](#entityannotation "Permanent link") | Prop | Type | Description | Since | | ------------ | ---------- | ------------------------------------------------------------------------- | ----- | | **text** | string | The text segment within the original text that this annotation refers to. | 8.2.0 | | **start** | number | The start index (inclusive) of the annotation in the original text. | 8.2.0 | | **end** | number | The end index (exclusive) of the annotation in the original text. | 8.2.0 | | **entities** | Entity\[\] | The entities that this annotation could refer to. | 8.2.0 | #### Entity[ΒΆ](#entity "Permanent link") | Prop | Type | Description | Since | | ------------------------ | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----- | | **type** | [EntityType](#entitytype) | The type of the entity. | 8.2.0 | | **dateTimeGranularity** | [DateTimeGranularity](#datetimegranularity) | The granularity of the extracted date-time. Only available if type is DATE\_TIME. | 8.2.0 | | **timestamp** | number | The extracted date-time in milliseconds since epoch. Only available if type is DATE\_TIME. | 8.2.0 | | **unnormalizedCurrency** | string | The currency of the money as it appears in the text (not canonicalized). Only available if type is MONEY. | 8.2.0 | | **integerPart** | number | The integer part of the money amount. Only available if type is MONEY. | 8.2.0 | | **fractionalPart** | number | The fractional part of the money amount. Only available if type is MONEY. | 8.2.0 | | **paymentCardNetwork** | [PaymentCardNetwork](#paymentcardnetwork) | The network of the payment card. Only available if type is PAYMENT\_CARD. | 8.2.0 | | **paymentCardNumber** | string | The number of the payment card in canonical format. Only available if type is PAYMENT\_CARD. | 8.2.0 | | **airlineCode** | string | The IATA airline designator (two or three letters). Only available if type is FLIGHT\_NUMBER. | 8.2.0 | | **flightNumber** | string | The flight number (1 to 4 digits). Only available if type is FLIGHT\_NUMBER. | 8.2.0 | | **isbn** | string | The full ISBN in canonical format. Only available if type is ISBN. | 8.2.0 | | **iban** | string | The full IBAN in canonical format. Only available if type is IBAN. | 8.2.0 | | **ibanCountryCode** | string | The ISO 3166-1 alpha-2 country code of the IBAN. Only available if type is IBAN. | 8.2.0 | | **parcelCarrier** | [ParcelTrackingCarrier](#parceltrackingcarrier) | The parcel tracking carrier. Only available if type is TRACKING\_NUMBER. | 8.2.0 | | **parcelTrackingNumber** | string | The parcel tracking number in canonical format. Only available if type is TRACKING\_NUMBER. | 8.2.0 | #### ExtractEntitiesOptions[ΒΆ](#extractentitiesoptions "Permanent link") | Prop | Type | Description | Since | | --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **text** | string | The text to extract entities from. | 8.2.0 | | **language** | [Language](#language) | The language of the model to use. The model for this language must be downloaded first using the downloadModel(...) method. | 8.2.0 | | **referenceTime** | number | The reference time (in milliseconds since epoch) used to resolve relative date-times (e.g. "tomorrow"). Defaults to the current time. | 8.2.0 | | **referenceTimeZone** | string | The reference time zone (as an IANA time zone identifier) used to resolve relative date-times. Defaults to the device's time zone. | 8.2.0 | | **preferredLocale** | string | The preferred locale (as a BCP-47 language tag) used to disambiguate entities. Defaults to the device's locale. | 8.2.0 | | **entityTypes** | EntityType\[\] | The entity types to extract. If not set, all entity types are extracted. | 8.2.0 | #### GetDownloadedModelsResult[ΒΆ](#getdownloadedmodelsresult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------------ | ---------------------------------------------------- | ----- | | **languages** | Language\[\] | The languages for which a model has been downloaded. | 8.2.0 | ### Enums[ΒΆ](#enums "Permanent link") #### Language[ΒΆ](#language "Permanent link") | Members | Value | Since | | -------------- | ------------ | ----- | | **Arabic** | 'ARABIC' | 8.2.0 | | **Chinese** | 'CHINESE' | 8.2.0 | | **Dutch** | 'DUTCH' | 8.2.0 | | **English** | 'ENGLISH' | 8.2.0 | | **French** | 'FRENCH' | 8.2.0 | | **German** | 'GERMAN' | 8.2.0 | | **Italian** | 'ITALIAN' | 8.2.0 | | **Japanese** | 'JAPANESE' | 8.2.0 | | **Korean** | 'KOREAN' | 8.2.0 | | **Polish** | 'POLISH' | 8.2.0 | | **Portuguese** | 'PORTUGUESE' | 8.2.0 | | **Russian** | 'RUSSIAN' | 8.2.0 | | **Spanish** | 'SPANISH' | 8.2.0 | | **Thai** | 'THAI' | 8.2.0 | | **Turkish** | 'TURKISH' | 8.2.0 | #### EntityType[ΒΆ](#entitytype "Permanent link") | Members | Value | Description | Since | | ------------------ | ------------------ | --------------------------------------------- | ----- | | **Address** | 'ADDRESS' | A physical address. | 8.2.0 | | **DateTime** | 'DATE\_TIME' | A date and time reference. | 8.2.0 | | **Email** | 'EMAIL' | An e-mail address. | 8.2.0 | | **FlightNumber** | 'FLIGHT\_NUMBER' | A flight number in IATA format. | 8.2.0 | | **Iban** | 'IBAN' | An International Bank Account Number (IBAN). | 8.2.0 | | **Isbn** | 'ISBN' | An International Standard Book Number (ISBN). | 8.2.0 | | **Money** | 'MONEY' | An amount of money. | 8.2.0 | | **PaymentCard** | 'PAYMENT\_CARD' | A payment card. | 8.2.0 | | **Phone** | 'PHONE' | A phone number. | 8.2.0 | | **TrackingNumber** | 'TRACKING\_NUMBER' | A shipment tracking number. | 8.2.0 | | **Url** | 'URL' | A URL. | 8.2.0 | #### DateTimeGranularity[ΒΆ](#datetimegranularity "Permanent link") | Members | Value | Since | | ----------- | --------- | ----- | | **Unknown** | 'UNKNOWN' | 8.2.0 | | **Year** | 'YEAR' | 8.2.0 | | **Month** | 'MONTH' | 8.2.0 | | **Week** | 'WEEK' | 8.2.0 | | **Day** | 'DAY' | 8.2.0 | | **Hour** | 'HOUR' | 8.2.0 | | **Minute** | 'MINUTE' | 8.2.0 | | **Second** | 'SECOND' | 8.2.0 | #### PaymentCardNetwork[ΒΆ](#paymentcardnetwork "Permanent link") | Members | Value | Since | | ---------------- | ---------------- | ----- | | **Unknown** | 'UNKNOWN' | 8.2.0 | | **Amex** | 'AMEX' | 8.2.0 | | **DinersClub** | 'DINERS\_CLUB' | 8.2.0 | | **Discover** | 'DISCOVER' | 8.2.0 | | **InterPayment** | 'INTER\_PAYMENT' | 8.2.0 | | **Jcb** | 'JCB' | 8.2.0 | | **Maestro** | 'MAESTRO' | 8.2.0 | | **Mastercard** | 'MASTERCARD' | 8.2.0 | | **Mir** | 'MIR' | 8.2.0 | | **Troy** | 'TROY' | 8.2.0 | | **Unionpay** | 'UNIONPAY' | 8.2.0 | | **Visa** | 'VISA' | 8.2.0 | #### ParcelTrackingCarrier[ΒΆ](#parceltrackingcarrier "Permanent link") | Members | Value | Since | | -------------- | -------------- | ----- | | **Unknown** | 'UNKNOWN' | 8.2.0 | | **Fedex** | 'FEDEX' | 8.2.0 | | **Ups** | 'UPS' | 8.2.0 | | **Dhl** | 'DHL' | 8.2.0 | | **Usps** | 'USPS' | 8.2.0 | | **Ontrac** | 'ONTRAC' | 8.2.0 | | **Lasership** | 'LASERSHIP' | 8.2.0 | | **IsraelPost** | 'ISRAEL\_POST' | 8.2.0 | | **SwissPost** | 'SWISS\_POST' | 8.2.0 | | **Msc** | 'MSC' | 8.2.0 | | **Amazon** | 'AMAZON' | 8.2.0 | | **IParcel** | 'I\_PARCEL' | 8.2.0 | ## FAQ[ΒΆ](#faq "Permanent link") ### Which platforms are supported by this plugin?[ΒΆ](#which-platforms-are-supported-by-this-plugin "Permanent link") The plugin is available on Android and iOS. All methods are only available on Android and iOS, so there is no web implementation. ### Which languages are supported?[ΒΆ](#which-languages-are-supported "Permanent link") The following languages are supported: Arabic, Chinese, Dutch, English, French, German, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Thai and Turkish (see the [Language](#language) enum). Note that a single model can extract entities from text in its language. ### Why does `extractEntities(...)` reject with `MODEL_NOT_DOWNLOADED`?[ΒΆ](#why-does-extractentities-reject-with-model%5Fnot%5Fdownloaded "Permanent link") Entities can only be extracted for a language whose model has been downloaded. Download the model first using the `downloadModel(...)` method and handle the `MODEL_NOT_DOWNLOADED` error code to prompt a download. ### How do I resolve relative date-times such as "tomorrow"?[ΒΆ](#how-do-i-resolve-relative-date-times-such-as-tomorrow "Permanent link") Provide a `referenceTime` (and optionally a `referenceTimeZone`) to the `extractEntities(...)` method. Relative date-times are resolved against this reference time. If not set, the current time and the device's time zone are used. ### Can I install this plugin using Swift Package Manager?[ΒΆ](#can-i-install-this-plugin-using-swift-package-manager "Permanent link") No, this plugin only supports CocoaPods for iOS dependency management because the ML Kit SDK itself does not support Swift Package Manager. Also make sure to set the deployment target in your `ios/App/Podfile` to at least `15.5` (see [Installation](#installation)). ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [Translation](https://capawesome.io/docs/sdks/capacitor/mlkit/translation/): Translate text before or after extracting entities. * [Language Identification](https://capawesome.io/docs/sdks/capacitor/mlkit/language-identification/): Detect the language of a text before choosing a model. ## Terms & Privacy[ΒΆ](#terms-privacy "Permanent link") This plugin uses the [Google ML Kit](https://developers.google.com/ml-kit): * [Terms & Privacy](https://developers.google.com/ml-kit/terms) * [Android Data Disclosure](https://developers.google.com/ml-kit/android-data-disclosure) * [iOS Data Disclosure](https://developers.google.com/ml-kit/ios-data-disclosure) ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/entity-extraction/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/entity-extraction/LICENSE). --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") July 10, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/#article", "headline": "Capacitor ML Kit Entity Extraction Plugin", "name": "Capacitor ML Kit Entity Extraction Plugin", "description": "Unofficial Capacitor plugin for the Google ML Kit SDK to detect addresses, date-times, phone numbers, and more in text on Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/#software", "name": "Capacitor ML Kit Entity Extraction Plugin", "description": "Unofficial Capacitor plugin for the Google ML Kit SDK to detect addresses, date-times, phone numbers, and more in text on Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "Which platforms are supported by this plugin?", "acceptedAnswer": {"@type": "Answer", "text": "The plugin is available on Android and iOS. All methods are only available on Android and iOS, so there is no web implementation."}}, {"@type": "Question", "name": "Which languages are supported?", "acceptedAnswer": {"@type": "Answer", "text": "The following languages are supported: Arabic, Chinese, Dutch, English, French, German, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Thai and Turkish (see the Language enum). Note that a single model can extract entities from text in its language."}}, {"@type": "Question", "name": "Why does extractEntities(...) reject with MODEL_NOT_DOWNLOADED?", "acceptedAnswer": {"@type": "Answer", "text": "Entities can only be extracted for a language whose model has been downloaded. Download the model first using the downloadModel(...) method and handle the MODEL_NOT_DOWNLOADED error code to prompt a download."}}, {"@type": "Question", "name": "How do I resolve relative date-times such as \"tomorrow\"?", "acceptedAnswer": {"@type": "Answer", "text": "Provide a referenceTime (and optionally a referenceTimeZone) to the extractEntities(...) method. Relative date-times are resolved against this reference time. If not set, the current time and the device's time zone are used."}}, {"@type": "Question", "name": "Can I install this plugin using Swift Package Manager?", "acceptedAnswer": {"@type": "Answer", "text": "No, this plugin only supports CocoaPods for iOS dependency management because the ML Kit SDK itself does not support Swift Package Manager. Also make sure to set the deployment target in your ios/App/Podfile to at least 15.5 (see Installation)."}}], "url": "https://capawesome.io/docs/sdks/capacitor/mlkit/entity-extraction/"} ```