Summarizer: summarize() 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 summarize() Methode der Summarizer Schnittstelle erzeugt eine neue Zusammenfassungszeichenkette.

Syntax

js
summarize(input)
summarize(input, options)

Parameter

input

Eine Zeichenfolge, die den zu zusammenfassenden Text darstellt.

options Optional

Ein Objekt, das Konfigurationsoptionen für die summarize() Operation spezifiziert. Mögliche Werte umfassen:

context

Eine Zeichenfolge, die den Kontext beschreibt, in dem der Eingabetext verwendet wird, um dem Summarizer zu helfen, eine geeignetere Zusammenfassung zu erstellen.

signal

Eine AbortSignal Objektinstanz, die es ermöglicht, die summarize() Operation über den zugehörigen AbortController abzubrechen.

Rückgabewert

Ein Promise, das mit einer Zeichenkette erfüllt wird, die die erzeugte Zusammenfassung enthält.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn das aktuelle Document nicht aktiv ist.

NotAllowedError DOMException

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

NotReadableError DOMException

Wird ausgelöst, wenn die Ausgabesummary vom Benutzeragent gefiltert wurde, beispielsweise weil sie als schädlich, ungenau oder unsinnig erkannt wurde.

NotSupportedError DOMException

Wird ausgelöst, wenn der bereitgestellte context nicht in einer Sprache vorliegt, die der Summarizer unterstützt.

QuotaExceededError DOMException

Wird ausgelöst, wenn die Zusammenfassungsoperation das verfügbare inputQuota überschreitet.

UnknownError DOMException

Wird ausgelöst, wenn der summarize() Aufruf aus irgendeinem anderen Grund fehlschlug oder einen Grund, den der Benutzeragent nicht offenlegen wollte.

Beispiele

Grundlegende Verwendung von summarize()

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",
});

const summary = await summarizer.summarize(myTextString);
console.log(summary);

Spezifikationen

Specification
Writing Assistance APIs
# dom-summarizer-summarize

Browser-Kompatibilität

Siehe auch