{"_id":"@capacitor-mlkit/genai-prompt","_rev":"3-c5a2ef4402f13d3a936b1b9e9a4a7e6b","name":"@capacitor-mlkit/genai-prompt","dist-tags":{"latest":"8.2.1"},"versions":{"8.1.0":{"name":"@capacitor-mlkit/genai-prompt","version":"8.1.0","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","prompt","generate content","on-device ai"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@capacitor-mlkit/genai-prompt@8.1.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-prompt/","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"6144d51291f2d24b9a8399dcfe5e6159111500e2","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-prompt/-/genai-prompt-8.1.0.tgz","fileCount":35,"integrity":"sha512-R7p3nPe3gaSG99PEBmddUqR3KZYRNFXN/eWvjjoZz5Ulha7SeSsrn6jrtY8CLggnK6IHHmDLzIJaDjGhXCKPXg==","signatures":[{"sig":"MEYCIQC6U6svvakajLa9qq2p32dtLShTEdae9zNhWW+TScDJ0AIhAJzPIlFPNCY401WfsqeduKpd8mPrU32oFuNO4D17U4Uv","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":92266},"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 GenAiPromptPlugin --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 Prompt API 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-prompt_8.1.0_1783756925963_0.25267622132457634","host":"s3://npm-registry-packages-npm-production"}},"8.2.0":{"name":"@capacitor-mlkit/genai-prompt","version":"8.2.0","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","prompt","generate content","on-device ai"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@capacitor-mlkit/genai-prompt@8.2.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-prompt/","bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"dist":{"shasum":"54f9d4d0fb5494a0f092aa4e3401e3960a496d82","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-prompt/-/genai-prompt-8.2.0.tgz","fileCount":35,"integrity":"sha512-B5L2PWR1/ft+Ftbbh8oBaXHfBRGqdVCe4rA8d9917xV3bqY/whMoNEnXfijPArn3OJzupLTPBHQZDOTYTIdhFA==","signatures":[{"sig":"MEUCICeAf3gh81R3Rp+VctvL4Px7fMM8ujs5zStumDBsYQHRAiEA4LQhbNNntoYfl2zN23f3y8+kD/6l+gL40RuSnO4IHZI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-mlkit%2fgenai-prompt@8.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":92266},"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 GenAiPromptPlugin --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:6f0bb72e-6eca-430b-b81d-2539ed57de16"}},"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 Prompt API 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-prompt_8.2.0_1784269870599_0.0042345644158112705","host":"s3://npm-registry-packages-npm-production"}},"8.2.1":{"name":"@capacitor-mlkit/genai-prompt","version":"8.2.1","description":"Capacitor plugin for ML Kit GenAI Prompt API on Android.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-mlkit.git"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-mlkit/issues"},"funding":[{"type":"github","url":"https://github.com/sponsors/capawesome-team/"},{"type":"opencollective","url":"https://opencollective.com/capawesome"}],"keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","prompt","generate content","on-device ai"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api GenAiPromptPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd ..","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"8.0.0","@capacitor/cli":"8.5.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/ios":"8.0.0","@ionic/eslint-config":"0.4.0","eslint":"8.57.0","prettier-plugin-java":"2.9.7","rimraf":"6.1.2","rollup":"4.62.3","swiftlint":"2.0.0","typescript":"5.9.3"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"publishConfig":{"access":"public"},"homepage":"https://capawesome.io/docs/sdks/capacitor/mlkit/genai-prompt/","gitHead":"0fcd1977cfb70d9c39d618680045cf01434aebf2","_id":"@capacitor-mlkit/genai-prompt@8.2.1","_nodeVersion":"24.20.0","_npmVersion":"11.19.0","dist":{"integrity":"sha512-vSnxS3eaUqr4xRTXZYI7BL7cEcqNzC44akuiSjulh31Uiw5/7TW+5lMwTsls77RVeyaz7m65xuJ9T/xLFj480g==","shasum":"4a2827d1d5c57aded3ebaac6c96ca1400b9c3639","tarball":"https://registry.npmjs.org/@capacitor-mlkit/genai-prompt/-/genai-prompt-8.2.1.tgz","fileCount":35,"unpackedSize":91996,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-mlkit%2fgenai-prompt@8.2.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIAZjAoBXP7Ffa3JomyhsZLlaijCVhlhVYiDIIINPhl6VAiBorv8pINRb5MQp9rCZ4573aeZEvgLFoN5aN3O5273Rug=="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:6f0bb72e-6eca-430b-b81d-2539ed57de16"}},"directories":{},"maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/genai-prompt_8.2.1_1789015820583_0.3598725397812641"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-11T08:02:05.819Z","modified":"2026-09-10T04:50:21.088Z","8.1.0":"2026-07-11T08:02:06.092Z","8.2.0":"2026-07-17T06:31:10.792Z","8.2.1":"2026-09-10T04:50:20.707Z"},"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-prompt/","keywords":["capacitor","plugin","native","capacitor-plugin","mlkit","ml kit","genai","gemini nano","prompt","generate content","on-device ai"],"repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-mlkit.git"},"description":"Capacitor plugin for ML Kit GenAI Prompt API on Android.","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"readme":"# Capacitor ML Kit GenAI Prompt Plugin\n\nUnofficial Capacitor plugin for the [ML Kit GenAI Prompt API](https://developers.google.com/ml-kit/genai/prompt).[^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 Prompt plugin is typically used to send custom natural-language requests to Gemini Nano on-device, for example:\n\n- **Content generation**: Generate short texts such as poems, captions or replies from a custom prompt.\n- **Text transformation**: Rephrase, classify or extract information from user-provided text.\n- **Image understanding**: Ask questions about an image by combining an image with a text prompt.\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> [!IMPORTANT]\n> The Prompt API performs open-ended generation with an on-device model. The output is **not moderated**. You are responsible for reviewing the model output for your use case (see [Responsible AI](https://developers.google.com/ml-kit/genai/prompt#responsible_ai)).\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-prompt` 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-prompt\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- `$mlkitGenaiPromptVersion` version of `com.google.mlkit:genai-prompt` (default: `1.0.0-beta2`)\n\n## Usage\n\nThe following example shows how to check the feature status, download the feature and generate content from a prompt.\n\n> The prompt must be under 4,000 tokens (or about 3,000 English words). Use cases that require a long output (more than 256 tokens) should be avoided. The Prompt API is currently only validated for English and Korean.\n\n### Check the feature status\n\nBefore using the prompt feature, check whether it is available on the device:\n\n```typescript\nimport { FeatureStatus, GenAiPrompt } from '@capacitor-mlkit/genai-prompt';\n\nconst checkFeatureStatus = async () => {\n  const { featureStatus } = await GenAiPrompt.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 { GenAiPrompt } from '@capacitor-mlkit/genai-prompt';\n\nconst downloadFeature = async () => {\n  await GenAiPrompt.addListener('downloadProgress', event => {\n    console.log('Total bytes downloaded:', event.totalBytesDownloaded);\n  });\n  await GenAiPrompt.downloadFeature();\n};\n```\n\n### Generate content\n\nPass a prompt to `generateContent(...)` to generate content. Add a listener for the `inferenceProgress` event to receive partial results as they are generated:\n\n```typescript\nimport { GenAiPrompt } from '@capacitor-mlkit/genai-prompt';\n\nconst generateContent = async () => {\n  await GenAiPrompt.addListener('inferenceProgress', event => {\n    console.log('Partial result:', event.text);\n  });\n  const { text } = await GenAiPrompt.generateContent({\n    prompt: 'Write a short poem about the sea.',\n  });\n  return text;\n};\n```\n\nYou can also include an image in the prompt for a multimodal (image and text) request and tune the generation with optional parameters:\n\n```typescript\nimport { GenAiPrompt } from '@capacitor-mlkit/genai-prompt';\n\nconst generateContentFromImage = async () => {\n  const { text } = await GenAiPrompt.generateContent({\n    prompt: 'What is shown in this image?',\n    imagePath: 'file:///path/to/image.jpg',\n    temperature: 0.2,\n    topK: 16,\n    maxOutputTokens: 256,\n  });\n  return text;\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`checkFeatureStatus()`](#checkfeaturestatus)\n* [`downloadFeature()`](#downloadfeature)\n* [`generateContent(...)`](#generatecontent)\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 prompt 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### downloadFeature()\n\n```typescript\ndownloadFeature() => Promise<void>\n```\n\nDownload the prompt 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### generateContent(...)\n\n```typescript\ngenerateContent(options: GenerateContentOptions) => Promise<GenerateContentResult>\n```\n\nGenerate content from a custom text-only or multimodal\n(image and text) prompt.\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 output is open-ended generation from an on-device model\nand is not moderated. The prompt is currently only validated\nfor English and Korean.\n\nOnly available on Android.\n\n| Param         | Type                                                                      |\n| ------------- | ------------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#generatecontentoptions\">GenerateContentOptions</a></code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#generatecontentresult\">GenerateContentResult</a>&gt;</code>\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 prompt 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 prompt feature. | 8.2.0 |\n\n\n#### GenerateContentResult\n\n| Prop       | Type                | Description         | Since |\n| ---------- | ------------------- | ------------------- | ----- |\n| **`text`** | <code>string</code> | The generated text. | 8.2.0 |\n\n\n#### GenerateContentOptions\n\n| Prop                  | Type                | Description                                                                                                                                                                                            | Since |\n| --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |\n| **`imagePath`**       | <code>string</code> | The local file path of an image to include in the prompt for a multimodal (image and text) request.                                                                                                    | 8.2.0 |\n| **`maxOutputTokens`** | <code>number</code> | The maximum number of tokens that can be generated in the response. Use cases that require a long output (more than 256 tokens) should be avoided. If not set, the default value of the model is used. | 8.2.0 |\n| **`prompt`**          | <code>string</code> | The prompt to generate content from. The input must be under 4,000 tokens (or about 3,000 English words).                                                                                              | 8.2.0 |\n| **`seed`**            | <code>number</code> | The random seed used during inference. Using the same seed with the same options produces deterministic results. If not set, the default value of the model is used.                                   | 8.2.0 |\n| **`temperature`**     | <code>number</code> | Controls the randomness of the output. Lower values produce more deterministic output, higher values produce more creative output. If not set, the default value of the model is used.                 | 8.2.0 |\n| **`topK`**            | <code>number</code> | The number of highest-probability tokens that are considered when sampling the next token. If not set, the default value of the model is used.                                                         | 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 content generation 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### How large can the prompt be?\n\nThe prompt must be under 4,000 tokens (or about 3,000 English words). Use cases that require a long output (more than 256 tokens) should be avoided.\n\n### Is the output moderated?\n\nNo, the Prompt API performs open-ended generation with an on-device model and the output is not moderated. You are responsible for reviewing the model output for your use case.\n\n### How do I get the output as a stream?\n\nAdd a listener for the `inferenceProgress` event before calling `generateContent(...)`. The listener is called with each partial result as it is generated. The promise returned by `generateContent(...)` 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- [GenAI Image Description](https://capawesome.io/docs/sdks/capacitor/mlkit/genai-image-description/): Unofficial Capacitor plugin for ML Kit GenAI Image Description.\n- [GenAI Summarization](https://capawesome.io/docs/sdks/capacitor/mlkit/genai-summarization/): Unofficial Capacitor plugin for ML Kit GenAI Summarization.\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-prompt/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/genai-prompt/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"}