Summarizer: create() statische Methode

Limited availability

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

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.

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

Hinweis: Die create()-Methode erfordert eine 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 Eingabetextes angibt, die gültige BCP 47 Sprach-Tags (wie in RFC 5646 spezifiziert) sein sollten. Standardmäßig ["en"].

expectedContextLanguages

Ein Array von Zeichenfolgen, das die erwarteten Sprachen aller bereitgestellten Kontextzeichenfolgen angibt (entweder der sharedContext, der dem Summarizer übergeben wird, oder ein 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 Textformat angibt, in dem Sie die Zusammenfassungen erhalten möchten. Standardmäßig markdown.

length

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

monitor

Eine Callback-Funktion mit einem CreateMonitor-Argument, die die Überwachung des Downloadfortschritts des KI-Modells ermöglicht.

outputLanguage

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

sharedContext

Eine sharedContext-Zeichenfolge, die den Kontext beschreibt, in dem die zusammenzufassenden Textstücke verwendet werden, was dem Summarizer hilft, besser geeignete Zusammenfassungen zu erzeugen.

signal

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

type

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

Rückgabewert

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

Ausnahmen

NotAllowedError DOMException

Wird geworfen, wenn die Nutzung der Summarizer-API durch eine summarizer Permissions-Policy blockiert wird.

NotSupportedError DOMException

Wird geworfen, wenn eines der in expectedContextLanguages, expectedInputLanguages oder outputLanguage angegebenen Sprach-Tags ungültig oder nicht unterstützt ist.

OperationError DOMException

Allgemeine Ausnahme, die geworfen wird, wenn die Erstellung des Summarizer aus einem anderen Grund fehlgeschlagen ist.

Beispiele

Grundlegende Summarizer-Erstellung

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