reis-mobile 0.3.6 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/CHANGELOG.md +24 -0
- package/README.md +175 -168
- package/THIRD_PARTY_NOTICES.md +224 -4
- package/agents/android-architect.md +89 -0
- package/agents/android-performance-engineer.md +92 -0
- package/agents/android-test-engineer.md +97 -0
- package/agents/flutter-test-engineer.md +2 -0
- package/agents/ios-architect.md +93 -0
- package/agents/ios-performance-engineer.md +92 -0
- package/agents/ios-test-engineer.md +95 -0
- package/agents/lead-mobile.md +10 -1
- package/agents/mobile-staff-engineer.md +1 -1
- package/agents/rn-architect.md +94 -0
- package/agents/rn-performance-engineer.md +92 -0
- package/agents/rn-test-engineer.md +98 -0
- package/bin/reis-mobile.mjs +59 -17
- package/commands/debate.md +10 -1
- package/commands/debug.md +60 -0
- package/commands/reis-mobile.md +7 -2
- package/core/config/project.mjs +59 -0
- package/core/registry/frontmatter.mjs +15 -4
- package/core/registry/registry.mjs +21 -1
- package/core/router/intents.mjs +2 -0
- package/core/router/router.mjs +10 -5
- package/package.json +1 -1
- package/skills/android-adaptive/SKILL.md +304 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/flexbox/container-behavior.md +112 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/flexbox/get-started.md +69 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/flexbox/index.md +81 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/flexbox/item-behavior.md +170 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/grid/container-properties.md +415 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/grid/get-started.md +51 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/grid/index.md +73 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/grid/item-properties.md +170 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/layouts/adaptive/mediaquery/index.md +333 -0
- package/skills/android-adaptive/references/android/develop/ui/compose/tooling/debug.md +114 -0
- package/skills/android-adaptive/references/android/guide/navigation/navigation-3/recipes/material-listdetail.md +141 -0
- package/skills/android-agp-9-upgrade/SKILL.md +106 -0
- package/skills/android-agp-9-upgrade/references/android/build/migrate-to-built-in-kotlin.md +416 -0
- package/skills/android-agp-9-upgrade/references/android/build/releases/agp-9-0-0-release-notes.md +554 -0
- package/skills/android-agp-9-upgrade/references/buildconfig.md +54 -0
- package/skills/android-agp-9-upgrade/references/ksp-kapt.md +39 -0
- package/skills/android-agp-9-upgrade/references/paparazzi-gradle-9.md +30 -0
- package/skills/android-agp-9-upgrade/references/recipes.md +62 -0
- package/skills/android-appfunctions/SKILL.md +74 -0
- package/skills/android-appfunctions/references/adb-interaction-testing.md +95 -0
- package/skills/android-appfunctions/references/context.md +26 -0
- package/skills/android-appfunctions/references/feature-discovery-analysis.md +71 -0
- package/skills/android-appfunctions/references/implementation-configuration.md +282 -0
- package/skills/android-appfunctions/references/kdoc-refinement-optimization.md +75 -0
- package/skills/android-appfunctions/references/migrate-to-service-entry-point.md +226 -0
- package/skills/android-camerax/SKILL.md +135 -0
- package/skills/android-camerax/references/camera1-to-camerax.md +198 -0
- package/skills/android-camerax/references/camera2-to-camerax.md +193 -0
- package/skills/android-camerax/references/expert-blueprints.md +58 -0
- package/skills/android-camerax/references/foldables.md +83 -0
- package/skills/android-camerax/references/immutability.md +60 -0
- package/skills/android-camerax/references/low-light.md +124 -0
- package/skills/android-camerax/references/mlkit-spatial.md +75 -0
- package/skills/android-camerax/references/modern-apis.md +42 -0
- package/skills/android-camerax/references/testing.md +69 -0
- package/skills/android-camerax/references/thermals.md +85 -0
- package/skills/android-camerax/references/wear-os.md +76 -0
- package/skills/android-camerax/references/xr.md +54 -0
- package/skills/android-cli/SKILL.md +474 -0
- package/skills/android-cli/references/interact.md +113 -0
- package/skills/android-cli/references/journeys.md +120 -0
- package/skills/android-code-review/SKILL.md +58 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/SKILL.md +340 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/design/ui/ai-glasses/guides/interaction/inputs.md +67 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/access-hardware-projected-context.md +388 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/jetpack-compose-glimmer/buttons.md +139 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/jetpack-compose-glimmer/cards.md +148 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/jetpack-compose-glimmer/focus.md +107 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/jetpack-compose-glimmer/icons.md +90 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/jetpack-compose-glimmer/text.md +69 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/jetpack-compose-glimmer/title-chips.md +82 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/android/develop/xr/jetpack-xr-sdk/request-hardware-permissions.md +213 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/button-samples-source.md +176 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/button-source.md +203 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/card-samples-source.md +296 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/card-source.md +515 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/deptheffect-source.md +224 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/deptheffectlevels-source.md +105 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/glimmersansflextypography-source.md +270 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/glimmertheme-source.md +182 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/icon-source.md +388 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/iconbutton-source.md +126 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/iconsizes-source.md +78 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/list-source.md +27 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/listitem-source.md +272 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/liststate-source.md +427 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/material-hct-source.md +217 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/projectedcontext-source.md +265 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/stack-source.md +368 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/stackitemscope-source.md +440 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/stackstate-source.md +325 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/surface-source.md +1211 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/titlechip-samples-source.md +101 -0
- package/skills/android-display-glasses-with-jetpack-compose-glimmer/references/titlechip-source.md +131 -0
- package/skills/android-edge-to-edge/SKILL.md +429 -0
- package/skills/android-engage-sdk-integration/SKILL.md +130 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/faq.md +439 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/food.md +1149 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/healthandfitness.md +1055 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/listen.md +1050 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/otherverticals.md +1301 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/read.md +910 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/shopping.md +1224 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/social.md +719 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/travel.md +1413 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/tv/continue-watching/index.md +19 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/tv/entitlements.md +353 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/tv/getting-started.md +202 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/tv/recommendations.md +471 -0
- package/skills/android-engage-sdk-integration/references/android/guide/playcore/engage/watch.md +1081 -0
- package/skills/android-engage-sdk-integration/references/clusters.md +154 -0
- package/skills/android-engage-sdk-integration/references/common.md +519 -0
- package/skills/android-engage-sdk-integration/references/patterns.md +527 -0
- package/skills/android-engage-sdk-integration/references/requests.md +260 -0
- package/skills/android-engage-sdk-integration/references/schemas/food.md +509 -0
- package/skills/android-engage-sdk-integration/references/schemas/listen.md +842 -0
- package/skills/android-engage-sdk-integration/references/schemas/other.md +220 -0
- package/skills/android-engage-sdk-integration/references/schemas/read.md +412 -0
- package/skills/android-engage-sdk-integration/references/schemas/shopping.md +357 -0
- package/skills/android-engage-sdk-integration/references/schemas/social.md +228 -0
- package/skills/android-engage-sdk-integration/references/schemas/travel.md +923 -0
- package/skills/android-engage-sdk-integration/references/schemas/tv.md +1226 -0
- package/skills/android-engage-sdk-integration/references/schemas/watch.md +1137 -0
- package/skills/android-engage-sdk-integration/references/troubleshooting.md +39 -0
- package/skills/android-gradle-build-debug/SKILL.md +71 -0
- package/skills/android-intent-security/SKILL.md +550 -0
- package/skills/android-leanback-to-compose-tv-migration/SKILL.md +743 -0
- package/skills/android-leanback-to-compose-tv-migration/references/android/training/tv/get-started/navigation.md +372 -0
- package/skills/android-leanback-to-compose-tv-migration/references/android/training/tv/playback/compose/browse.md +243 -0
- package/skills/android-leanback-to-compose-tv-migration/references/android/training/tv/playback/compose/index.md +153 -0
- package/skills/android-media3-cast-integration/SKILL.md +236 -0
- package/skills/android-media3-cast-integration/references/android/media/media3/cast/create-castplayer.md +390 -0
- package/skills/android-media3-cast-integration/references/android/media/media3/cast/customize-castoptions.md +93 -0
- package/skills/android-media3-cast-integration/references/android/media/media3/cast/index.md +21 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/SKILL.md +127 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/analysis-of-the-project-and-layout.md +42 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/android/develop/ui/compose/designsystems/migrate-xml-theme-to-compose.md +171 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/android/develop/ui/compose/migrate/interoperability-apis/compose-in-views.md +299 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/android/develop/ui/compose/migrate/interoperability-apis/views-in-compose.md +286 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/android/develop/ui/compose/setup-compose-dependencies-and-compiler.md +197 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/identify-optimal-xml-candidate.md +31 -0
- package/skills/android-migrate-xml-views-to-jetpack-compose/references/xml-layout-migration.md +86 -0
- package/skills/android-ml-kit-genai-prompt-api/SKILL.md +124 -0
- package/skills/android-ml-kit-genai-prompt-api/references/get-started.md +272 -0
- package/skills/android-ml-kit-genai-prompt-api/references/prefix-caching.md +146 -0
- package/skills/android-ml-kit-genai-prompt-api/references/prompt-design.md +55 -0
- package/skills/android-ml-kit-genai-prompt-api/references/prompt-optimization.md +74 -0
- package/skills/android-ml-kit-genai-prompt-api/references/structured-output.md +219 -0
- package/skills/android-ml-kit-genai-prompt-api/references/system-instructions.md +71 -0
- package/skills/android-navigation-3/SKILL.md +122 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/index.md +51 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/migration-guide.md +670 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/animations.md +147 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/basic.md +89 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/basicdsl.md +85 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/basicsaveable.md +90 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/bottomsheet.md +195 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/common-ui.md +200 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/conditional-transitions.md +182 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/conditional.md +230 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/deeplinks-custommatcher.md +176 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/deeplinks-staticuri.md +140 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/deeplinks-syntheticbackstack.md +184 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/dialog.md +107 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/lifecycle-owner.md +185 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/material-listdetail.md +141 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/material-supportingpane.md +145 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/modular-hilt.md +283 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/modular-koin.md +287 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/multiple-backstacks.md +468 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/passingarguments.md +371 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/results-event.md +273 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/results-state.md +266 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/scenes-listdetail.md +435 -0
- package/skills/android-navigation-3/references/android/guide/navigation/navigation-3/recipes/scenes-twopane.md +244 -0
- package/skills/android-navigation-3/references/android/guide/navigation/type-safe-destinations.md +129 -0
- package/skills/android-navigation-event/SKILL.md +312 -0
- package/skills/android-navigation-event/references/android/guide/navigation/navigation-event/dispatcher.md +134 -0
- package/skills/android-navigation-event/references/android/guide/navigation/navigation-event/handle-back.md +217 -0
- package/skills/android-navigation-event/references/android/guide/navigation/navigation-event/index.md +83 -0
- package/skills/android-navigation-event/references/android/guide/navigation/navigation-event/setup.md +32 -0
- package/skills/android-play-billing-library-version-upgrade/SKILL.md +96 -0
- package/skills/android-play-billing-library-version-upgrade/references/android/google/play/billing/release-notes.md +1240 -0
- package/skills/android-play-billing-library-version-upgrade/references/migration-logic.md +78 -0
- package/skills/android-play-billing-library-version-upgrade/references/version-checklist.md +54 -0
- package/skills/android-play-policy-insights/SKILL.md +172 -0
- package/skills/android-play-policy-insights/resources/common_mandates.md +100 -0
- package/skills/android-play-policy-insights/resources/compliance_report_template.md +59 -0
- package/skills/android-play-policy-insights/resources/critic.md +86 -0
- package/skills/android-play-policy-insights/resources/goal_data_safety.md +212 -0
- package/skills/android-play-policy-insights/resources/goal_permissions_and_apis.md +459 -0
- package/skills/android-play-policy-insights/resources/goal_user_account.md +106 -0
- package/skills/android-play-policy-insights/resources/policies.json +321 -0
- package/skills/android-play-policy-insights/resources/scanner_config.json +843 -0
- package/skills/android-play-policy-insights/scripts/generate_report.py +860 -0
- package/skills/android-play-policy-insights/scripts/orchestrator.py +1313 -0
- package/skills/android-play-policy-insights/scripts/play_store_scraper.py +410 -0
- package/skills/android-play-policy-insights/scripts/scanner.py +261 -0
- package/skills/android-play-policy-insights/scripts/template_engine.py +243 -0
- package/skills/android-profiler/SKILL.md +60 -0
- package/skills/android-profiler/analysis/analysis_orchestrator.md +32 -0
- package/skills/android-profiler/analysis/workflows/perfetto-sql/perfetto_sql.md +28 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/perfetto_trace_analysis.md +121 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/guiding_principles.md +51 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/domain_hints_template.md +7 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/subsystems/hints_cpu.md +56 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/subsystems/hints_graphics.md +51 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/subsystems/hints_io.md +46 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/subsystems/hints_ipc.md +41 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/subsystems/hints_memory.md +55 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/hints/subsystems/hints_power.md +33 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/per_candidate_analysis.md +172 -0
- package/skills/android-profiler/analysis/workflows/perfetto-trace-analysis/references/triage.md +94 -0
- package/skills/android-profiler/recording/recording_orchestrator.md +36 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/perfetto_trace_recording.md +148 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/app_jank.pftxt +43 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/cpu_profile.pftxt +35 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/java_heap_dump.pftxt +21 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/long_background.pftxt +37 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/memory_counters.pftxt +45 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/native_heap.pftxt +21 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/example-configs/sched_cpu.pftxt +33 -0
- package/skills/android-profiler/recording/workflows/perfetto-trace-recording/references/trace_config_reference.md +102 -0
- package/skills/android-profiler/references/env_setup.md +15 -0
- package/skills/android-profiler/references/perfetto/setup.md +29 -0
- package/skills/android-profiler/references/perfetto/sql.md +327 -0
- package/skills/android-r8-analyzer/SKILL.md +72 -0
- package/skills/android-r8-analyzer/references/CONFIGURATION-ANALYZER.md +287 -0
- package/skills/android-r8-analyzer/references/CONFIGURATION.md +44 -0
- package/skills/android-r8-analyzer/references/KEEP-RULES-IMPACT-HIERARCHY.md +83 -0
- package/skills/android-r8-analyzer/references/REDUNDANT-RULES.md +222 -0
- package/skills/android-r8-analyzer/references/REFLECTION-GUIDE.md +139 -0
- package/skills/android-r8-analyzer/references/REPORT_FORMAT.md +51 -0
- package/skills/android-r8-analyzer/references/android/topic/performance/app-optimization/enable-app-optimization.md +252 -0
- package/skills/android-r8-analyzer/references/android/training/testing/other-components/ui-automator.md +312 -0
- package/skills/android-restore-credentials/SKILL.md +359 -0
- package/skills/android-restore-credentials/references/android/guide/topics/manifest/application-element.md +832 -0
- package/skills/android-restore-credentials/references/android/identity/passkeys/create-passkeys.md +327 -0
- package/skills/android-restore-credentials/references/android/identity/passkeys/sign-in-with-passkeys.md +219 -0
- package/skills/android-styles/SKILL.md +229 -0
- package/skills/android-styles/references/android/develop/ui/compose/designsystems/custom.md +459 -0
- package/skills/android-styles/references/android/develop/ui/compose/styles/fundamentals.md +421 -0
- package/skills/android-styles/references/android/develop/ui/compose/styles/state-animations.md +461 -0
- package/skills/android-styles/references/android/develop/ui/compose/styles/styles-vs-modifiers.md +48 -0
- package/skills/android-styles/references/android/develop/ui/compose/styles/theming.md +269 -0
- package/skills/android-verified-email/SKILL.md +432 -0
- package/skills/android-verified-email/references/android/identity/credential-manager/index.md +67 -0
- package/skills/android-verified-email/references/android/identity/digital-credentials/credential-verifier.md +166 -0
- package/skills/android-verified-email/references/android/identity/digital-credentials/email-verification-implementation.md +313 -0
- package/skills/android-verified-email/references/android/identity/digital-credentials/email-verification.md +158 -0
- package/skills/android-verified-email/references/android/identity/digital-credentials/index.md +112 -0
- package/skills/android-verified-email/references/android/identity/passkeys/create-passkeys.md +327 -0
- package/skills/android-verified-email/references/android/identity/sign-in/credential-manager-webview.md +84 -0
- package/skills/android-wear-compose-m3/SKILL.md +365 -0
- package/skills/android-wear-compose-m3/references/android/training/wearables/compose/migrate-to-material3.md +677 -0
- package/skills/android-wear-compose-m3/references/foundation/AmbientModeSample.kt.md +123 -0
- package/skills/android-wear-compose-m3/references/foundation/AmbientModeSample.kt.md.txt +123 -0
- package/skills/android-wear-compose-m3/references/foundation/CurvedWorldSample.kt.md +430 -0
- package/skills/android-wear-compose-m3/references/foundation/CurvedWorldSample.kt.md.txt +430 -0
- package/skills/android-wear-compose-m3/references/foundation/ExpandableSample.kt.md +99 -0
- package/skills/android-wear-compose-m3/references/foundation/ExpandableSample.kt.md.txt +99 -0
- package/skills/android-wear-compose-m3/references/foundation/HierarchicalFocusSample.kt.md +141 -0
- package/skills/android-wear-compose-m3/references/foundation/HierarchicalFocusSample.kt.md.txt +141 -0
- package/skills/android-wear-compose-m3/references/foundation/PagerSamples.kt.md +56 -0
- package/skills/android-wear-compose-m3/references/foundation/PagerSamples.kt.md.txt +56 -0
- package/skills/android-wear-compose-m3/references/foundation/RotarySamples.kt.md +153 -0
- package/skills/android-wear-compose-m3/references/foundation/RotarySamples.kt.md.txt +153 -0
- package/skills/android-wear-compose-m3/references/foundation/ScalingLazyColumnSample.kt.md +131 -0
- package/skills/android-wear-compose-m3/references/foundation/ScalingLazyColumnSample.kt.md.txt +131 -0
- package/skills/android-wear-compose-m3/references/foundation/SwipeToDismissBoxSample.kt.md +169 -0
- package/skills/android-wear-compose-m3/references/foundation/SwipeToDismissBoxSample.kt.md.txt +169 -0
- package/skills/android-wear-compose-m3/references/foundation/SwipeToRevealSample.kt.md +282 -0
- package/skills/android-wear-compose-m3/references/foundation/SwipeToRevealSample.kt.md.txt +282 -0
- package/skills/android-wear-compose-m3/references/foundation/TransformingLazyColumnSample.kt.md +335 -0
- package/skills/android-wear-compose-m3/references/foundation/TransformingLazyColumnSample.kt.md.txt +335 -0
- package/skills/android-wear-compose-m3/references/material3/AlertDialogSample.kt.md +377 -0
- package/skills/android-wear-compose-m3/references/material3/AlertDialogSample.kt.md.txt +377 -0
- package/skills/android-wear-compose-m3/references/material3/AnimatedTextSample.kt.md +165 -0
- package/skills/android-wear-compose-m3/references/material3/AnimatedTextSample.kt.md.txt +165 -0
- package/skills/android-wear-compose-m3/references/material3/ButtonGroupSample.kt.md +91 -0
- package/skills/android-wear-compose-m3/references/material3/ButtonGroupSample.kt.md.txt +91 -0
- package/skills/android-wear-compose-m3/references/material3/ButtonSample.kt.md +496 -0
- package/skills/android-wear-compose-m3/references/material3/ButtonSample.kt.md.txt +496 -0
- package/skills/android-wear-compose-m3/references/material3/CardSample.kt.md +470 -0
- package/skills/android-wear-compose-m3/references/material3/CardSample.kt.md.txt +470 -0
- package/skills/android-wear-compose-m3/references/material3/CheckboxButtonSample.kt.md +67 -0
- package/skills/android-wear-compose-m3/references/material3/CheckboxButtonSample.kt.md.txt +67 -0
- package/skills/android-wear-compose-m3/references/material3/ConfirmationDialogSample.kt.md +162 -0
- package/skills/android-wear-compose-m3/references/material3/ConfirmationDialogSample.kt.md.txt +162 -0
- package/skills/android-wear-compose-m3/references/material3/CurvedTextSamples.kt.md +78 -0
- package/skills/android-wear-compose-m3/references/material3/CurvedTextSamples.kt.md.txt +78 -0
- package/skills/android-wear-compose-m3/references/material3/DatePickerSample.kt.md +131 -0
- package/skills/android-wear-compose-m3/references/material3/DatePickerSample.kt.md.txt +131 -0
- package/skills/android-wear-compose-m3/references/material3/DynamicColorSchemeSample.kt.md +74 -0
- package/skills/android-wear-compose-m3/references/material3/DynamicColorSchemeSample.kt.md.txt +74 -0
- package/skills/android-wear-compose-m3/references/material3/EdgeButtonSample.kt.md +63 -0
- package/skills/android-wear-compose-m3/references/material3/EdgeButtonSample.kt.md.txt +63 -0
- package/skills/android-wear-compose-m3/references/material3/FadingExpandingLabelSample.kt.md +60 -0
- package/skills/android-wear-compose-m3/references/material3/FadingExpandingLabelSample.kt.md.txt +60 -0
- package/skills/android-wear-compose-m3/references/material3/IconButtonSample.kt.md +125 -0
- package/skills/android-wear-compose-m3/references/material3/IconButtonSample.kt.md.txt +125 -0
- package/skills/android-wear-compose-m3/references/material3/IconToggleButtonSample.kt.md +116 -0
- package/skills/android-wear-compose-m3/references/material3/IconToggleButtonSample.kt.md.txt +116 -0
- package/skills/android-wear-compose-m3/references/material3/LevelIndicatorSample.kt.md +68 -0
- package/skills/android-wear-compose-m3/references/material3/LevelIndicatorSample.kt.md.txt +68 -0
- package/skills/android-wear-compose-m3/references/material3/LinearProgressIndicatorSample.kt.md +50 -0
- package/skills/android-wear-compose-m3/references/material3/LinearProgressIndicatorSample.kt.md.txt +50 -0
- package/skills/android-wear-compose-m3/references/material3/ListHeaderSample.kt.md +177 -0
- package/skills/android-wear-compose-m3/references/material3/ListHeaderSample.kt.md.txt +177 -0
- package/skills/android-wear-compose-m3/references/material3/OneHandedGestureSamples.kt.md +651 -0
- package/skills/android-wear-compose-m3/references/material3/OneHandedGestureSamples.kt.md.txt +651 -0
- package/skills/android-wear-compose-m3/references/material3/OpenOnPhoneDialogSample.kt.md +57 -0
- package/skills/android-wear-compose-m3/references/material3/OpenOnPhoneDialogSample.kt.md.txt +57 -0
- package/skills/android-wear-compose-m3/references/material3/PageIndicatorSample.kt.md +110 -0
- package/skills/android-wear-compose-m3/references/material3/PageIndicatorSample.kt.md.txt +110 -0
- package/skills/android-wear-compose-m3/references/material3/PagerScaffoldSample.kt.md +204 -0
- package/skills/android-wear-compose-m3/references/material3/PagerScaffoldSample.kt.md.txt +204 -0
- package/skills/android-wear-compose-m3/references/material3/PickerGroupSample.kt.md +139 -0
- package/skills/android-wear-compose-m3/references/material3/PickerGroupSample.kt.md.txt +139 -0
- package/skills/android-wear-compose-m3/references/material3/PickerSample.kt.md +111 -0
- package/skills/android-wear-compose-m3/references/material3/PickerSample.kt.md.txt +111 -0
- package/skills/android-wear-compose-m3/references/material3/PlaceholderSample.kt.md +184 -0
- package/skills/android-wear-compose-m3/references/material3/PlaceholderSample.kt.md.txt +184 -0
- package/skills/android-wear-compose-m3/references/material3/ProgressIndicatorSample.kt.md +263 -0
- package/skills/android-wear-compose-m3/references/material3/ProgressIndicatorSample.kt.md.txt +263 -0
- package/skills/android-wear-compose-m3/references/material3/RadioButtonSample.kt.md +105 -0
- package/skills/android-wear-compose-m3/references/material3/RadioButtonSample.kt.md.txt +105 -0
- package/skills/android-wear-compose-m3/references/material3/ScaffoldSample.kt.md +146 -0
- package/skills/android-wear-compose-m3/references/material3/ScaffoldSample.kt.md.txt +146 -0
- package/skills/android-wear-compose-m3/references/material3/ScrollAwaySample.kt.md +97 -0
- package/skills/android-wear-compose-m3/references/material3/ScrollAwaySample.kt.md.txt +97 -0
- package/skills/android-wear-compose-m3/references/material3/ScrollIndicatorSample.kt.md +66 -0
- package/skills/android-wear-compose-m3/references/material3/ScrollIndicatorSample.kt.md.txt +66 -0
- package/skills/android-wear-compose-m3/references/material3/SliderSample.kt.md +86 -0
- package/skills/android-wear-compose-m3/references/material3/SliderSample.kt.md.txt +86 -0
- package/skills/android-wear-compose-m3/references/material3/StepperSample.kt.md +148 -0
- package/skills/android-wear-compose-m3/references/material3/StepperSample.kt.md.txt +148 -0
- package/skills/android-wear-compose-m3/references/material3/SurfaceTransformationSample.kt.md +166 -0
- package/skills/android-wear-compose-m3/references/material3/SurfaceTransformationSample.kt.md.txt +166 -0
- package/skills/android-wear-compose-m3/references/material3/SwipeToDismissBoxSample.kt.md +172 -0
- package/skills/android-wear-compose-m3/references/material3/SwipeToDismissBoxSample.kt.md.txt +172 -0
- package/skills/android-wear-compose-m3/references/material3/SwipeToRevealSample.kt.md +367 -0
- package/skills/android-wear-compose-m3/references/material3/SwipeToRevealSample.kt.md.txt +367 -0
- package/skills/android-wear-compose-m3/references/material3/SwitchButtonSample.kt.md +66 -0
- package/skills/android-wear-compose-m3/references/material3/SwitchButtonSample.kt.md.txt +66 -0
- package/skills/android-wear-compose-m3/references/material3/TextButtonSample.kt.md +115 -0
- package/skills/android-wear-compose-m3/references/material3/TextButtonSample.kt.md.txt +115 -0
- package/skills/android-wear-compose-m3/references/material3/TextToggleButtonSample.kt.md +71 -0
- package/skills/android-wear-compose-m3/references/material3/TextToggleButtonSample.kt.md.txt +71 -0
- package/skills/android-wear-compose-m3/references/material3/TimePickerSample.kt.md +151 -0
- package/skills/android-wear-compose-m3/references/material3/TimePickerSample.kt.md.txt +151 -0
- package/skills/android-wear-compose-m3/references/material3/TimeTextSample.kt.md +65 -0
- package/skills/android-wear-compose-m3/references/material3/TimeTextSample.kt.md.txt +65 -0
- package/skills/android-wear-compose-m3/references/material3/TransformationSpecSample.kt.md +246 -0
- package/skills/android-wear-compose-m3/references/material3/TransformationSpecSample.kt.md.txt +246 -0
- package/skills/android-wear-compose-m3/references/material3/TransformingLazyColumnNotificationsSample.kt.md +89 -0
- package/skills/android-wear-compose-m3/references/material3/TransformingLazyColumnNotificationsSample.kt.md.txt +89 -0
- package/skills/android-wear-compose-m3/references/material3/TransformingLazyColumnSample.kt.md +309 -0
- package/skills/android-wear-compose-m3/references/material3/TransformingLazyColumnSample.kt.md.txt +309 -0
- package/skills/android-wear-compose-m3/references/navigation3/SwipeDismissableSceneStrategySample.kt.md +205 -0
- package/skills/android-wear-compose-m3/references/navigation3/SwipeDismissableSceneStrategySample.kt.md.txt +205 -0
- package/skills/{architecture-feature-first → flutter-architecture-feature-first}/SKILL.md +1 -1
- package/skills/{bloc → flutter-bloc}/SKILL.md +1 -1
- package/skills/flutter-build-debug/SKILL.md +66 -0
- package/skills/{code-review → flutter-code-review}/SKILL.md +1 -1
- package/skills/{dart-3-updates → flutter-dart-3-updates}/SKILL.md +1 -1
- package/skills/{dart-fix-runtime-errors → flutter-dart-fix-runtime-errors}/SKILL.md +1 -1
- package/skills/{dart-resolve-package-conflicts → flutter-dart-resolve-package-conflicts}/SKILL.md +1 -1
- package/skills/{dart-run-static-analysis → flutter-dart-run-static-analysis}/SKILL.md +1 -1
- package/skills/{dart-use-pattern-matching → flutter-dart-use-pattern-matching}/SKILL.md +1 -1
- package/skills/{effective-dart → flutter-effective-dart}/SKILL.md +1 -1
- package/skills/{provider → flutter-provider}/SKILL.md +1 -1
- package/skills/{riverpod → flutter-riverpod}/SKILL.md +1 -1
- package/skills/ios-cocoapods-debug/SKILL.md +65 -0
- package/skills/ios-code-review/SKILL.md +56 -0
- package/skills/ios-xcode-build-debug/SKILL.md +66 -0
- package/skills/{detect-mobile-stack → mobile-detect-stack}/SKILL.md +1 -1
- package/skills/mobile-firebase/SKILL.md +54 -0
- package/skills/mobile-firebase/references/android/ai-logic.md +31 -0
- package/skills/mobile-firebase/references/android/analytics.md +33 -0
- package/skills/mobile-firebase/references/android/app-check.md +36 -0
- package/skills/mobile-firebase/references/android/auth.md +44 -0
- package/skills/mobile-firebase/references/android/crashlytics.md +31 -0
- package/skills/mobile-firebase/references/android/firestore.md +44 -0
- package/skills/mobile-firebase/references/android/functions.md +33 -0
- package/skills/mobile-firebase/references/android/in-app-messaging.md +28 -0
- package/skills/mobile-firebase/references/android/messaging.md +41 -0
- package/skills/mobile-firebase/references/android/realtime-database.md +50 -0
- package/skills/mobile-firebase/references/android/remote-config.md +43 -0
- package/skills/mobile-firebase/references/android/sql-connect.md +31 -0
- package/skills/mobile-firebase/references/android/storage.md +39 -0
- package/skills/mobile-firebase/references/android.md +30 -0
- package/skills/{firebase-ai/SKILL.md → mobile-firebase/references/flutter/ai-logic.md} +2 -8
- package/skills/{firebase-analytics/SKILL.md → mobile-firebase/references/flutter/analytics.md} +2 -8
- package/skills/{firebase-app-check/SKILL.md → mobile-firebase/references/flutter/app-check.md} +2 -8
- package/skills/{firebase-auth/SKILL.md → mobile-firebase/references/flutter/auth.md} +2 -8
- package/skills/{firebase-crashlytics/SKILL.md → mobile-firebase/references/flutter/crashlytics.md} +2 -8
- package/skills/{firebase-cloud-firestore/SKILL.md → mobile-firebase/references/flutter/firestore.md} +2 -8
- package/skills/{firebase-cloud-functions/SKILL.md → mobile-firebase/references/flutter/functions.md} +2 -8
- package/skills/{firebase-in-app-messaging/SKILL.md → mobile-firebase/references/flutter/in-app-messaging.md} +2 -8
- package/skills/{firebase-messaging/SKILL.md → mobile-firebase/references/flutter/messaging.md} +2 -8
- package/skills/{firebase-database/SKILL.md → mobile-firebase/references/flutter/realtime-database.md} +2 -8
- package/skills/{firebase-remote-config/SKILL.md → mobile-firebase/references/flutter/remote-config.md} +2 -8
- package/skills/{flutterfire-configure/SKILL.md → mobile-firebase/references/flutter/setup-flutterfire.md} +1 -8
- package/skills/{firebase-data-connect/SKILL.md → mobile-firebase/references/flutter/sql-connect.md} +2 -8
- package/skills/{firebase-storage/SKILL.md → mobile-firebase/references/flutter/storage.md} +2 -8
- package/skills/mobile-firebase/references/flutter.md +36 -0
- package/skills/mobile-firebase/references/ios/ai-logic.md +30 -0
- package/skills/mobile-firebase/references/ios/analytics.md +33 -0
- package/skills/mobile-firebase/references/ios/app-check.md +36 -0
- package/skills/mobile-firebase/references/ios/auth.md +48 -0
- package/skills/mobile-firebase/references/ios/crashlytics.md +34 -0
- package/skills/mobile-firebase/references/ios/firestore.md +53 -0
- package/skills/mobile-firebase/references/ios/functions.md +35 -0
- package/skills/mobile-firebase/references/ios/in-app-messaging.md +26 -0
- package/skills/mobile-firebase/references/ios/messaging.md +45 -0
- package/skills/mobile-firebase/references/ios/realtime-database.md +49 -0
- package/skills/mobile-firebase/references/ios/remote-config.md +44 -0
- package/skills/mobile-firebase/references/ios/sql-connect.md +33 -0
- package/skills/mobile-firebase/references/ios/storage.md +36 -0
- package/skills/mobile-firebase/references/ios.md +28 -0
- package/skills/mobile-firebase/references/react-native/ai-logic.md +32 -0
- package/skills/mobile-firebase/references/react-native/analytics.md +43 -0
- package/skills/mobile-firebase/references/react-native/app-check.md +35 -0
- package/skills/mobile-firebase/references/react-native/auth.md +50 -0
- package/skills/mobile-firebase/references/react-native/crashlytics.md +36 -0
- package/skills/mobile-firebase/references/react-native/firestore.md +45 -0
- package/skills/mobile-firebase/references/react-native/functions.md +28 -0
- package/skills/mobile-firebase/references/react-native/in-app-messaging.md +27 -0
- package/skills/mobile-firebase/references/react-native/messaging.md +46 -0
- package/skills/mobile-firebase/references/react-native/realtime-database.md +46 -0
- package/skills/mobile-firebase/references/react-native/remote-config.md +32 -0
- package/skills/mobile-firebase/references/react-native/sql-connect.md +11 -0
- package/skills/mobile-firebase/references/react-native/storage.md +30 -0
- package/skills/mobile-firebase/references/react-native.md +29 -0
- package/skills/mobile-test/SKILL.md +63 -0
- package/skills/mobile-test/references/android/setup/GUIDE.md +183 -0
- package/skills/mobile-test/references/android/setup/references/android/develop/ui/compose/testing/common-patterns.md +181 -0
- package/skills/mobile-test/references/android/setup/references/android/studio/preview/compose-screenshot-testing.md +255 -0
- package/skills/mobile-test/references/android/setup/references/android/training/dependency-injection/hilt-testing.md +447 -0
- package/skills/mobile-test/references/android.md +83 -0
- package/skills/{dart-collect-coverage/SKILL.md → mobile-test/references/flutter/coverage.md} +2 -11
- package/skills/{dart-generate-test-mocks/SKILL.md → mobile-test/references/flutter/generate-mocks.md} +2 -11
- package/skills/{flutter-add-integration-test/SKILL.md → mobile-test/references/flutter/integration-tests.md} +2 -11
- package/skills/{dart-migrate-to-checks-package/SKILL.md → mobile-test/references/flutter/migrate-to-checks.md} +2 -13
- package/skills/{mockito/SKILL.md → mobile-test/references/flutter/mockito.md} +1 -8
- package/skills/{mocktail/SKILL.md → mobile-test/references/flutter/mocktail.md} +1 -8
- package/skills/{patrol-e2e-testing/SKILL.md → mobile-test/references/flutter/patrol.md} +1 -8
- package/skills/{testing/SKILL.md → mobile-test/references/flutter/testing-guidelines.md} +1 -8
- package/skills/{dart-add-unit-test/SKILL.md → mobile-test/references/flutter/unit-tests.md} +2 -11
- package/skills/{flutter-add-widget-test/SKILL.md → mobile-test/references/flutter/widget-tests.md} +2 -11
- package/skills/mobile-test/references/flutter.md +44 -0
- package/skills/mobile-test/references/ios.md +79 -0
- package/skills/mobile-test/references/react-native.md +62 -0
- /package/skills/{dart-use-pattern-matching → flutter-dart-use-pattern-matching}/examples/json_patterns.dart +0 -0
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: android-ml-kit-genai-prompt-api
|
|
3
|
+
description: Analyzes Android codebases to implement ML Kit GenAI Prompt API. Use
|
|
4
|
+
this skill to send natural language requests on-device to Gemini Nano, use structured
|
|
5
|
+
output with Prompt API, implement prefix caching, optimize the current prompt, or
|
|
6
|
+
apply best practices."
|
|
7
|
+
license: Apache-2.0
|
|
8
|
+
source: https://github.com/android/skills
|
|
9
|
+
routing: manual
|
|
10
|
+
stacks: [android]
|
|
11
|
+
metadata:
|
|
12
|
+
author: Google LLC
|
|
13
|
+
last-updated: '2026-09-03'
|
|
14
|
+
keywords:
|
|
15
|
+
- ML Kit
|
|
16
|
+
- Prompt API
|
|
17
|
+
- Structured Output
|
|
18
|
+
- Prefix Caching
|
|
19
|
+
- Gemini Nano
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
This skill provides step-by-step guidance for integrating and optimizing the ML
|
|
23
|
+
Kit GenAI Prompt API in Android apps.
|
|
24
|
+
|
|
25
|
+
## Prerequisites
|
|
26
|
+
|
|
27
|
+
- Android API level must be 26 or higher. If `minSdk` is below 26, update it to 26.
|
|
28
|
+
- Add the ML Kit GenAI Prompt API dependency (`com.google.mlkit:genai-prompt`) to the app-level `build.gradle` file, with version at least `1.0.0-beta4`.
|
|
29
|
+
- If `com.google.mlkit:genai-schema-compiler` dependency is used and KSP plugin version is below 2.3.6, update it to 2.3.6.
|
|
30
|
+
|
|
31
|
+
## Detailed steps
|
|
32
|
+
|
|
33
|
+
### 1. Prompt optimization
|
|
34
|
+
|
|
35
|
+
To optimize prompts for use with the ML Kit Prompt API, follow the
|
|
36
|
+
[prompt optimization guide](https://developer.android.com/agents/skills/device-ai/prompt-api/references/prompt-optimization).
|
|
37
|
+
|
|
38
|
+
### 2. Prefix caching optimization
|
|
39
|
+
|
|
40
|
+
If the prompt is more than 200 words, implement the [prefix caching API](https://developer.android.com/agents/skills/device-ai/prompt-api/references/prefix-caching).
|
|
41
|
+
|
|
42
|
+
### 3. Lifecycle and best practices
|
|
43
|
+
|
|
44
|
+
- The model must be fully downloaded and available before calling the first inference. Follow the guide on [implementing a generative model](https://developer.android.com/agents/skills/device-ai/prompt-api/references/get-started) to check that the `FeatureStatus` of a model is `AVAILABLE` before making an inference.
|
|
45
|
+
- Release ML Kit instances by calling `close()` when an `Activity`,
|
|
46
|
+
`Fragment`, or `ViewModel` is destroyed. Example:
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
```kotlin
|
|
50
|
+
// Instantiating model in activity, fragment, or ViewModel
|
|
51
|
+
val generativeModel = Generation.getClient()
|
|
52
|
+
|
|
53
|
+
// When activity, fragment, or ViewModel is destroyed
|
|
54
|
+
generativeModel.close()
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
<br />
|
|
58
|
+
|
|
59
|
+
### 4. Structured output
|
|
60
|
+
|
|
61
|
+
When implementing or refactoring a prompt to use structured output, follow
|
|
62
|
+
these rules:
|
|
63
|
+
|
|
64
|
+
1. **Check for API availability:** Verify Structured Output feature is available on the device with `isStructuredOutputFeatureAvailable()` before using it. Refer to the [Structured Output API guide](https://developer.android.com/agents/skills/device-ai/prompt-api/references/structured-output) for full instructions.
|
|
65
|
+
2. **Return type:** Return the `@Generable` typed object from the function
|
|
66
|
+
signature instead of a `String` or JSON string.
|
|
67
|
+
|
|
68
|
+
For example:
|
|
69
|
+
|
|
70
|
+
fun parseEmail(email: String): String {
|
|
71
|
+
...
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
should be refactored to:
|
|
75
|
+
|
|
76
|
+
fun parseEmail(email: String): ParsedEmail? {
|
|
77
|
+
...
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
3. **Example:**
|
|
81
|
+
|
|
82
|
+
This is the example code before refactoring:
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
```kotlin
|
|
86
|
+
suspend fun parseEmail(email: String): String {
|
|
87
|
+
val parseEmailPrompt = "Parse this email and return the sender, title, and short summary of the email less than 10 words: "
|
|
88
|
+
|
|
89
|
+
val parsedEmail = generativeModel.generateContent(parseEmailPrompt + email)
|
|
90
|
+
|
|
91
|
+
return parsedEmail.candidates[0].text
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
<br />
|
|
96
|
+
|
|
97
|
+
This is the example code after using Structured Output API:
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
```kotlin
|
|
101
|
+
@Generable
|
|
102
|
+
data class ParsedEmail(
|
|
103
|
+
@Guide(description = "Sender of the email")
|
|
104
|
+
var sender: String = "",
|
|
105
|
+
|
|
106
|
+
@Guide(description = "Title of the email")
|
|
107
|
+
var title: String = "",
|
|
108
|
+
|
|
109
|
+
@Guide(description = "Summary of the email less than 10 words")
|
|
110
|
+
var summary: String = ""
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
suspend fun parseEmail(email: String): ParsedEmail? {
|
|
114
|
+
val parseEmailPrompt =
|
|
115
|
+
"Parse this email: $email"
|
|
116
|
+
|
|
117
|
+
val baseRequest = GenerateContentRequest.Builder(TextPart(parseEmailPrompt)).build()
|
|
118
|
+
val typedRequest = generateTypedContentRequest(baseRequest, ParsedEmail::class)
|
|
119
|
+
val typedResponse = generativeModel.generateContent(typedRequest)
|
|
120
|
+
return typedResponse.candidates[0].response
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
<br />
|
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
This page describes how to do the following:
|
|
2
|
+
|
|
3
|
+
- Configure your project to use Prompt API
|
|
4
|
+
- Provide text-only input and receive a response
|
|
5
|
+
- Provide an image input with related text input and receive a response
|
|
6
|
+
|
|
7
|
+
For more details about the Prompt API, see the
|
|
8
|
+
reference documentation for Kotlin ([com.google.mlkit.genai.prompt](https://developer.android.com/android/reference/kotlin/com/google/mlkit/genai/prompt/package-summary)) and
|
|
9
|
+
Java ([com.google.mlkit.genai.prompt.java](https://developer.android.com/android/reference/com/google/mlkit/genai/prompt/java/package-summary),
|
|
10
|
+
[com.google.mlkit.genai.prompt](https://developer.android.com/android/reference/com/google/mlkit/genai/prompt/package-summary)).
|
|
11
|
+
|
|
12
|
+
## Configure project
|
|
13
|
+
|
|
14
|
+
> [!NOTE]
|
|
15
|
+
> **Note:** This API requires Android API level 26 or higher.
|
|
16
|
+
|
|
17
|
+
Add the ML Kit Prompt API as a dependency in your `build.gradle` configuration:
|
|
18
|
+
|
|
19
|
+
implementation("com.google.mlkit:genai-prompt:1.0.0-beta2")
|
|
20
|
+
|
|
21
|
+
If you need your responses in a certain format using the Structured Output API,
|
|
22
|
+
you need to configure KSP and add additional dependencies. For details, see
|
|
23
|
+
[Generate structured output](https://developer.android.com/agents/skills/device-ai/prompt-api/references/structured-output).
|
|
24
|
+
|
|
25
|
+
## Implement generative model
|
|
26
|
+
|
|
27
|
+
To implement the code in your project, follow these steps:
|
|
28
|
+
|
|
29
|
+
- Create a `generativeModel` object:
|
|
30
|
+
|
|
31
|
+
### Kotlin
|
|
32
|
+
|
|
33
|
+
// Get a GenerativeModel instance
|
|
34
|
+
val generativeModel = Generation.getClient()
|
|
35
|
+
|
|
36
|
+
### Java
|
|
37
|
+
|
|
38
|
+
// Get a GenerativeModel instance
|
|
39
|
+
GenerativeModelFutures generativeModelFutures = GenerativeModelFutures
|
|
40
|
+
.from(Generation.INSTANCE.getClient());
|
|
41
|
+
|
|
42
|
+
- Check if Gemini Nano is `AVAILABLE,` `DOWNLOADABLE`, or `UNAVAILABLE`. Then,
|
|
43
|
+
download the feature if it is downloadable:
|
|
44
|
+
|
|
45
|
+
### Kotlin
|
|
46
|
+
|
|
47
|
+
val status = generativeModel.checkStatus()
|
|
48
|
+
when (status) {
|
|
49
|
+
FeatureStatus.UNAVAILABLE -> {
|
|
50
|
+
// Gemini Nano not supported on this device or device hasn't fetched the latest configuration to support it
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
FeatureStatus.DOWNLOADABLE -> {
|
|
54
|
+
// Gemini Nano can be downloaded on this device, but is not currently downloaded
|
|
55
|
+
generativeModel.download().collect { status ->
|
|
56
|
+
when (status) {
|
|
57
|
+
is DownloadStatus.DownloadStarted ->
|
|
58
|
+
Log.d(TAG, "starting download for Gemini Nano")
|
|
59
|
+
|
|
60
|
+
is DownloadStatus.DownloadProgress ->
|
|
61
|
+
Log.d(TAG, "Nano ${status.totalBytesDownloaded} bytes downloaded")
|
|
62
|
+
|
|
63
|
+
DownloadStatus.DownloadCompleted -> {
|
|
64
|
+
Log.d(TAG, "Gemini Nano download complete")
|
|
65
|
+
modelDownloaded = true
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
is DownloadStatus.DownloadFailed -> {
|
|
69
|
+
Log.e(TAG, "Nano download failed ${status.e.message}")
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
FeatureStatus.DOWNLOADING -> {
|
|
76
|
+
// Gemini Nano currently being downloaded
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
FeatureStatus.AVAILABLE -> {
|
|
80
|
+
// Gemini Nano currently downloaded and available to use on this device
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
### Java
|
|
85
|
+
|
|
86
|
+
ListenableFuture<Integer> status = generativeModelFutures.checkStatus();
|
|
87
|
+
Futures.addCallback(generativeModelFutures.checkStatus(), new FutureCallback<>() {
|
|
88
|
+
@Override
|
|
89
|
+
public void onSuccess(Integer featureStatus) {
|
|
90
|
+
switch (featureStatus) {
|
|
91
|
+
case FeatureStatus.AVAILABLE -> {
|
|
92
|
+
// Gemini Nano currently downloaded and available to use on this device
|
|
93
|
+
}
|
|
94
|
+
case FeatureStatus.UNAVAILABLE -> {
|
|
95
|
+
// Gemini Nano not supported on this device or device hasn't fetched the latest configuration to support it
|
|
96
|
+
}
|
|
97
|
+
case FeatureStatus.DOWNLOADING -> {
|
|
98
|
+
// Gemini Nano currently being downloaded
|
|
99
|
+
}
|
|
100
|
+
case FeatureStatus.DOWNLOADABLE -> {
|
|
101
|
+
generativeModelFutures.download(new DownloadCallback() {
|
|
102
|
+
@Override
|
|
103
|
+
public void onDownloadStarted(long l) {
|
|
104
|
+
Log.d(TAG, "starting download for Gemini Nano");
|
|
105
|
+
}
|
|
106
|
+
@Override
|
|
107
|
+
public void onDownloadProgress(long l) {
|
|
108
|
+
Log.d(TAG, "Nano " + l + " bytes downloaded");
|
|
109
|
+
}
|
|
110
|
+
@Override
|
|
111
|
+
public void onDownloadCompleted() {
|
|
112
|
+
Log.d(TAG, "Gemini Nano download complete");
|
|
113
|
+
}
|
|
114
|
+
@Override
|
|
115
|
+
public void onDownloadFailed(@NonNull GenAiException e) {
|
|
116
|
+
Log.e(TAG, "Nano download failed: " + e.getMessage());
|
|
117
|
+
}
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
@Override
|
|
123
|
+
public void onFailure(@NonNull Throwable t) {
|
|
124
|
+
// Failed to check status
|
|
125
|
+
}
|
|
126
|
+
}, ContextCompat.getMainExecutor(context));
|
|
127
|
+
|
|
128
|
+
## Provide text-only input
|
|
129
|
+
|
|
130
|
+
### Kotlin
|
|
131
|
+
|
|
132
|
+
val response = generativeModel.generateContent("Write a 3 sentence story about a magical dog.")
|
|
133
|
+
|
|
134
|
+
### Java
|
|
135
|
+
|
|
136
|
+
GenerateContentResponse response = generativeModelFutures.generateContent(
|
|
137
|
+
new GenerateContentRequest.Builder(
|
|
138
|
+
new TextPart("Write a 3 sentence story about a magical dog."))
|
|
139
|
+
.build())
|
|
140
|
+
.get();
|
|
141
|
+
|
|
142
|
+
Alternatively, add optional parameters:
|
|
143
|
+
|
|
144
|
+
### Kotlin
|
|
145
|
+
|
|
146
|
+
val response = generativeModel.generateContent(
|
|
147
|
+
generateContentRequest(
|
|
148
|
+
TextPart("Write a 3 sentence story about a magical dog."),
|
|
149
|
+
) {
|
|
150
|
+
// Optional parameters
|
|
151
|
+
temperature = 0.2f
|
|
152
|
+
topK = 10
|
|
153
|
+
candidateCount = 3
|
|
154
|
+
},
|
|
155
|
+
)
|
|
156
|
+
|
|
157
|
+
### Java
|
|
158
|
+
|
|
159
|
+
GenerateContentRequest.Builder requestBuilder =
|
|
160
|
+
new GenerateContentRequest.Builder(
|
|
161
|
+
new TextPart("Write a 3 sentence story about a magical dog."));
|
|
162
|
+
requestBuilder.setTemperature(.2f);
|
|
163
|
+
requestBuilder.setTopK(10);
|
|
164
|
+
requestBuilder.setCandidateCount(3);
|
|
165
|
+
|
|
166
|
+
GenerateContentResponse response =
|
|
167
|
+
generativeModelFutures.generateContent(requestBuilder.build()).get();
|
|
168
|
+
|
|
169
|
+
For more information about the optional parameters, see [Optional
|
|
170
|
+
configurations](https://developer.android.com/agents/skills/device-ai/ml-kit-genai-prompt-api/references/get-started#optional-configurations).
|
|
171
|
+
|
|
172
|
+
## Provide multimodal (image and text) input
|
|
173
|
+
|
|
174
|
+
Bundle an image and a text input together in the `generateContentRequest()`
|
|
175
|
+
function, with the text prompt being a question or command related to the
|
|
176
|
+
image. You can bundle multiple images and text together in the same request.
|
|
177
|
+
|
|
178
|
+
### Kotlin
|
|
179
|
+
|
|
180
|
+
val response = generativeModel.generateContent(
|
|
181
|
+
generateContentRequest(ImagePart(bitmap), TextPart(textPrompt)) {
|
|
182
|
+
// optional parameters
|
|
183
|
+
...
|
|
184
|
+
},
|
|
185
|
+
)
|
|
186
|
+
|
|
187
|
+
### Java
|
|
188
|
+
|
|
189
|
+
GenerateContentResponse response = generativeModelFutures.generateContent(
|
|
190
|
+
new GenerateContentRequest.Builder(
|
|
191
|
+
new ImagePart(bitmap),
|
|
192
|
+
new TextPart("textPrompt"))
|
|
193
|
+
// optional parameters
|
|
194
|
+
.build())
|
|
195
|
+
.get();
|
|
196
|
+
|
|
197
|
+
## Process inference result
|
|
198
|
+
|
|
199
|
+
- Run the inference and retrieve the result. You can choose to either wait for
|
|
200
|
+
the full result or stream the response as it's generated for both text-only
|
|
201
|
+
and multimodal prompts.
|
|
202
|
+
|
|
203
|
+
- This uses non-streaming inference, which retrieves the entire result from
|
|
204
|
+
the AI model before returning the result:
|
|
205
|
+
|
|
206
|
+
### Kotlin
|
|
207
|
+
|
|
208
|
+
// Call the AI model to generate content and store the complete
|
|
209
|
+
// in a new variable named 'response' once it's finished
|
|
210
|
+
val response = generativeModel.generateContent("Write a 3 sentence story about a magical dog")
|
|
211
|
+
|
|
212
|
+
### Java
|
|
213
|
+
|
|
214
|
+
GenerateContentResponse response = generativeModelFutures.generateContent(
|
|
215
|
+
new GenerateContentRequest.Builder(
|
|
216
|
+
new TextPart("Write a 3 sentence story about a magical dog."))
|
|
217
|
+
.build())
|
|
218
|
+
.get();
|
|
219
|
+
|
|
220
|
+
- The following snippets are examples of using streaming inference, which
|
|
221
|
+
retrieves the result in chunks as it's being generated:
|
|
222
|
+
|
|
223
|
+
### Kotlin
|
|
224
|
+
|
|
225
|
+
// Streaming inference
|
|
226
|
+
var fullResponse = ""
|
|
227
|
+
generativeModel.generateContentStream("Write a 3 sentence story about a magical dog").collect { chunk ->
|
|
228
|
+
val newChunkReceived = chunk.candidates[0].text
|
|
229
|
+
print(newChunkReceived)
|
|
230
|
+
fullResponse += newChunkReceived
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
### Java
|
|
234
|
+
|
|
235
|
+
// Streaming inference
|
|
236
|
+
StringBuilder fullResponse = new StringBuilder();
|
|
237
|
+
generativeModelFutures.generateContent(new GenerateContentRequest.Builder(
|
|
238
|
+
(new TextPart("Write a 3 sentence story about a magical dog"))).build(),
|
|
239
|
+
chunk -> {
|
|
240
|
+
Log.d(TAG, chunk);
|
|
241
|
+
fullResponse.append(chunk);
|
|
242
|
+
});
|
|
243
|
+
|
|
244
|
+
For more information about streaming and non-streaming inference, see [Streaming
|
|
245
|
+
versus non-streaming](https://developer.android.com/ml-kit/genai#streaming-vs-non).
|
|
246
|
+
|
|
247
|
+
## Latency optimization
|
|
248
|
+
|
|
249
|
+
To optimize for the first inference call, your application may optionally call
|
|
250
|
+
`warmup()`. This loads Gemini Nano into memory and initializes runtime
|
|
251
|
+
components.
|
|
252
|
+
|
|
253
|
+
## Optional configurations
|
|
254
|
+
|
|
255
|
+
As part of each `GenerateContentRequest`, you can set the following optional
|
|
256
|
+
parameters:
|
|
257
|
+
|
|
258
|
+
- `temperature` : Controls the degree of randomness in token selection.
|
|
259
|
+
- `seed` : Enables generating stable and deterministic results.
|
|
260
|
+
- `topK` : Controls randomness and diversity in results.
|
|
261
|
+
- `candidateCount` : Requests the number of unique responses returned. Note that the exact number of responses may not be the same as `candidateCount` because duplicate responses are automatically removed.
|
|
262
|
+
- `maxOutputTokens` : Defines the maximum number of tokens that can be generated in the response.
|
|
263
|
+
|
|
264
|
+
For more guidance on setting optional configurations, see
|
|
265
|
+
[`GenerateContentRequest`](https://developer.android.com/android/reference/kotlin/com/google/mlkit/genai/prompt/GenerateContentRequest).
|
|
266
|
+
|
|
267
|
+
## Supported features and limitations
|
|
268
|
+
|
|
269
|
+
- Input must be under 4000 tokens (or approximately 3000 English words). For more information, see the [`countTokens`](https://developer.android.com/android/reference/com/google/mlkit/genai/prompt/GenerativeModel#countTokens(com.google.mlkit.genai.prompt.GenerateContentRequest)) reference.
|
|
270
|
+
- Use cases that require long output (more than 4K tokens) should be avoided.
|
|
271
|
+
- AICore enforces an inference quota per app. For more information, see [Quota
|
|
272
|
+
per application](https://developer.android.com/ml-kit/genai#quota-per).
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
> [!NOTE]
|
|
2
|
+
> **Note:** Prefix caching is experimental and may change in the future. This feature is only available on a subset of the supported devices for Prompt API, with support for more devices coming soon. We encourage you to experiment with this API on a Pixel device to understand how it can improve inference latency speeds for your specific use case.
|
|
3
|
+
|
|
4
|
+
*Prefix caching* is a feature that reduces inference time by storing and reusing
|
|
5
|
+
the intermediate LLM state of processing a shared and recurring prompt prefix
|
|
6
|
+
part. To enable prefix caching, you only have to separate the static prefix from
|
|
7
|
+
the dynamic suffix in your API request.
|
|
8
|
+
|
|
9
|
+
Prefix caching currently only supports text-only input, so you shouldn't use
|
|
10
|
+
this feature if you're providing an image in your prompt.
|
|
11
|
+
|
|
12
|
+
There are two approaches to implement prefix caching: implicit or explicit:
|
|
13
|
+
|
|
14
|
+
- [Implicit (automatic) prefix caching](https://developer.android.com/agents/skills/device-ai/ml-kit-genai-prompt-api/references/prefix-caching#implicit) is a lightweight approach where the application only needs to define a shared portion of the prompt.
|
|
15
|
+
- [Explicit (manual) prefix caching](https://developer.android.com/agents/skills/device-ai/ml-kit-genai-prompt-api/references/prefix-caching#explicit) allows applications to have more control over caches, including cache creation, querying, and deletion.
|
|
16
|
+
|
|
17
|
+
## Use prefix caching implicitly
|
|
18
|
+
|
|
19
|
+
To enable prefix caching, add the shared portion of the prompt to the
|
|
20
|
+
`promptPrefix` field, as shown in the following code snippets:
|
|
21
|
+
|
|
22
|
+
### Kotlin
|
|
23
|
+
|
|
24
|
+
val promptPrefix = "Reverse the given sentence: "
|
|
25
|
+
val dynamicSuffix = "Hello World"
|
|
26
|
+
|
|
27
|
+
val result = generativeModel.generateContent(
|
|
28
|
+
generateContentRequest(TextPart(dynamicSuffix)) {
|
|
29
|
+
promptPrefix = PromptPrefix(promptPrefix)
|
|
30
|
+
}
|
|
31
|
+
)
|
|
32
|
+
|
|
33
|
+
### Java
|
|
34
|
+
|
|
35
|
+
String promptPrefix = "Reverse the given sentence: ";
|
|
36
|
+
String dynamicSuffix = "Hello World";
|
|
37
|
+
|
|
38
|
+
GenerateContentResponse response = generativeModelFutures.generateContent(
|
|
39
|
+
new GenerateContentRequest.Builder(new TextPart(dynamicSuffix))
|
|
40
|
+
.setPromptPrefix(new PromptPrefix(promptPrefix))
|
|
41
|
+
.build())
|
|
42
|
+
.get();
|
|
43
|
+
|
|
44
|
+
In the preceding snippet, the `dynamicSuffix` is passed as the main content, and
|
|
45
|
+
the `promptPrefix` is provided separately.
|
|
46
|
+
|
|
47
|
+
### Estimated performance gains
|
|
48
|
+
|
|
49
|
+
|---|---|---|
|
|
50
|
+
| | **Without prefix caching** | **With prefix cache-hit** (Prefix cache-miss may occur when prefix is used for the first time) |
|
|
51
|
+
| Pixel 9 with 300-token fixed prefix and a 50-token dynamic suffix prompt | 0.82 seconds | 0.45 seconds |
|
|
52
|
+
| Pixel 9 with a 1,000-token fixed prefix and a 100-token dynamic suffix prompt | 2.11 seconds | 0.5 seconds |
|
|
53
|
+
|
|
54
|
+
### Storage considerations
|
|
55
|
+
|
|
56
|
+
With implicit prefix caching, cache files are saved on the client application's
|
|
57
|
+
private storage, which increases your app's storage usage. Encrypted cache files
|
|
58
|
+
and their associated metadata, including original prefix text, are stored. Keep
|
|
59
|
+
the following storage considerations in mind:
|
|
60
|
+
|
|
61
|
+
- The number of caches is managed by an LRU (Least Recently Used) mechanism. Least used caches are deleted automatically when exceeding the max total cache amount.
|
|
62
|
+
- Prompt cache sizes are dependent on the length of the prefix.
|
|
63
|
+
- To clear all caches created from prefix caching, use the
|
|
64
|
+
[`generativeMode.clearImplicitCaches()`](https://developer.android.com/android/reference/kotlin/com/google/mlkit/genai/prompt/GenerativeModel#clearCaches%28%29) method.
|
|
65
|
+
|
|
66
|
+
> [!NOTE]
|
|
67
|
+
> **Note:** The `clearImplicitCaches()` method is experimental and may change in the future.
|
|
68
|
+
|
|
69
|
+
## Use explicit cache management
|
|
70
|
+
|
|
71
|
+
The Prompt API includes explicit cache management methods to give developers
|
|
72
|
+
more precise control over how caches are created, searched, used, and removed.
|
|
73
|
+
These manual operations run independently of the system's automated cache
|
|
74
|
+
handling.
|
|
75
|
+
|
|
76
|
+
This example illustrates how to initialize explicit cache management and
|
|
77
|
+
perform inference:
|
|
78
|
+
|
|
79
|
+
### Kotlin
|
|
80
|
+
|
|
81
|
+
val cacheName = "my_cache"
|
|
82
|
+
val promptPrefix = "Reverse the given sentence: "
|
|
83
|
+
val dynamicSuffix = "Hello World"
|
|
84
|
+
|
|
85
|
+
// Create a cache
|
|
86
|
+
val cacheRequest = createCachedContextRequest(cacheName, PromptPrefix(promptPrefix))
|
|
87
|
+
val cache = generativeModel.caches.create(cacheRequest)
|
|
88
|
+
|
|
89
|
+
// Run inference with the cache
|
|
90
|
+
val response = generativeModel.generateContent(
|
|
91
|
+
generateContentRequest(TextPart(dynamicSuffix)) {
|
|
92
|
+
cachedContextName = cache.name
|
|
93
|
+
}
|
|
94
|
+
)
|
|
95
|
+
|
|
96
|
+
### Java
|
|
97
|
+
|
|
98
|
+
String cacheName = "my_cache";
|
|
99
|
+
String promptPrefix = "Reverse the given sentence: ";
|
|
100
|
+
String dynamicSuffix = "Hello World";
|
|
101
|
+
|
|
102
|
+
// Create a cache
|
|
103
|
+
CachedContext cache = cachesFutures.create(
|
|
104
|
+
new CreateCachedContextRequest.Builder(cacheName, new PromptPrefix(promptPrefix))
|
|
105
|
+
.build())
|
|
106
|
+
.get();
|
|
107
|
+
|
|
108
|
+
// Run inference with the cache
|
|
109
|
+
GenerateContentResponse response = generativeModelFutures.generateContent(
|
|
110
|
+
new GenerateContentRequest.Builder(new TextPart(dynamicSuffix))
|
|
111
|
+
.setCachedContextName(cache.getName())
|
|
112
|
+
.build())
|
|
113
|
+
.get();
|
|
114
|
+
|
|
115
|
+
This example demonstrates how to query, retrieve, and delete explicitly managed
|
|
116
|
+
caches using `generativeModel.caches`:
|
|
117
|
+
|
|
118
|
+
### Kotlin
|
|
119
|
+
|
|
120
|
+
val cacheName = "my_cache"
|
|
121
|
+
|
|
122
|
+
// Query pre-created caches
|
|
123
|
+
for (cache in generativeModel.caches.list()) {
|
|
124
|
+
// Do something with cache
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// Get specific cache
|
|
128
|
+
val cache = generativeModel.caches.get(cacheName)
|
|
129
|
+
|
|
130
|
+
// Delete a pre-created cache
|
|
131
|
+
generativeModel.caches.delete(cacheName)
|
|
132
|
+
|
|
133
|
+
### Java
|
|
134
|
+
|
|
135
|
+
String cacheName = "my_cache";
|
|
136
|
+
|
|
137
|
+
// Query pre-created caches
|
|
138
|
+
for (PrefixCache cache : cachesFutures.list().get()) {
|
|
139
|
+
// Do something with cache
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
// Get specific cache
|
|
143
|
+
PrefixCache cache = cachesFutures.get(cacheName).get();
|
|
144
|
+
|
|
145
|
+
// Delete a pre-created cache
|
|
146
|
+
cachesFutures.delete(cacheName);
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
When using Prompt API, there are specific strategies you can use to tailor your
|
|
2
|
+
prompts and receive optimal results. This page describes best practices for
|
|
3
|
+
formatting prompts for Gemini Nano.
|
|
4
|
+
|
|
5
|
+
For more general prompt engineering guidance, see [Prompt Engineering
|
|
6
|
+
whitepaper](https://www.kaggle.com/whitepaper-prompt-engineering), [Prompt Engineering for Generative
|
|
7
|
+
AI](https://developer.android.com/machine-learning/resources/prompt-eng), and [Prompt design strategies](https://ai.google.dev/gemini-api/docs/prompting-strategies).
|
|
8
|
+
|
|
9
|
+
Alternatively, to automatically refine and improve prompts, you can use the
|
|
10
|
+
[zero-shot optimizer](https://docs.cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/zero-shot-optimizer#optimizing_for_smaller_models), which can target on-device models such as
|
|
11
|
+
`gemma-3n-e4b-it`.
|
|
12
|
+
|
|
13
|
+
## Prompt design best practices
|
|
14
|
+
|
|
15
|
+
When designing prompts for Prompt API, use the following techniques:
|
|
16
|
+
|
|
17
|
+
- **Provide examples for in-context learning**. Add well-distributed examples to
|
|
18
|
+
your prompt to show Gemini Nano the kind of result you expect.
|
|
19
|
+
|
|
20
|
+
Consider using the [prefix caching](https://developer.android.com/agents/skills/device-ai/prompt-api/references/prefix-caching) feature when you use in-context
|
|
21
|
+
learning, as providing examples makes the prompt longer and increases
|
|
22
|
+
inference time.
|
|
23
|
+
- **Be concise** . Verbose preambles with repeated instructions can produce
|
|
24
|
+
suboptimal results. Keep your prompt focused and to-the-point. If you need to
|
|
25
|
+
repeat a short directive that guides the model's behavior, consider using
|
|
26
|
+
[system instructions](https://developer.android.com/agents/skills/device-ai/prompt-api/references/system-instructions).
|
|
27
|
+
|
|
28
|
+
- **Structure prompts** to generate more effective responses, such as this
|
|
29
|
+
[sample prompt template](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/prompt-design-strategies#sample-prompt-template) that clearly defines instructions,
|
|
30
|
+
constraints, and examples.
|
|
31
|
+
|
|
32
|
+
- **Keep output short** . LLM inference speeds are heavily dependent on the
|
|
33
|
+
output length. Carefully consider how you can generate the shortest possible
|
|
34
|
+
output for your use case and do manual post-processing to structure the output
|
|
35
|
+
in the chosen format. To help ensure that the response output is in your
|
|
36
|
+
preferred format, use the [Structured Output API](https://developer.android.com/agents/skills/device-ai/prompt-api/references/structured-output).
|
|
37
|
+
|
|
38
|
+
- **Add delimiters** . Use delimiters like `<background_information>`,
|
|
39
|
+
`<instruction>`, and `##` to create separation between different parts of your
|
|
40
|
+
prompt. Using `##` between components is particularly critical for Gemini
|
|
41
|
+
Nano, as it significantly reduces the chances of the model failing to
|
|
42
|
+
correctly interpret each component.
|
|
43
|
+
|
|
44
|
+
- **Prefer simple logic and a more focused task** . If you find it challenging
|
|
45
|
+
to achieve good results with a prompt requiring multi-step reasoning (for
|
|
46
|
+
example, *do X first, if the result of X is A, do M; otherwise do N;
|
|
47
|
+
then do Y...* ), consider breaking the task up and let each Gemini Nano call
|
|
48
|
+
handle a more focused task, while using code to chain multiple calls together.
|
|
49
|
+
If you do need to tackle a complex, reasoning-intensive task all at once,
|
|
50
|
+
consider using [thinking mode](https://developer.android.com/ml-kit/genai/prompt/android/thinking-mode).
|
|
51
|
+
|
|
52
|
+
- **Use lower temperature values for deterministic tasks** . For tasks such as
|
|
53
|
+
entity extraction or translation that don't rely on creativity, consider
|
|
54
|
+
starting with a `temperature` value of `0.2`, and tune this value based on
|
|
55
|
+
your testing.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
This skill provides guidance on how to optimize prompts for use with the ML Kit
|
|
2
|
+
Prompt API.
|
|
3
|
+
|
|
4
|
+
## Guidelines \& Rules
|
|
5
|
+
|
|
6
|
+
The best practices for prompt design for Prompt API are at
|
|
7
|
+
[Prompt Design](https://developer.android.com/agents/skills/device-ai/prompt-api/references/prompt-design). Apply these core rules:
|
|
8
|
+
|
|
9
|
+
- Include examples for in-context learning with examples of the output. This is an example prompt that includes in-context learning because it has examples of the desired model output: Analyze the message and return whether the customer sentiment is positive, negative, or neutral. Example 1: Input - "This product doesn't work"; Output - "Negative" Example 2: Input - "I liked this product"; Output - "Positive"
|
|
10
|
+
- Make prompts concise. Remove duplicate or repeated instructions. Do not include conversational filler such as: hello, please, do this, help me with, etc. For example, a verbose prompt such as: "Hello! I want you to act as an expert translator for me today. I am going to give you a short paragraph of text in English, and I would really like it if you could translate it into formal, high-level Business French. Please make sure that you do not include any intro like 'Here is your translation' or any closing remarks at all. Just output the translation itself." can be improved with this concise prompt: "Translate to formal Business French. Return ONLY the translation"
|
|
11
|
+
- Use paired XML/HTML delimiters to denote dynamic inputs (for example `<email>[content]</email>`) to clearly isolate user data from prompt instructions. Mention that the delimiters represent placeholder text that should be replaced by code in the actual implementation.
|
|
12
|
+
- Use the [Structured Output API](https://developer.android.com/agents/skills/device-ai/prompt-api/references/structured-output) if the output requires parsing responses into certain formats. Don't include the Structured Output API implementation in the prompt itself, but mention it after presenting the optimized prompt to the user so the user knows how to parse the model output. Prompts that use Structured Output API must return the `@Generable` typed object from the function signature instead of a string or JSON string.
|
|
13
|
+
- Keep output short by adding output constraints such as word count, character count, or number of bullets or sentences. For example, add constraints such as "The summarization must be 10 words or fewer."
|
|
14
|
+
- Use [system instructions](https://developer.android.com/agents/skills/device-ai/prompt-api/references/system-instructions) for short instructions that define how a model should behave, and use [prefix caching](https://developer.android.com/agents/skills/device-ai/prompt-api/references/prefix-caching) for prompts that are over 200 words.
|
|
15
|
+
|
|
16
|
+
## Examples
|
|
17
|
+
|
|
18
|
+
Here are examples of prompts that the user might ask you to optimize, and the
|
|
19
|
+
improved, optimized versions.
|
|
20
|
+
|
|
21
|
+
### Example 1
|
|
22
|
+
|
|
23
|
+
Unoptimized prompt:
|
|
24
|
+
|
|
25
|
+
Process this customer email and return the order ID, what was bought, the phone
|
|
26
|
+
number, and what they want. Format it as JSON so my app can read it.
|
|
27
|
+
|
|
28
|
+
Optimized prompt:
|
|
29
|
+
|
|
30
|
+
## Task
|
|
31
|
+
|
|
32
|
+
Extract key details from the customer email below.
|
|
33
|
+
|
|
34
|
+
## Customer Email
|
|
35
|
+
|
|
36
|
+
<email>
|
|
37
|
+
[email_content]
|
|
38
|
+
</email>
|
|
39
|
+
|
|
40
|
+
Explanation: Because the information that the user wants to extract using the
|
|
41
|
+
prompt is well suited for the Structured Output API, the optimized prompt
|
|
42
|
+
implicitly uses the Structured Output API and doesn't need to explicitly define
|
|
43
|
+
the schema for the extracted data. In your response to the user that explains
|
|
44
|
+
the optimizations made to the prompt, mention that the optimized prompt is
|
|
45
|
+
designed for use with the Structured Output API. Also, mention that the
|
|
46
|
+
"" delimiters signify placeholder text that should be replaced with code in the user's actual implementation.
|
|
47
|
+
|
|
48
|
+
### Example 2
|
|
49
|
+
|
|
50
|
+
Unoptimized prompt:
|
|
51
|
+
|
|
52
|
+
Given this itinerary for a trip: [Flight to Paris (CDG), Check-in: Hotel Le
|
|
53
|
+
Meurice, Visit to the Louvre, Dinner at Le Jules Verne, Eiffel Tower Visit,
|
|
54
|
+
Versailles Palace Tour, Montmartre Walk, Seine River Cruise, Pastry and Macaron
|
|
55
|
+
Tasting, Flight Out], generate the following: overall vibe, tips on how to
|
|
56
|
+
prepare for this trip, and common short phrases to learn for the trip.
|
|
57
|
+
|
|
58
|
+
Optimized prompt:
|
|
59
|
+
|
|
60
|
+
## Task
|
|
61
|
+
|
|
62
|
+
Analyze the trip itinerary below and extract details to build a concise travel
|
|
63
|
+
guide.
|
|
64
|
+
|
|
65
|
+
## Rules
|
|
66
|
+
- Overall vibe: Limit to 1 short sentence (under 15 words).
|
|
67
|
+
- Preparation tips: Provide exactly 3 short tips (maximum 10 words per tip).
|
|
68
|
+
- Useful phrases: Provide exactly 3 phrases (under 15 words each).
|
|
69
|
+
|
|
70
|
+
## Itinerary
|
|
71
|
+
|
|
72
|
+
<itinerary>
|
|
73
|
+
[itinerary_content]
|
|
74
|
+
</itinerary>
|