Prompt API

Eingeschränkt verfügbar

Diese Funktion ist nicht Baseline, da sie in einigen der am weitesten verbreiteten Browser nicht funktioniert.

Mehr erfahren
Vollständige Kompatibilität anzeigen

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Warnung: Dieses Feature wird derzeit von zwei Browser-Anbietern abgelehnt. Siehe den Abschnitt Standards Positionen unten für Details zur Ablehnung.

Die Prompt API erlaubt es Webseiten, ein Sprachmodell direkt vom User-Agent über eine JavaScript-Schnittstelle abzurufen, ohne die implementierungsspezifischen Details des verwendeten KI-Modells verwalten zu müssen.

Konzepte und Verwendung

Das Verwenden von KI-Prompts, um Informationen zurückzugeben, ist im Web sehr verbreitet. Beispiele sind das schnelle Abrufen von Informationen, die Erzeugung von Code und Inhalten, Chatbots zur Bereitstellung von Kundenservice-Funktionen, Bildidentifikation und -beschreibung, Audiotranskription und mehr.

Die Prompt API bietet einen asynchronen (Promise-basierten) Mechanismus, um ein internes KI-Modell des Browsers anzusprechen. Ein Modell auf dem Gerät zu haben, ist nützlich und effizient, da sensible Daten auf dem Gerät des Nutzers verbleiben können, das Modell offline verfügbar ist, und Entwickler die Kosten und Latenzzeiten von API-Aufrufen zu externen Diensten vermeiden können. Die API abstrahiert modellspezifische Details wie Tokenisierung und Templating, sodass Entwickler diese Unterschiede bei verschiedenen Implementierungen nicht handhaben müssen.

Die gesamte Interaktion mit dem Sprachmodell erfolgt über eine LanguageModel-Sitzung. Sie können diese Sitzung nutzen, um den Kontext für das Modell festzulegen, z. B. Dokumente, Hintergrundinformationen oder Gesprächsverläufe bereitzustellen, und es aufzufordern, Antworten auf bestimmte Fragen zu geben.

Vor dem Erstellen einer Sitzung können Sie die statische Methode LanguageModel.availability() aufrufen, um festzustellen, ob das Sprachmodell eine gegebene Konfiguration auf dem aktuellen Gerät unterstützt. Dadurch können sich Seiten anpassen, wenn Daten für die gewünschte Konfiguration nicht bereitgestellt oder heruntergeladen werden können. Beispielsweise könnten Sie ein Download-Prompt anzeigen oder auf einen Cloud-basierten KI-Dienst zurückfallen, anstatt eine Sitzung zu erstellen, die nur fehlschlägt.

Eine Sitzung wird durch Aufruf der statischen Methode create() erstellt. Sobald Sie eine Sitzung haben, können Sie append() aufrufen, um Inhalte zu laden, ohne eine Antwort zu generieren, und prompt() oder promptStreaming(), um Text oder multimodale Eingaben zu senden und die Antwort zu empfangen.

Sie können ausstehende Operationen wie create(), prompt() und append() mit einem AbortController abbrechen.

Nachdem eine LanguageModel-Instanz erstellt wurde, können Sie deren zugewiesene Ressourcen freigeben und jede weitere Aktivität beenden, indem Sie deren Methode LanguageModel.destroy() aufrufen. Es wird empfohlen, dies zu tun, nachdem Sie mit dem Objekt fertig sind, da es viele Ressourcen verbrauchen kann.

Um loszulegen, sehen Sie sich Using the Prompt API an, um eine Einführung in die Grundlagen zu erhalten.

Schnittstellen

CreateMonitor: Bietet Informationen über den Fortschritt eines KI-Modell-Downloads, z.B. ein Sprachpaket oder einige Feineinstellungen.
LanguageModel: Repräsentiert eine Sitzung mit einem Sprachmodell des Browsers. Bietet statische Methoden zum Erstellen von Sitzungen und Prüfen der Verfügbarkeit sowie Instanzmethoden zur Abfrage des Modells, zur Kontextverwaltung, zum Klonen von Sitzungen usw.

HTTP-Header

Permissions-Policy; die language-model Direktive: Steuert den Zugriff auf die Abruffunktionalität. Wo eine Richtlinie ihre Nutzung ausdrücklich untersagt, gibt die statische Methode LanguageModel.availability() unavailable zurück, und alle Versuche, andere LanguageModel-Methoden aufzurufen, schlagen mit einem NotAllowedError-DOMException fehl.