API

method getAvailability()

getAvailability() => Promise<GetAvailabilityResult>

Liefert die detaillierte Verfügbarkeit des Textmodells. Die Web-Implementierung prüft die Unterstützung der Chrome Prompt API; nicht unterstützte Browser geben unavailable zurück.

Rückgabe: Promise<GetAvailabilityResult>

Seit: 2.0.0

method getImageAnalysisAvailability()

getImageAnalysisAvailability() => Promise<GetImageAnalysisAvailabilityResult>

Liefert die Verfügbarkeit der Bildanalyse und das native Backend, das Bildeingaben verarbeiten würde.
Mit Xcode 27 / Swift 6.4 kompilierte iOS-27-Builds geben den Textmodell-status sowie
backend: 'foundation-models' und maxImages: 4 zurück. Mit älteren Xcode-Versionen erstellte Builds melden
unavailable und können keine iOS-27-Bildunterstützung enthalten. Android meldet Gemini-Nano-Prompt-
APIs oder ein konfiguriertes LiteRT-LM-Fallback. Die Web-Implementierung meldet für Bildanalyse derzeit unavailable.

Rückgabe: Promise<GetImageAnalysisAvailabilityResult>

Seit: 2.1.0

method downloadModel()

downloadModel() => Promise<void>

Startet einen Modelldownload unter Android oder Chrome im Web. Im Web durch eine Nutzeraktion aufrufen; Chrome verwaltet das Modell.

Seit: 2.0.0

method configureFallbackModel(...)

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

Initialisiert ein ausdrücklich konfiguriertes Android-LiteRT-LM-Fallback-Modell. Gemini Nano bleibt bevorzugt, sofern verfügbar.
Die Modellkonfiguration führt lokale Dateioperationen aus und kann längere Zeit dauern. iOS und Web lehnen diese API ab.

Seit: 2.0.0

method warmup(...)

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

Wärmt Modellressourcen vor. Die Web-Implementierung erstellt und beendet eine temporäre Textsitzung; promptPrefix gilt nur für iOS.

Seit: 1.0.0

method createChat(...)

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

Erstellt einen Chat, der bis zu seiner Löschung vom Plugin verwaltet wird.

Rückgabe: Promise<CreateChatResult>

Seit: 2.0.0

method deleteChat(...)

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

Löscht einen Chat und bricht dessen Generierung ab.

Seit: 2.0.0

method generateText(...)

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

Generiert den vollständigen Text.

Rückgabe: Promise<GenerateTextResult>

Seit: 2.0.0

method streamText(...)

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

Streamt native Textstücke und gibt den vollständigen Text zurück.

Rückgabe: Promise<GenerateTextResult>

Seit: 2.0.0

method cancelGeneration(...)

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

Bricht eine laufende Generierung ab.

Seit: 2.0.0

method addListener('availabilityChange', ...)

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

Registriert einen Listener für Verfügbarkeitsänderungen. Die Web-Implementierung meldet Änderungen, die bei Verfügbarkeitsprüfungen sowie beim Erstellen oder Herunterladen einer Sitzung erkannt werden.

Rückgabe: Promise<PluginListenerHandle>

Seit: 2.0.0

method addListener('systemAvailabilityChange', ...)

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

Rückgabe: Promise<PluginListenerHandle>

Seit: 1.0.0

method addListener('downloadProgress', ...)

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

Registriert einen Listener für den Downloadfortschritt unter Android oder Chrome im Web.

Rückgabe: Promise<PluginListenerHandle>

Seit: 2.0.0

method addListener('textChunk', ...)

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

Registriert einen Listener für native Textstücke.

Rückgabe: Promise<PluginListenerHandle>

Seit: 2.0.0

method addListener('generationStateChange', ...)

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

Registriert einen Listener für Start, Abschluss, Abbruch und Fehlschlag einer Generierung.

Rückgabe: Promise<PluginListenerHandle>

Seit: 2.1.0

method removeAllListeners()

removeAllListeners() => Promise<void>

Entfernt alle Plugin-Listener.

Seit: 1.0.0

method generateImage(...)

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

Generiert PNG-Bilder unter iOS.

Rückgabe: Promise<GenerateImageResponse>

Seit: 1.0.0

method systemAvailability()

systemAvailability() => Promise<SystemAvailabilityResponse>

Rückgabe: Promise<SystemAvailabilityResponse>

Seit: 1.0.0

method download()

download() => Promise<void>

Seit: 1.0.0

method prompt(...)

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

Rückgabe: Promise<PromptResponse>

Seit: 1.0.0

method endSession(...)

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

Beendet eine ältere Sitzung. Bereits beendete oder unbekannte Sitzungskennungen werden erfolgreich und ohne Wirkung verarbeitet.

Seit: 1.0.0

interface GetAvailabilityResult

Von Verfügbarkeitsprüfungen zurückgegebenes Ergebnis.

interface GetImageAnalysisAvailabilityResult

Von Verfügbarkeitsprüfungen für Bildanalyse zurückgegebenes Ergebnis.

interface ConfigureFallbackModelOptions

Konfiguriert ein ausdrücklich aktiviertes Android-LiteRT-LM-Fallback, das verwendet wird, wenn Gemini Nano nicht verfügbar ist.
Das Modell muss bereits als App-Asset oder als lesbare, von der App verwaltete Datei vorliegen. iOS und Web lehnen diese API ab.

interface WarmupOptions

Optionen für das Vorwärmen. Android wärmt das Modell global vor; iOS kann einen Chat vorwärmen.
Die Web-Implementierung erstellt und beendet eine temporäre Sitzung, optional mit dem Kontext eines Chats.

interface CreateChatResult

Ergebnis mit der Kennung des vom Plugin verwalteten Chats.

interface CreateChatOptions

Optionen zum Erstellen eines vom Plugin verwalteten Chats.

interface ChatHistoryOptions

Grenzen des Chatverlaufs. Alle Implementierungen behalten die Anweisungen bei und verwerfen jeweils die ältesten vollständigen Gesprächsrunden.

interface DeleteChatOptions

Optionen zum Löschen eines Chats.

interface GenerateTextResult

Ergebnis einer Textgenerierung.

interface GenerateTextOptions

Optionen für eine Generierung ohne Streaming.

interface ImageUriInput

Lokale URI als Bildeingabe.

interface Base64ImageInput

Base64-kodiertes Bild als Eingabe.

interface GenerationOptions

Plattformübergreifende Steuerung der Textgenerierung. Nicht unterstützte Werte werden abgelehnt und nicht auf Grenzwerte begrenzt. In der Chrome-Web-Implementierung müssen diese Einstellungen weggelassen werden.

interface CancelGenerationOptions

Optionen zum Abbrechen einer laufenden Generierung.

interface PluginListenerHandle

interface SystemAvailabilityResponse

interface DownloadProgressEvent

Fortschritt des Modelldownloads. Android-Zwischenereignisse enthalten kein progress, da ML Kit keine Gesamtzahl der Bytes liefert.

interface TextChunkEvent

Von streamText() ausgegebene inkrementelle Textstücke.

interface GenerationStateChangeEvent

Lebenszyklusereignis für generateText() und streamText().

interface GenerateImageResponse

Ergebnis der Bildgenerierung.

interface GenerateImageOptions

Optionen für die Bildgenerierung. Bildgenerierung ist nur ab iOS 18.4 verfügbar.

interface PromptResponse

Ältere Prompt-Antwort.

interface PromptOptions

Ältere Prompt-Optionen.

interface LLMOptions

interface EndSessionOptions

Optionen zum Löschen einer älteren Sitzung.

type alias Availability

Die semantische Verfügbarkeit des Textmodells auf dem Gerät.

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

type alias ImageAnalysisBackend

Für die Bildanalyse auf dem Gerät ausgewähltes natives Backend.

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

type alias ImageInput

Bildreferenz für Textgenerierung mit Bildverarbeitung.

ImageUriInput | Base64ImageInput

type alias StreamTextOptions

Optionen für native Streaming-Generierung.

GenerateTextOptions

type alias StreamTextResult

Abschließendes Ergebnis einer nativen Streaming-Generierung.

GenerateTextResult

type alias AvailabilityChangeListener

Listener für Verfügbarkeitsänderungen.

(event: GetAvailabilityResult): void

type alias SystemAvailabilityChangeListener

(event: SystemAvailabilityResponse): void

type alias LLMAvailability

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

type alias DownloadProgressListener

Listener für den Fortschritt des Modelldownloads.

(event: DownloadProgressEvent): void

type alias TextChunkListener

Listener für native Generierungsabschnitte.

(event: TextChunkEvent): void

type alias GenerationStateChangeListener

Listener für Änderungen des nativen Generierungslebenszyklus.

(event: GenerationStateChangeEvent): void

type alias GenerationState

Zustand des nativen Generierungslebenszyklus.

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

type alias LocalLLMErrorCode

Stabile Local-LLM-Fehlercodes.

'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'