Summarizer: `create()` statische Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

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

Die create() statische Methode des Summarizer-Interfaces erstellt eine neue Summarizer-Instanz, um Zusammenfassungen zu generieren.

Hinweis: Die create()-Methode erfordert transiente Aktivierung, das heißt, sie muss als Reaktion auf eine Benutzeraktion wie einen Mausklick oder Tastendruck aufgerufen werden.

Syntax

js
Summarizer.create()
Summarizer.create(options)

Parameter

options Optional

Ein Objekt, das Konfigurationsoptionen für den Summarizer angibt. Mögliche Werte sind:

expectedInputLanguages

Ein Array von Zeichenfolgen, das die erwarteten Sprachen des Eingangstextes angibt. Diese sollten gültige BCP 47 Sprach-Tags sein (wie in RFC 5646 festgelegt). Standardmäßig ["en"].

expectedContextLanguages

Ein Array von Zeichenfolgen, das die erwarteten Sprachen der bereitgestellten Kontextstrings angibt (entweder des sharedContext, der dem Summarizer übergeben wird, oder eines context, das während eines summarize()- oder summarizeStreaming()-Aufrufs angegeben wird), die gültige BCP 47 Sprach-Tags sein sollten. Standardmäßig ["en"].

format

Ein enumerierter Wert, der das Text-format angibt, in dem Zusammenfassungen zurückgegeben werden sollen. Standardmäßig markdown.

length

Ein enumerierter Wert, der die relative length für die generierten Zusammenfassungen angibt. Standardmäßig short.

monitor

Eine Rückruffunktion mit einem CreateMonitor-Argument, das das Monitoring des Download-Fortschritts des KI-Modells ermöglicht.

outputLanguage

Eine Zeichenfolge, die die erwartete Sprache der vom Summarizer erzeugten Zusammenfassungen angibt und ein gültiger BCP 47 Sprach-Tag sein sollte. Standardmäßig en.

sharedContext

Ein sharedContext Zeichenfolgen, das den Kontext beschreibt, in dem die zu zusammenfassenden Textstücke verwendet werden, was dem Summarizer hilft, geeignetere Zusammenfassungen zu erzeugen.

signal

Eine AbortSignal-Objektinstanz, die es ermöglicht, den create()-Vorgang über den zugehörigen AbortController abzubrechen.

type

Ein enumerierter Wert, der den type der Zusammenfassung angibt, die dieser Summarizer generieren soll. Standardmäßig key-points.

Rückgabewert

Ein Promise, das mit einer Summarizer-Objektinstanz erfüllt wird.

Ausnahmen

NotAllowedError DOMException

Wird ausgelöst, wenn die Verwendung der Summarizer-API durch eine summarizer Permissions-Policy blockiert ist.

NotSupportedError DOMException

Wird ausgelöst, wenn einer der Sprach-Tags in expectedContextLanguages, expectedInputLanguages oder outputLanguage ungültig oder nicht unterstützt ist.

OperationError DOMException

Allgemeine Ausnahme, die ausgelöst wird, wenn die Erstellung des Summarizer aus einem anderen Grund fehlschlägt.

Beispiele

Grundlegende Erstellung eines Summarizer

js
const summarizer = await Summarizer.create({
  sharedContext:
    "A general summary to help a user decide if the text is worth reading",
  type: "tldr",
  length: "short",
  format: "markdown",
  expectedInputLanguages: ["en-US"],
  outputLanguage: "en-US",
});

Spezifikationen

Specification
Writing Assistance APIs
# dom-summarizer-create

Browser-Kompatibilität

Siehe auch