Summarizer: summarizeStreaming() Methode

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 generiert eine neue Zusammenfassung als ReadableStream.

Syntax

js
summarizeStreaming(input)
summarizeStreaming(input, options)

Parameter

input

Ein String, der den zu zusammenfassenden Text repräsentiert.

options Optional

Ein Objekt, das Konfigurationsoptionen für die summarizeStreaming()-Operation angibt. 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 des AbortSignal Objekts, das es ermöglicht, die summarizeStreaming()-Operation über den zugehörigen AbortController abzubrechen.

Rückgabewert

Ein ReadableStream, der die generierte 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 wird.

NotReadableError DOMException

Wird ausgelöst, wenn die Ausgabe-Zusammenfassung vom User-Agent gefiltert wurde, beispielsweise weil sie als schädlich, ungenau oder unsinnig erkannt wurde.

NotSupportedError DOMException

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

QuotaExceededError DOMException

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

UnknownError DOMException

Wird ausgelöst, wenn der summarizeStreaming()-Aufruf aus einem anderen oder vom User-Agent nicht offengelegten Grund fehlschlug.

Beispiele

Grundlegende Verwendung von summarizeStreaming()

js
const summarizer = await Summarizer.create({
  sharedContext:
    "A general summary to help a user decide if the text is worth reading",
  type: "tl;dr",
  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