{"_id":"@capacitor-mlkit/genai-image-description","_rev":"3-a2c06c09f24369e9baac21a00b84d652","name":"@capacitor-mlkit/genai-image-description","dist-tags":{"latest":"8.2.1"},"versions":{"8.1.0":{"name":"@capacitor-mlkit/genai-image-description","version":"8.1.0","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","image description","image captioning","on-device ai"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@capacitor-mlkit/genai-image-description@8.1.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-image-description/","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"94ea3228c44e3be506173fda75e5126c13841453","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-image-description/-/genai-image-description-8.1.0.tgz","fileCount":35,"integrity":"sha512-AlTBvlrqEr5he1NHtMv1td1fbpFvw088OolqAgPVr3D+3I8ZmyglV1DtIMLOgRmXuxyjGmU9XwP5MqGylRp6NQ==","signatures":[{"sig":"MEQCICpf9Jf4r+tG9FuP1Vs8TaF59tsVhK+NSw2AihMFvb4VAiAljok/VItPplpUB8SODWpndSnzh5Wkc9zsek7oA5iDTQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":83268},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"6557f01f9f882afd5a13dff597f7635009585822","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api GenAiImageDescriptionPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"robingenz","email":"mail@robingenz.dev"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capawesome-team/capacitor-mlkit.git","type":"git"},"_npmVersion":"11.13.0","description":"Capacitor plugin for ML Kit GenAI Image Description on Android.","directories":{},"_nodeVersion":"24.16.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/genai-image-description_8.1.0_1783756920921_0.44158243708925515","host":"s3://npm-registry-packages-npm-production"}},"8.2.0":{"name":"@capacitor-mlkit/genai-image-description","version":"8.2.0","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","image description","image captioning","on-device ai"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@capacitor-mlkit/genai-image-description@8.2.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-image-description/","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"56bc7603b48f7d3058218b199c19400fd8425aa1","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-image-description/-/genai-image-description-8.2.0.tgz","fileCount":35,"integrity":"sha512-clZwFX6VeAKdi002EpYo8fa337h4OLeFOWVepb0UVSWZCuVv9UL3LmIfKUC5F+maKOGQuNxQkYk8zdFukAnQRQ==","signatures":[{"sig":"MEUCIQCCEEpYym+tlZ9SNlNrI+cZT/dhM3bKstJ1sitQH0Dd1gIgS39qYS1QEM/goOb8LvKI0TSf6pcbBwdN2BrEDQ0OxMc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-mlkit%2fgenai-image-description@8.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":83268},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"b960e3339eb497476360d5a6b24bb993f3449ba8","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api GenAiImageDescriptionPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:8e00c5c6-963c-41b5-8245-d6f123603aa4"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capawesome-team/capacitor-mlkit.git","type":"git"},"_npmVersion":"11.16.0","description":"Capacitor plugin for ML Kit GenAI Image Description on Android.","directories":{},"_nodeVersion":"24.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/genai-image-description_8.2.0_1784269871247_0.0882593811374821","host":"s3://npm-registry-packages-npm-production"}},"8.2.1":{"_id":"@capacitor-mlkit/genai-image-description@8.2.1","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"5630362dbfb993fcb04752504bf165eaeb16bc92","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-image-description/-/genai-image-description-8.2.1.tgz","fileCount":35,"integrity":"sha512-hNnnQdl8+w7aHydlkYcIUlk1a0emu8uonOAwRI+jO9j6hB2muHqxlGHQCvSxubvnSnYOVhe4v01ONN0vf/51hw==","signatures":[{"sig":"MEUCIQDvo1gWWrdfGXzNnXcsBXtf3QdYEL8IhhVzwrT3aqo9cwIgMRG/p4veP7Ds92aJEoeFSlMaCO70BQBbpV8iyQv0u7Q=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIBOkq4wCPDQ2nh1DB3RtoPkOO23KgQfhtG3HMyGud2muAiEAuekT3ev7FcyOegVgRsM63EzzFsioNxkDo70otBcL3OI="}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-mlkit%2fgenai-image-description@8.2.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":83161},"main":"dist/plugin.cjs.js","name":"@capacitor-mlkit/genai-image-description","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"0fcd1977cfb70d9c39d618680045cf01434aebf2","license":"Apache-2.0","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api GenAiImageDescriptionPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"version":"8.2.1","_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:8e00c5c6-963c-41b5-8245-d6f123603aa4"}},"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-image-description/","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","image description","image captioning","on-device ai"],"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capawesome-team/capacitor-mlkit.git","type":"git"},"_npmVersion":"11.19.0","description":"Capacitor plugin for ML Kit GenAI Image Description on Android.","directories":{},"maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"_nodeVersion":"24.20.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.62.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.5.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.9.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/genai-image-description_8.2.1_1789015877705_0.3724208425661335"}}},"time":{"created":"2026-07-11T08:02:00.770Z","modified":"2026-09-10T04:51:18.246Z","8.1.0":"2026-07-11T08:02:01.111Z","8.2.0":"2026-07-17T06:31:11.390Z","8.2.1":"2026-09-10T04:51:17.781Z"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-image-description/","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","image description","image captioning","on-device ai"],"repository":{"url":"git+https://github.com/capawesome-team/capacitor-mlkit.git","type":"git"},"description":"Capacitor plugin for ML Kit GenAI Image Description on Android.","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"readme":"# Capacitor ML Kit GenAI Image Description Plugin\n\nUnofficial Capacitor plugin for [ML Kit GenAI Image Description](https://developers.google.com/ml-kit/genai/image-description).[^1]\n\n> [!WARNING]\n> The ML Kit GenAI APIs are currently in **beta**. The API surface and behavior may change in future releases.\n\n<div class=\"capawesome-z29o10a\">\n  <a href=\"https://cloud.capawesome.io/\" target=\"_blank\">\n    <img alt=\"Deliver Live Updates to your Capacitor app with Capawesome Cloud\" src=\"https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1\" />\n  </a>\n</div>\n\n## Use Cases\n\nThe GenAI Image Description plugin is typically used to generate a natural-language description of an image on-device using Gemini Nano, for example:\n\n- **Accessibility**: Generate alternative text for images to support screen readers.\n- **Content moderation**: Get a textual summary of user-uploaded images.\n- **Search and organization**: Describe images to make them searchable or to auto-tag a photo library.\n\n## Requirements\n\nThis plugin uses [Gemini Nano](https://developers.google.com/ml-kit/genai), which runs entirely on-device. It is only available on Android and has the following device requirements:\n\n- The device must support Gemini Nano (see [supported devices](https://developers.google.com/ml-kit/genai#supported_devices)).\n- The device must run Android API level 26 or higher.\n- The device must not have an unlocked bootloader.\n\nUse the `checkFeatureStatus(...)` method to check whether the feature is available on the device.\n\n## Compatibility\n\n| Plugin Version | Capacitor Version | Status         |\n| -------------- | ----------------- | -------------- |\n| 8.x.x          | >=8.x.x           | Active support |\n\n## Installation\n\nYou can use our **AI-Assisted Setup** to install the plugin.\nAdd the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:\n\n```bash\nnpx skills add capawesome-team/skills --skill capacitor-plugins\n```\n\nThen use the following prompt:\n\n```\nUse the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/genai-image-description` plugin in my project.\n```\n\nIf you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:\n\n```bash\nnpm install @capacitor-mlkit/genai-image-description\nnpx cap sync\n```\n\n### Android\n\n#### API level\n\nThis plugin requires a minimum API level of 26. Make sure to set the `minSdkVersion` in your `variables.gradle` file to at least `26`.\n\n#### Variables\n\nThis plugin will use the following project variables (defined in your app’s `variables.gradle` file):\n\n- `$mlkitGenaiImageDescriptionVersion` version of `com.google.mlkit:genai-image-description` (default: `1.0.0-beta1`)\n\n## Usage\n\nThe following example shows how to check the feature status, download the feature and describe an image.\n\n> The image description is currently only available in English.\n\n### Check the feature status\n\nBefore using the image description feature, check whether it is available on the device:\n\n```typescript\nimport {\n  FeatureStatus,\n  GenAiImageDescription,\n} from '@capacitor-mlkit/genai-image-description';\n\nconst checkFeatureStatus = async () => {\n  const { featureStatus } = await GenAiImageDescription.checkFeatureStatus();\n  return featureStatus === FeatureStatus.Available;\n};\n```\n\n### Download the feature\n\nIf the feature status is `DOWNLOADABLE`, download the feature before using it. Add a listener for the `downloadProgress` event to get notified about the download progress:\n\n```typescript\nimport { GenAiImageDescription } from '@capacitor-mlkit/genai-image-description';\n\nconst downloadFeature = async () => {\n  await GenAiImageDescription.addListener('downloadProgress', event => {\n    console.log('Total bytes downloaded:', event.totalBytesDownloaded);\n  });\n  await GenAiImageDescription.downloadFeature();\n};\n```\n\n### Describe an image\n\nPass the local file path of the image to `describeImage(...)` to generate a description. Add a listener for the `inferenceProgress` event to receive partial results as they are generated:\n\n```typescript\nimport { GenAiImageDescription } from '@capacitor-mlkit/genai-image-description';\n\nconst describeImage = async () => {\n  await GenAiImageDescription.addListener('inferenceProgress', event => {\n    console.log('Partial result:', event.text);\n  });\n  const { description } = await GenAiImageDescription.describeImage({\n    path: 'file:///path/to/image.jpg',\n  });\n  return description;\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`checkFeatureStatus()`](#checkfeaturestatus)\n* [`describeImage(...)`](#describeimage)\n* [`downloadFeature()`](#downloadfeature)\n* [`addListener('downloadProgress', ...)`](#addlistenerdownloadprogress-)\n* [`addListener('inferenceProgress', ...)`](#addlistenerinferenceprogress-)\n* [`removeAllListeners()`](#removealllisteners)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### checkFeatureStatus()\n\n```typescript\ncheckFeatureStatus() => Promise<CheckFeatureStatusResult>\n```\n\nCheck the current availability status of the image description feature.\n\nIf the status is `DOWNLOADABLE`, you can download the feature\nusing `downloadFeature(...)`.\n\nOnly available on Android.\n\n**Returns:** <code>Promise&lt;<a href=\"#checkfeaturestatusresult\">CheckFeatureStatusResult</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### describeImage(...)\n\n```typescript\ndescribeImage(options: DescribeImageOptions) => Promise<DescribeImageResult>\n```\n\nGenerate a natural-language description of the given image.\n\nThe `inferenceProgress` event listener will notify you about\npartial results as they are generated. The returned promise\nresolves with the full result.\n\nThe description is currently only available in English.\n\nOnly available on Android.\n\n| Param         | Type                                                                  |\n| ------------- | --------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#describeimageoptions\">DescribeImageOptions</a></code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#describeimageresult\">DescribeImageResult</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### downloadFeature()\n\n```typescript\ndownloadFeature() => Promise<void>\n```\n\nDownload the image description feature.\n\nThe `downloadProgress` event listener will notify you about\nthe download progress. The returned promise resolves when\nthe download is complete or the feature is already available.\n\nOnly available on Android.\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### addListener('downloadProgress', ...)\n\n```typescript\naddListener(eventName: 'downloadProgress', listenerFunc: (event: DownloadProgressEvent) => void) => Promise<PluginListenerHandle>\n```\n\nCalled while the image description feature is being downloaded.\n\nOnly available on Android.\n\n| Param              | Type                                                                                        |\n| ------------------ | ------------------------------------------------------------------------------------------- |\n| **`eventName`**    | <code>'downloadProgress'</code>                                                             |\n| **`listenerFunc`** | <code>(event: <a href=\"#downloadprogressevent\">DownloadProgressEvent</a>) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### addListener('inferenceProgress', ...)\n\n```typescript\naddListener(eventName: 'inferenceProgress', listenerFunc: (event: InferenceProgressEvent) => void) => Promise<PluginListenerHandle>\n```\n\nCalled when a new partial result is available during inference.\n\nOnly available on Android.\n\n| Param              | Type                                                                                          |\n| ------------------ | --------------------------------------------------------------------------------------------- |\n| **`eventName`**    | <code>'inferenceProgress'</code>                                                              |\n| **`listenerFunc`** | <code>(event: <a href=\"#inferenceprogressevent\">InferenceProgressEvent</a>) =&gt; void</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promise<void>\n```\n\nRemove all listeners for this plugin.\n\n**Since:** 8.2.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### CheckFeatureStatusResult\n\n| Prop                | Type                                                    | Description                                                       | Since |\n| ------------------- | ------------------------------------------------------- | ----------------------------------------------------------------- | ----- |\n| **`featureStatus`** | <code><a href=\"#featurestatus\">FeatureStatus</a></code> | The current availability status of the image description feature. | 8.2.0 |\n\n\n#### DescribeImageResult\n\n| Prop              | Type                | Description                                    | Since |\n| ----------------- | ------------------- | ---------------------------------------------- | ----- |\n| **`description`** | <code>string</code> | The natural-language description of the image. | 8.2.0 |\n\n\n#### DescribeImageOptions\n\n| Prop       | Type                | Description                                   | Since |\n| ---------- | ------------------- | --------------------------------------------- | ----- |\n| **`path`** | <code>string</code> | The local file path of the image to describe. | 8.2.0 |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n#### DownloadProgressEvent\n\n| Prop                       | Type                | Description                                  | Since |\n| -------------------------- | ------------------- | -------------------------------------------- | ----- |\n| **`totalBytesDownloaded`** | <code>number</code> | The total number of bytes downloaded so far. | 8.2.0 |\n\n\n#### InferenceProgressEvent\n\n| Prop       | Type                | Description                         | Since |\n| ---------- | ------------------- | ----------------------------------- | ----- |\n| **`text`** | <code>string</code> | The new text of the partial result. | 8.2.0 |\n\n\n### Enums\n\n\n#### FeatureStatus\n\n| Members            | Value                       | Description                                                 | Since |\n| ------------------ | --------------------------- | ----------------------------------------------------------- | ----- |\n| **`Available`**    | <code>'AVAILABLE'</code>    | The feature is available to use.                            | 8.2.0 |\n| **`Downloadable`** | <code>'DOWNLOADABLE'</code> | The feature can be downloaded using `downloadFeature(...)`. | 8.2.0 |\n| **`Downloading`**  | <code>'DOWNLOADING'</code>  | The feature is currently being downloaded.                  | 8.2.0 |\n| **`Unavailable`**  | <code>'UNAVAILABLE'</code>  | The feature is not available on this device.                | 8.2.0 |\n\n</docgen-api>\n\n## FAQ\n\n### What are the requirements to use this plugin?\n\nThe image description is performed on-device by Gemini Nano. This requires a device that supports Gemini Nano, Android API level 26 or higher and a locked bootloader (see [Requirements](#requirements)). Use the `checkFeatureStatus(...)` method to check whether the feature is available on the device.\n\n### Why is this plugin only available on Android?\n\nThe ML Kit GenAI APIs are based on Gemini Nano and AICore, which are currently only available on Android. On iOS and Web, all methods reject with an appropriate error.\n\n### In which language is the description generated?\n\nThe image description is currently only available in English. Support for more languages is planned for future releases.\n\n### How do I get the description as a stream?\n\nAdd a listener for the `inferenceProgress` event before calling `describeImage(...)`. The listener is called with each partial result as it is generated. The promise returned by `describeImage(...)` resolves with the full result.\n\n### Can I use this plugin with Ionic, React, Vue or Angular?\n\nYes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.\n\n## Related Plugins\n\n- [Translation](https://capawesome.io/docs/sdks/capacitor/mlkit/translation/): Unofficial Capacitor plugin for ML Kit Translation.\n- [Smart Reply](https://capawesome.io/docs/sdks/capacitor/mlkit/smart-reply/): Unofficial Capacitor plugin for ML Kit Smart Reply.\n- [GenAI Prompt](https://capawesome.io/docs/sdks/capacitor/mlkit/genai-prompt/): Run custom GenAI prompts, for example to expand on a generated image description.\n\n## Terms & Privacy\n\nThis plugin uses the [Google ML Kit](https://developers.google.com/ml-kit):\n\n- [Terms & Privacy](https://developers.google.com/ml-kit/terms)\n- [Android Data Disclosure](https://developers.google.com/ml-kit/android-data-disclosure)\n- [iOS Data Disclosure](https://developers.google.com/ml-kit/ios-data-disclosure)\n\n## Newsletter\n\nStay 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/).\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/genai-image-description/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/genai-image-description/LICENSE).\n\n[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.\n","readmeFilename":"README.md"}