API

method getAvailability()

getAvailability() => Promise<GetAvailabilityResult>

Renvoie la disponibilité détaillée du modèle de texte. Le Web détecte la prise en charge de la Prompt API de Chrome ; les navigateurs incompatibles renvoient unavailable.

Renvoie : Promise<GetAvailabilityResult>

Depuis : 2.0.0

method getImageAnalysisAvailability()

getImageAnalysisAvailability() => Promise<GetImageAnalysisAvailabilityResult>

Renvoie la disponibilité de l’analyse d’images et le backend natif qui traiterait les images d’entrée.
Sur les builds iOS 27 compilés avec Xcode 27 / Swift 6.4, renvoie le status du modèle de texte, ainsi que backend: 'foundation-models' et maxImages: 4. Les builds réalisés avec un ancien Xcode signalent unavailable et ne peuvent pas inclure la prise en charge de la vision iOS 27. Android signale les API de prompt Gemini Nano ou un repli LiteRT-LM configuré. Le Web signale actuellement unavailable pour l’analyse d’images.

Renvoie : Promise<GetImageAnalysisAvailabilityResult>

Depuis : 2.1.0

method downloadModel()

downloadModel() => Promise<void>

Lance le téléchargement du modèle sur Android ou Chrome Web. Sur le Web, appelez cette méthode depuis un geste utilisateur ; Chrome gère le modèle.

Depuis : 2.0.0

method configureFallbackModel(...)

configureFallbackModel(options: ConfigureFallbackModelOptions) => Promise<void>

Initialise un modèle de repli LiteRT-LM explicite sur Android. Gemini Nano reste prioritaire lorsqu’il est disponible.
La configuration d’un modèle effectue des entrées/sorties sur des fichiers locaux et peut prendre un temps important. iOS et le Web rejettent cette API.

Depuis : 2.0.0

method warmup(...)

warmup(options?: WarmupOptions | undefined) => Promise<void>

Préchauffe les ressources du modèle. Le Web crée puis détruit une session textuelle temporaire ; promptPrefix est réservé à iOS.

Depuis : 1.0.0

method createChat(...)

createChat(options?: CreateChatOptions | undefined) => Promise<CreateChatResult>

Crée un chat géré par le plugin jusqu’à sa suppression.

Renvoie : Promise<CreateChatResult>

Depuis : 2.0.0

method deleteChat(...)

deleteChat(options: DeleteChatOptions) => Promise<void>

Supprime un chat et annule sa génération.

Depuis : 2.0.0

method generateText(...)

generateText(options: GenerateTextOptions) => Promise<GenerateTextResult>

Génère un texte complet.

Renvoie : Promise<GenerateTextResult>

Depuis : 2.0.0

method streamText(...)

streamText(options: StreamTextOptions) => Promise<StreamTextResult>

Diffuse les fragments natifs en continu et renvoie le texte complet.

Renvoie : Promise<GenerateTextResult>

Depuis : 2.0.0

method cancelGeneration(...)

cancelGeneration(options: CancelGenerationOptions) => Promise<void>

Annule une génération en cours.

Depuis : 2.0.0

method addListener('availabilityChange', ...)

addListener(eventName: 'availabilityChange', listenerFunc: AvailabilityChangeListener) => Promise<PluginListenerHandle>

Écoute les changements de disponibilité. Le Web émet les changements observés pendant les vérifications de disponibilité ainsi que la création et le téléchargement de sessions.

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.0.0

method addListener('systemAvailabilityChange', ...)

addListener(eventName: 'systemAvailabilityChange', listenerFunc: SystemAvailabilityChangeListener) => Promise<PluginListenerHandle>

Renvoie : Promise<PluginListenerHandle>

Depuis : 1.0.0

method addListener('downloadProgress', ...)

addListener(eventName: 'downloadProgress', listenerFunc: DownloadProgressListener) => Promise<PluginListenerHandle>

Écoute la progression du téléchargement sur Android ou Chrome Web.

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.0.0

method addListener('textChunk', ...)

addListener(eventName: 'textChunk', listenerFunc: TextChunkListener) => Promise<PluginListenerHandle>

Écoute les fragments de texte natifs.

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.0.0

method addListener('generationStateChange', ...)

addListener(eventName: 'generationStateChange', listenerFunc: GenerationStateChangeListener) => Promise<PluginListenerHandle>

Écoute le démarrage, la fin, l’annulation et l’échec de la génération.

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.1.0

method removeAllListeners()

removeAllListeners() => Promise<void>

Supprime tous les écouteurs du plugin.

Depuis : 1.0.0

method generateImage(...)

generateImage(options: GenerateImageOptions) => Promise<GenerateImageResponse>

Génère des images PNG sur iOS.

Renvoie : Promise<GenerateImageResponse>

Depuis : 1.0.0

method systemAvailability()

systemAvailability() => Promise<SystemAvailabilityResponse>

Renvoie : Promise<SystemAvailabilityResponse>

Depuis : 1.0.0

method download()

download() => Promise<void>

Depuis : 1.0.0

method prompt(...)

prompt(options: PromptOptions) => Promise<PromptResponse>

Renvoie : Promise<PromptResponse>

Depuis : 1.0.0

method endSession(...)

endSession(options: EndSessionOptions) => Promise<void>

Termine une session de l’ancienne API. Les identifiants de sessions déjà terminées ou inconnues aboutissent sans effet.

Depuis : 1.0.0

interface GetAvailabilityResult

Résultat renvoyé par les vérifications de disponibilité.

interface GetImageAnalysisAvailabilityResult

Résultat renvoyé par les vérifications de disponibilité de l’analyse d’images.

interface ConfigureFallbackModelOptions

Configure un repli facultatif vers LiteRT-LM sur Android lorsque Gemini Nano n’est pas disponible.
Le modèle doit déjà exister comme ressource de l’application ou comme fichier lisible géré par celle-ci. iOS et le Web rejettent cette API.

interface WarmupOptions

Options de préchauffage. Android effectue un préchauffage global du modèle ; iOS peut préchauffer un chat.
Le Web crée puis libère une session temporaire, éventuellement avec le contexte d’un chat.

interface CreateChatResult

Résultat contenant l’identifiant du chat géré par le plugin.

interface CreateChatOptions

Options de création d’un chat géré par le plugin.

interface ChatHistoryOptions

Limites de l’historique du chat. Toutes les implémentations conservent les instructions et suppriment les échanges complets les plus anciens.

interface DeleteChatOptions

Options de suppression d’un chat.

interface GenerateTextResult

Résultat d’une génération de texte.

interface GenerateTextOptions

Options d’une génération sans diffusion en continu.

interface ImageUriInput

Image d’entrée sous forme d’URI locale.

interface Base64ImageInput

Image d’entrée encodée en base64.

interface GenerationOptions

Paramètres multiplateformes de génération de texte. Les valeurs non prises en charge sont rejetées, et non ramenées dans les limites autorisées. Sur Chrome Web, ces paramètres doivent être omis.

interface CancelGenerationOptions

Options d’annulation d’une génération en cours.

interface PluginListenerHandle

interface SystemAvailabilityResponse

interface DownloadProgressEvent

Progression du téléchargement du modèle. Les événements intermédiaires Android omettent progress, car ML Kit ne fournit pas le nombre total d’octets.

interface TextChunkEvent

Texte incrémental émis par streamText().

interface GenerationStateChangeEvent

Événement de cycle de vie émis pour generateText() et streamText().

interface GenerateImageResponse

Résultat de la génération d’images.

interface GenerateImageOptions

Options de génération d’images. La génération d’images est disponible uniquement à partir d’iOS 18.4.

interface PromptResponse

Réponse au prompt de l’ancienne API.

interface PromptOptions

Options de prompt de l’ancienne API.

interface LLMOptions

interface EndSessionOptions

Options de suppression d’une session de l’ancienne API.

type alias Availability

Disponibilité sémantique du modèle textuel sur l’appareil.

'available' | 'device-not-eligible' | 'not-enabled' | 'downloadable' | 'downloading' | 'not-ready' | 'unavailable'

type alias ImageAnalysisBackend

Backend natif sélectionné pour l’analyse d’images sur l’appareil.

'foundation-models' | 'ml-kit-prompt' | 'litert-lm'

type alias ImageInput

Référence d’image pour la génération de texte avec capacités de vision.

ImageUriInput | Base64ImageInput

type alias StreamTextOptions

Options de génération native en streaming.

GenerateTextOptions

type alias StreamTextResult

Résultat final d’une génération native en streaming.

GenerateTextResult

type alias AvailabilityChangeListener

Écouteur des changements de disponibilité.

(event: GetAvailabilityResult): void

type alias SystemAvailabilityChangeListener

(event: SystemAvailabilityResponse): void

type alias LLMAvailability

'available' | 'unavailable' | 'notready' | 'downloadable'

type alias DownloadProgressListener

Écouteur de la progression du téléchargement du modèle.

(event: DownloadProgressEvent): void

type alias TextChunkListener

Écouteur des fragments de génération native.

(event: TextChunkEvent): void

type alias GenerationStateChangeListener

Écouteur des changements de cycle de vie de la génération native.

(event: GenerationStateChangeEvent): void

type alias GenerationState

État du cycle de vie de la génération native.

'started' | 'completed' | 'cancelled' | 'failed'

type alias LocalLLMErrorCode

Codes d’erreur stables de Local LLM.

'LOCAL_LLM_NOT_AVAILABLE' | 'LOCAL_LLM_DEVICE_NOT_ELIGIBLE' | 'LOCAL_LLM_NOT_ENABLED' | 'LOCAL_LLM_MODEL_NOT_READY' | 'LOCAL_LLM_MODEL_DOWNLOAD_REQUIRED' | 'LOCAL_LLM_CONTEXT_WINDOW_EXCEEDED' | 'LOCAL_LLM_CHAT_NOT_FOUND' | 'LOCAL_LLM_CHAT_BUSY' | 'LOCAL_LLM_GENERATION_NOT_FOUND' | 'LOCAL_LLM_GENERATION_CANCELLED' | 'LOCAL_LLM_INVALID_OPTIONS' | 'LOCAL_LLM_UNSUPPORTED' | 'LOCAL_LLM_IMAGE_NOT_READABLE' | 'LOCAL_LLM_IMAGE_TOO_LARGE' | 'LOCAL_LLM_GENERATION_FAILED' | 'LOCAL_LLM_IMAGE_GENERATION_FAILED' | 'LOCAL_LLM_UNKNOWN_ERROR'