Summarizer: summarizeStreaming() 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.

Die summarizeStreaming() Methode der Summarizer Schnittstelle erzeugt eine neue Zusammenfassung als ReadableStream.

Syntax

js
summarizeStreaming(input)
summarizeStreaming(input, options)

Parameter

input

Ein String, der den zu zusammenfassenden Text darstellt.

options Optional

Ein Objekt, das Konfigurationsoptionen für den summarizeStreaming() Vorgang spezifiziert. Mögliche Werte sind:

context

Ein String, der den Kontext beschreibt, in dem der Eingabetext verwendet wird, was dem Summarizer hilft, eine passendere Zusammenfassung zu erstellen.

signal

Eine Instanz eines AbortSignal Objekts, das es ermöglicht, den summarizeStreaming() Vorgang über den zugehörigen AbortController abzubrechen.

Rückgabewert

Ein ReadableStream, der 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 Nutzung der Summarizer API durch eine summarizer Permissions-Policy blockiert ist.

NotReadableError DOMException

Wird ausgelöst, wenn die Ausgangszusammenfassung vom Benutzeragent herausgefiltert wurde, zum Beispiel, weil sie als schädlich, ungenau oder unsinnig erkannt wurde.

NotSupportedError DOMException

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

QuotaExceededError DOMException

Wird ausgelöst, wenn der Zusammenfassungsvorgang das verfügbare inputQuota überschreitet.

UnknownError DOMException

Wird ausgelöst, wenn der summarizeStreaming() Aufruf aus einem anderen Grund fehlschlug oder einen Grund, den der Benutzeragent nicht preisgeben wollte.

Beispiele

Grundlegende Nutzung von summarizeStreaming()

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 stream = summarizer.summarizeStreaming(myTextString);
let summary = "";

for await (const chunk of stream) {
  summary += chunk;
}

console.log("Stream complete");
summaryOutput.textContent = summary;

Spezifikationen

Specification
Writing Assistance APIs
# dom-summarizer-summarizestreaming

Browser-Kompatibilität

Siehe auch